IviPwrMeter_ConfigureDutyCycleCorrection
IviPwrMeterDutyCycleCorrection Capability Group
C Function Prototype
ViStatus IviPwrMeter_ConfigureDutyCycleCorrection (ViSession vi, ViConstString channelName, ViBoolean correctionEnabled, ViReal64 correctionValue);
Purpose
This function enables or disables the duty cycle correction and sets the duty cycle correction for pulse power measurements.
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 specify the duty cycle correction.
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. |
| correctionEnabled | ViBoolean | Enables or disables the duty cycle correction. The driver sets the IVIPWRMETER_ATTR_DUTY_CYCLE_CORRECTION_ENABLED attribute to this value. Valid Values: VI_TRUE - "On" VI_FALSE - "Off" Default Value: VI_FALSE - "Off" |
| correctionValue | ViReal64 | Specifies the duty cycle correction the power meter uses to calculate the pulse power of a pulse-modulated signal. The driver sets the IVIPWRMETER_ATTR_DUTY_CYCLE_CORRECTION attribute to this value. The power meter measures the average power of the pulsed input signal and then divides the result by the duty cycle correction value to obtain a pulse power reading. The value of this attribute is specified as a percentage. For a pulse with a duty cycle of 10%, this attribute should be given the value 0.1. Units: percentage ( % ). Default Value: 100 % |