RTP Series API Programming Reference  1.2.1
Marker Functions

Functions

EXPORT int PwrSnsr_GetMarkerTimePosition (SessionID Vi, int MarkerNumber, float *TimePosition)
 Get the time (x-axis-position) of the selected marker relative to the trigger. More...
 
EXPORT int PwrSnsr_SetMarkerTimePosition (SessionID Vi, int MarkerNumber, float TimePosition)
 Set the time (x-axis-position) of the selected marker relative to the trigger. More...
 
EXPORT int PwrSnsr_GetMarkerPixelPosition (SessionID Vi, int MarkerNumber, int *PixelPosition)
 Get the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive. More...
 
EXPORT int PwrSnsr_SetMarkerPixelPosition (SessionID Vi, int MarkerNumber, int PixelPosition)
 Set the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive. More...
 
EXPORT int PwrSnsr_FetchArrayMarkerPower (SessionID Vi, const char *Channel, float *AvgPower, PwrSnsrCondCodeEnum *AvgPowerCondCode, float *MaxPower, PwrSnsrCondCodeEnum *MaxPowerCondCode, float *MinPower, PwrSnsrCondCodeEnum *MinPowerCondCode, float *PkToAvgRatio, PwrSnsrCondCodeEnum *PkToAvgRatioCondCode, float *Marker1Power, PwrSnsrCondCodeEnum *Marker1PowerCondCode, float *Marker2Power, PwrSnsrCondCodeEnum *Marker2PowerCondCode, float *MarkerRatio, PwrSnsrCondCodeEnum *MarkerRatioCondCode)
 Returns an array of the current marker measurements for the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerAverage (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerMax (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerMin (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadArrayMarkerPower (SessionID Vi, const char *Channel, float *AvgPower, PwrSnsrCondCodeEnum *AvgPowerCondCode, float *MaxPower, PwrSnsrCondCodeEnum *MaxPowerCondCode, float *MinPower, PwrSnsrCondCodeEnum *MinPowerCondCode, float *PkToAvgRatio, PwrSnsrCondCodeEnum *PkToAvgRatioCondCode, float *Marker1Power, PwrSnsrCondCodeEnum *Marker1PowerCondCode, float *Marker2Power, PwrSnsrCondCodeEnum *Marker2PowerCondCode, float *MarkerRatio, PwrSnsrCondCodeEnum *MarkerRatioCondCode)
 Returns an array of the current marker measurements for the specified channel. More...
 
EXPORT int PwrSnsr_ReadMarkerAverage (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadMarkerMax (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadMarkerMin (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalFilteredMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalFilteredMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalPkToAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units. More...
 
EXPORT int PwrSnsr_ReadIntervalAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalFilteredMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalFilteredMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalPkToAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units. More...
 
EXPORT int PwrSnsr_FetchIntervalMaxAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalMinAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMaxAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMinAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the difference between MK1 and MK2. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_FetchMarkerRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units. More...
 
EXPORT int PwrSnsr_FetchMarkerRDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the difference between MK2 and MK1. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_FetchMarkerRRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units. More...
 
EXPORT int PwrSnsr_ReadMarkerDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the difference between MK1 and MK2. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_ReadMarkerRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units. More...
 
EXPORT int PwrSnsr_ReadMarkerRDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the difference between MK2 and MK1. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_ReadMarkerRRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units. More...
 

Detailed Description

Marker functions

Function Documentation

◆ PwrSnsr_FetchArrayMarkerPower()

EXPORT int PwrSnsr_FetchArrayMarkerPower ( SessionID  Vi,
const char *  Channel,
float *  AvgPower,
PwrSnsrCondCodeEnum AvgPowerCondCode,
float *  MaxPower,
PwrSnsrCondCodeEnum MaxPowerCondCode,
float *  MinPower,
PwrSnsrCondCodeEnum MinPowerCondCode,
float *  PkToAvgRatio,
PwrSnsrCondCodeEnum PkToAvgRatioCondCode,
float *  Marker1Power,
PwrSnsrCondCodeEnum Marker1PowerCondCode,
float *  Marker2Power,
PwrSnsrCondCodeEnum Marker2PowerCondCode,
float *  MarkerRatio,
PwrSnsrCondCodeEnum MarkerRatioCondCode 
)

Returns an array of the current marker measurements for the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
AvgPowerAverage power between the markers.
AvgPowerCondCodeCondition code.
MaxPowerMaximum power between the markers.
MaxPowerCondCodeCondition code.
MinPowerMinimum power between the markers.
MinPowerCondCodeCondition code.
PkToAvgRatioThe ratio of peak to average power between the markers.
PkToAvgRatioCondCodeCondition code.
Marker1PowerThe power at Marker 1.
Marker1PowerCondCodeCondition code.
Marker2PowerThe power at Marker 2.
Marker2PowerCondCodeCondition code.
MarkerRatioRatio of power at Marker 1 and power at Marker 2.
MarkerRatioCondCodeCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalAvg()

EXPORT int PwrSnsr_FetchIntervalAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalFilteredMax()

EXPORT int PwrSnsr_FetchIntervalFilteredMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalFilteredMin()

EXPORT int PwrSnsr_FetchIntervalFilteredMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMax()

EXPORT int PwrSnsr_FetchIntervalMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMaxAvg()

EXPORT int PwrSnsr_FetchIntervalMaxAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMin()

EXPORT int PwrSnsr_FetchIntervalMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMinAvg()

EXPORT int PwrSnsr_FetchIntervalMinAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalPkToAvg()

EXPORT int PwrSnsr_FetchIntervalPkToAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerAverage()

EXPORT int PwrSnsr_FetchMarkerAverage ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MarkerMarker number.
IsValidCondition code.
ValMeasurement value
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerDelta()

EXPORT int PwrSnsr_FetchMarkerDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the difference between MK1 and MK2. The units will be the same as marker units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerMax()

EXPORT int PwrSnsr_FetchMarkerMax ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MarkerMarker number.
IsValid
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerMin()

EXPORT int PwrSnsr_FetchMarkerMin ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MarkerMarker number.
IsValid
Valmeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerRatio()

EXPORT int PwrSnsr_FetchMarkerRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerRDelta()

EXPORT int PwrSnsr_FetchMarkerRDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the difference between MK2 and MK1. The units will be the same as marker units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerRRatio()

EXPORT int PwrSnsr_FetchMarkerRRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_GetMarkerPixelPosition()

EXPORT int PwrSnsr_GetMarkerPixelPosition ( SessionID  Vi,
int  MarkerNumber,
int *  PixelPosition 
)

Get the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MarkerNumber
PixelPosition
Returns
Success (0) or error code.

◆ PwrSnsr_GetMarkerTimePosition()

EXPORT int PwrSnsr_GetMarkerTimePosition ( SessionID  Vi,
int  MarkerNumber,
float *  TimePosition 
)

Get the time (x-axis-position) of the selected marker relative to the trigger.

Note that time markers must be positioned within the time limits of the trace window in the graph display. If a time outside of the display limits is entered, the marker will be placed at the first or last time position as appropriate.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MarkerNumber
TimePosition
Returns
Success (0) or error code.

◆ PwrSnsr_ReadArrayMarkerPower()

EXPORT int PwrSnsr_ReadArrayMarkerPower ( SessionID  Vi,
const char *  Channel,
float *  AvgPower,
PwrSnsrCondCodeEnum AvgPowerCondCode,
float *  MaxPower,
PwrSnsrCondCodeEnum MaxPowerCondCode,
float *  MinPower,
PwrSnsrCondCodeEnum MinPowerCondCode,
float *  PkToAvgRatio,
PwrSnsrCondCodeEnum PkToAvgRatioCondCode,
float *  Marker1Power,
PwrSnsrCondCodeEnum Marker1PowerCondCode,
float *  Marker2Power,
PwrSnsrCondCodeEnum Marker2PowerCondCode,
float *  MarkerRatio,
PwrSnsrCondCodeEnum MarkerRatioCondCode 
)

Returns an array of the current marker measurements for the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
AvgPowerAverage power between the markers.
AvgPowerCondCodeCondition code.
MaxPowerMaximum power between the markers.
MaxPowerCondCodeCondition code.
MinPowerMinimum power between the markers.
MinPowerCondCodeCondition code.
PkToAvgRatioThe ratio of peak to average power between the markers.
PkToAvgRatioCondCodeCondition code.
Marker1PowerThe power at Marker 1.
Marker1PowerCondCodeCondition code.
Marker2PowerThe power at Marker 2.
Marker2PowerCondCodeCondition code.
MarkerRatioRatio of power at Marker 1 and power at Marker 2.
MarkerRatioCondCodeCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalAvg()

EXPORT int PwrSnsr_ReadIntervalAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalFilteredMax()

EXPORT int PwrSnsr_ReadIntervalFilteredMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalFilteredMin()

EXPORT int PwrSnsr_ReadIntervalFilteredMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMax()

EXPORT int PwrSnsr_ReadIntervalMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMaxAvg()

EXPORT int PwrSnsr_ReadIntervalMaxAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMin()

EXPORT int PwrSnsr_ReadIntervalMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMinAvg()

EXPORT int PwrSnsr_ReadIntervalMinAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalPkToAvg()

EXPORT int PwrSnsr_ReadIntervalPkToAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerAverage()

EXPORT int PwrSnsr_ReadMarkerAverage ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MarkerMarker number.
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerDelta()

EXPORT int PwrSnsr_ReadMarkerDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the difference between MK1 and MK2. The units will be the same as marker units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerMax()

EXPORT int PwrSnsr_ReadMarkerMax ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MarkerMarker number.
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerMin()

EXPORT int PwrSnsr_ReadMarkerMin ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MarkerMarker number.
CondCodeCondition code for the measurement. Condition code.
Valmeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerRatio()

EXPORT int PwrSnsr_ReadMarkerRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerRDelta()

EXPORT int PwrSnsr_ReadMarkerRDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the difference between MK2 and MK1. The units will be the same as marker units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerRRatio()

EXPORT int PwrSnsr_ReadMarkerRRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_SetMarkerPixelPosition()

EXPORT int PwrSnsr_SetMarkerPixelPosition ( SessionID  Vi,
int  MarkerNumber,
int  PixelPosition 
)

Set the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MarkerNumber
PixelPosition
Returns
Success (0) or error code.

◆ PwrSnsr_SetMarkerTimePosition()

EXPORT int PwrSnsr_SetMarkerTimePosition ( SessionID  Vi,
int  MarkerNumber,
float  TimePosition 
)

Set the time (x-axis-position) of the selected marker relative to the trigger.

Note that time markers must be positioned within the time limits of the trace window in the graph display. If a time outside of the display limits is entered, the marker will be placed at the first or last time position as appropriate.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MarkerNumber
TimePosition
Returns
Success (0) or error code.