IviPwrMeter_ConfigureOffset
IviPwrMeterBase Capability Group
C Function Prototype
ViStatus IviPwrMeter_ConfigureOffset (ViSession vi, ViConstString channelName, ViReal64 offset);
Purpose
This function specifies the offset to be added to the measured value in units of dB.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviPwrMeter_init or IviPwrMeter_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| channelName | ViConstString | The name of the channel for which to set the Offset.
Pass the virtual channel name that you assign to the instrument in the Configuration Utility. Virtual channel names are aliases for instrument-specific channel strings. The instrument-specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument-specific channel through the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names. Default Value: "" Notes: You can specify the channel name as a string variable or as a literal enclosed in double quotes. |
| offset | ViReal64 | Specifies an offset to be added to the measured value. The units of this attribute are dB. This attribute can be used to compensate for system losses or gains between the unit under test and the sensor of the power meter. The driver sets the IVIPWRMETER_ATTR_OFFSET attribute to this value. For example, a cable loss of 2 dB could be compensated for by setting this attribute to 2. Similarly, a gain stage of 10 dB could be accounted for by setting the value of this attribute to -10. In both cases, the reading from the power meter will indicate the power at the unit under test rather than power at the power meter's sensor. Unit: dB Default Value: 0.0 dB |