RTP Series API Programming Reference  1.2.1
Statistical Mode

Functions

EXPORT int PwrSnsr_GetHorizontalOffset (SessionID Vi, const char *Channel, double *HorizontalOffset)
 Get the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative). More...
 
EXPORT int PwrSnsr_SetHorizontalOffset (SessionID Vi, const char *Channel, double HorizontalOffset)
 Set the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative). More...
 
EXPORT int PwrSnsr_GetHorizontalScale (SessionID Vi, const char *Channel, double *HorizontalScale)
 Get the statistical mode horizontal scale in dB/Div. More...
 
EXPORT int PwrSnsr_SetHorizontalScale (SessionID Vi, const char *Channel, double HorizontalScale)
 Set the statistical mode horizontal scale in dB/Div. More...
 
EXPORT int PwrSnsr_FetchCCDFTrace (SessionID Vi, const char *Channel, int TraceBufferSize, float Trace[], int *TraceActualSize)
 Returns the points in the CCDF trace. More...
 
EXPORT int PwrSnsr_StatModeReset (SessionID Vi, const char *Channel)
 Resets statistical capturing mode by clearing the buffers and restarting the aquisition timer. More...
 
EXPORT int PwrSnsr_FetchStatMeasurementArray (SessionID Vi, const char *Channel, double *Pavg, PwrSnsrCondCodeEnum *PavgCond, double *Ppeak, PwrSnsrCondCodeEnum *PpeakCond, double *Pmin, PwrSnsrCondCodeEnum *PminCond, double *PkToAvgRatio, PwrSnsrCondCodeEnum *PkToAvgRatioCond, double *CursorPwr, PwrSnsrCondCodeEnum *CursorPwrCond, double *CursorPct, PwrSnsrCondCodeEnum *CursorPctCond, double *SampleCount, PwrSnsrCondCodeEnum *SampleCountCond, double *SecondsRun, PwrSnsrCondCodeEnum *SecondsRunCond)
 Returns an array of the current automatic statistical measurements performed on a sample population. More...
 
EXPORT int PwrSnsr_FetchCCDFPower (SessionID Vi, const char *Channel, double Percent, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Return relative power (in dB) for a given percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_FetchCCDFPercent (SessionID Vi, const char *Channel, double Power, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Return relative power (in dB) for a given percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_GetCapture (SessionID Vi, const char *Channel, int *Capture)
 Get whether statistical capture is enabled. More...
 
EXPORT int PwrSnsr_SetCapture (SessionID Vi, const char *Channel, int Capture)
 Set whether statistical capture is enabled. More...
 
EXPORT int PwrSnsr_GetGating (SessionID Vi, const char *Channel, PwrSnsrStatGatingEnum *Gating)
 Get whether statistical capture is enabled. More...
 
EXPORT int PwrSnsr_SetGating (SessionID Vi, const char *Channel, PwrSnsrStatGatingEnum Gating)
 Set whether the statical capture is gated by markers or free-running. More...
 
EXPORT int PwrSnsr_GetTermAction (SessionID Vi, const char *Channel, PwrSnsrTermActionEnum *TermAction)
 Get the termination action for statistical capturing. More...
 
EXPORT int PwrSnsr_SetTermAction (SessionID Vi, const char *Channel, PwrSnsrTermActionEnum TermAction)
 Set the termination action for statistical capturing. More...
 
EXPORT int PwrSnsr_GetTermCount (SessionID Vi, const char *Channel, double *TermCount)
 Get the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_SetTermCount (SessionID Vi, const char *Channel, double TermCount)
 Set the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_GetTermTime (SessionID Vi, const char *Channel, int *TermTime)
 Get the termination time in seconds for statistical capturing. After the time has elapsed, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_SetTermTime (SessionID Vi, const char *Channel, int TermTime)
 Set the termination time in seconds (1 - 3600) for statistical capturing. After the time has elapsed, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_GetCCDFTraceCount (SessionID Vi, const char *Channel, int *TraceCount)
 Get the number of points in the CCDF trace plot. More...
 
EXPORT int PwrSnsr_SetCCDFTraceCount (SessionID Vi, const char *Channel, int TraceCount)
 Set the number of points (1 - 16384) in the CCDF trace plot. More...
 
EXPORT int PwrSnsr_FetchCursorPercent (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Returns the percent CCDF at the cursor. More...
 
EXPORT int PwrSnsr_FetchCursorPower (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Returns the power CCDF in dB at the cursor. More...
 
EXPORT int PwrSnsr_GetPercentPosition (SessionID Vi, const char *Channel, double *PercentPosition)
 Get the cursor percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_SetPercentPosition (SessionID Vi, const char *Channel, double PercentPosition)
 Set the cursor percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_SetPowerPosition (SessionID Vi, const char *Channel, double PowerPosition)
 Set the cursor power in dB on the CCDF plot. More...
 
EXPORT int PwrSnsr_GetPowerPosition (SessionID Vi, const char *Channel, double *PowerPosition)
 Get the cursor power in dB on the CCDF plot. More...
 
EXPORT int PwrSnsr_GetAcqStatusArray (SessionID Vi, const char *Channel, int *SweepLength, double *SampleRate, double *SweepRate, double *SweepTime, double *StartTime, int *StatusWord)
 Returns data about the status of the acquisition system. More...
 
EXPORT int PwrSnsr_GetDiagStatusArray (SessionID Vi, const char *Channel, float *DetectorTemp, float *CpuTemp, float *MioVoltage, float *VccInt10, float *VccAux18, float *Vcc50, float *Vcc25, float *Vcc33)
 Returns diagnostic data. More...
 

Detailed Description

Statmode functions

Function Documentation

◆ PwrSnsr_FetchCCDFPercent()

EXPORT int PwrSnsr_FetchCCDFPercent ( SessionID  Vi,
const char *  Channel,
double  Power,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Return relative power (in dB) for a given percent on the CCDF plot.

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".
PowerRelative power in dB
CondCodeCondition code for the measurement.
ValPercent measurement at power.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCCDFPower()

EXPORT int PwrSnsr_FetchCCDFPower ( SessionID  Vi,
const char *  Channel,
double  Percent,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Return relative power (in dB) for a given percent on the CCDF plot.

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".
PercentStatistical percent to retrieve power from.
CondCodeCondition code for the measurement.
Valrelative power at percent.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCCDFTrace()

EXPORT int PwrSnsr_FetchCCDFTrace ( SessionID  Vi,
const char *  Channel,
int  TraceBufferSize,
float  Trace[],
int *  TraceActualSize 
)

Returns the points in the CCDF trace.

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".
TraceBufferSize
Trace
TraceActualSize
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCursorPercent()

EXPORT int PwrSnsr_FetchCursorPercent ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Returns the percent CCDF at the cursor.

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.
Val
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCursorPower()

EXPORT int PwrSnsr_FetchCursorPower ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Returns the power CCDF in dB at the cursor.

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.
Val
Returns
Success (0) or error code.

◆ PwrSnsr_FetchStatMeasurementArray()

EXPORT int PwrSnsr_FetchStatMeasurementArray ( SessionID  Vi,
const char *  Channel,
double *  Pavg,
PwrSnsrCondCodeEnum PavgCond,
double *  Ppeak,
PwrSnsrCondCodeEnum PpeakCond,
double *  Pmin,
PwrSnsrCondCodeEnum PminCond,
double *  PkToAvgRatio,
PwrSnsrCondCodeEnum PkToAvgRatioCond,
double *  CursorPwr,
PwrSnsrCondCodeEnum CursorPwrCond,
double *  CursorPct,
PwrSnsrCondCodeEnum CursorPctCond,
double *  SampleCount,
PwrSnsrCondCodeEnum SampleCountCond,
double *  SecondsRun,
PwrSnsrCondCodeEnum SecondsRunCond 
)

Returns an array of the current automatic statistical measurements performed on a sample population.

Measurements performed are: long term average, peak and minimum amplitude, peak-to-average ratio, amplitude at the CCDF percent cursor, statistical percent at the CCDF power cursor, and the sample population size in samples. Note the peak-to-average ratio is returned in dB for logarithmic channel units, and percent for all other 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".
PavgLong term average power in channel units.
PavgCondCondition code.
PpeakPeak power in channel units.
PpeakCondCondition code.
PminMinimum power in channel units.
PminCondCondition code.
PkToAvgRatioPeak-to-average power in percent or dB.
PkToAvgRatioCondCondition code.
CursorPwrPower at the cursor in channel units.
CursorPwrCondCondition code.
CursorPctStatistical percent at the cursor.
CursorPctCondCondition code.
SampleCountPopulation size in samples.
SampleCountCondCondition code.
SecondsRunNumber of seconds the measurement has run.
SecondsRunCondCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_GetAcqStatusArray()

EXPORT int PwrSnsr_GetAcqStatusArray ( SessionID  Vi,
const char *  Channel,
int *  SweepLength,
double *  SampleRate,
double *  SweepRate,
double *  SweepTime,
double *  StartTime,
int *  StatusWord 
)

Returns data about the status of the acquisition system.

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".
SweepLengthReturns the number of points in the trace.
SampleRateReturns the sample rate.
SweepRateReturns the number of triggered sweeps per second.
SweepTimeReturns the sweep time for the trace.
StartTimeReturns the start time relative to the trigger.
StatusWordInternal use - acquisition system status word.
Returns
Success (0) or error code.

◆ PwrSnsr_GetCapture()

EXPORT int PwrSnsr_GetCapture ( SessionID  Vi,
const char *  Channel,
int *  Capture 
)

Get whether statistical capture is enabled.

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".
Capture
Returns
Success (0) or error code.

◆ PwrSnsr_GetCCDFTraceCount()

EXPORT int PwrSnsr_GetCCDFTraceCount ( SessionID  Vi,
const char *  Channel,
int *  TraceCount 
)

Get the number of points in the CCDF trace plot.

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".
TraceCount
Returns
Success (0) or error code.

◆ PwrSnsr_GetDiagStatusArray()

EXPORT int PwrSnsr_GetDiagStatusArray ( SessionID  Vi,
const char *  Channel,
float *  DetectorTemp,
float *  CpuTemp,
float *  MioVoltage,
float *  VccInt10,
float *  VccAux18,
float *  Vcc50,
float *  Vcc25,
float *  Vcc33 
)

Returns diagnostic data.

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".
DetectorTempTemperature in degrees C at the RF detector.
CpuTempTemperature of the CPU in degrees C.
MioVoltageVoltage at the Multi I/O port.
VccInt10Vcc 10 voltage.
VccAux18Vcc Aux 18 voltage.
Vcc50Vcc 50 voltage.
Vcc25Vcc 25 voltage.
Vcc33Vcc 33 voltage.
Returns
Success (0) or error code.

◆ PwrSnsr_GetGating()

EXPORT int PwrSnsr_GetGating ( SessionID  Vi,
const char *  Channel,
PwrSnsrStatGatingEnum Gating 
)

Get whether statistical capture is enabled.

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". whether the statical capture is gated by markers or free-running.
Gating
Returns
Success (0) or error code.

◆ PwrSnsr_GetHorizontalOffset()

EXPORT int PwrSnsr_GetHorizontalOffset ( SessionID  Vi,
const char *  Channel,
double *  HorizontalOffset 
)

Get the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative).

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".
HorizontalOffset
Returns
Success (0) or error code.

◆ PwrSnsr_GetHorizontalScale()

EXPORT int PwrSnsr_GetHorizontalScale ( SessionID  Vi,
const char *  Channel,
double *  HorizontalScale 
)

Get the statistical mode horizontal scale in dB/Div.

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".
HorizontalScale
Returns
Success (0) or error code.

◆ PwrSnsr_GetPercentPosition()

EXPORT int PwrSnsr_GetPercentPosition ( SessionID  Vi,
const char *  Channel,
double *  PercentPosition 
)

Get the cursor percent on the CCDF plot.

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". Channel Channel number. For single instruments, set this to 1.
PercentPosition
Returns
Success (0) or error code.

◆ PwrSnsr_GetPowerPosition()

EXPORT int PwrSnsr_GetPowerPosition ( SessionID  Vi,
const char *  Channel,
double *  PowerPosition 
)

Get the cursor power in dB on the CCDF plot.

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".
PowerPosition
Returns
Success (0) or error code.

◆ PwrSnsr_GetTermAction()

EXPORT int PwrSnsr_GetTermAction ( SessionID  Vi,
const char *  Channel,
PwrSnsrTermActionEnum TermAction 
)

Get the termination action for statistical capturing.

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".
TermAction
Returns
Success (0) or error code.

◆ PwrSnsr_GetTermCount()

EXPORT int PwrSnsr_GetTermCount ( SessionID  Vi,
const char *  Channel,
double *  TermCount 
)

Get the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken.

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".
TermCount
Returns
Success (0) or error code.

◆ PwrSnsr_GetTermTime()

EXPORT int PwrSnsr_GetTermTime ( SessionID  Vi,
const char *  Channel,
int *  TermTime 
)

Get the termination time in seconds for statistical capturing. After the time has elapsed, the action determined by TermAction is taken.

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".
TermTime
Returns
Success (0) or error code.

◆ PwrSnsr_SetCapture()

EXPORT int PwrSnsr_SetCapture ( SessionID  Vi,
const char *  Channel,
int  Capture 
)

Set whether statistical capture is enabled.

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".
Capture
Returns
Success (0) or error code.

◆ PwrSnsr_SetCCDFTraceCount()

EXPORT int PwrSnsr_SetCCDFTraceCount ( SessionID  Vi,
const char *  Channel,
int  TraceCount 
)

Set the number of points (1 - 16384) in the CCDF trace plot.

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".
TraceCount
Returns
Success (0) or error code.

◆ PwrSnsr_SetGating()

EXPORT int PwrSnsr_SetGating ( SessionID  Vi,
const char *  Channel,
PwrSnsrStatGatingEnum  Gating 
)

Set whether the statical capture is gated by markers or free-running.

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".
Gating
Returns
Success (0) or error code.

◆ PwrSnsr_SetHorizontalOffset()

EXPORT int PwrSnsr_SetHorizontalOffset ( SessionID  Vi,
const char *  Channel,
double  HorizontalOffset 
)

Set the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative).

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".
HorizontalOffset
Returns
Success (0) or error code.

◆ PwrSnsr_SetHorizontalScale()

EXPORT int PwrSnsr_SetHorizontalScale ( SessionID  Vi,
const char *  Channel,
double  HorizontalScale 
)

Set the statistical mode horizontal scale in dB/Div.

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".
HorizontalScale
Returns
Success (0) or error code.

◆ PwrSnsr_SetPercentPosition()

EXPORT int PwrSnsr_SetPercentPosition ( SessionID  Vi,
const char *  Channel,
double  PercentPosition 
)

Set the cursor percent on the CCDF plot.

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".
PercentPosition
Returns
Success (0) or error code.

◆ PwrSnsr_SetPowerPosition()

EXPORT int PwrSnsr_SetPowerPosition ( SessionID  Vi,
const char *  Channel,
double  PowerPosition 
)

Set the cursor power in dB on the CCDF plot.

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".
PowerPosition
Returns
Success (0) or error code.

◆ PwrSnsr_SetTermAction()

EXPORT int PwrSnsr_SetTermAction ( SessionID  Vi,
const char *  Channel,
PwrSnsrTermActionEnum  TermAction 
)

Set the termination action for statistical capturing.

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".
TermAction
Returns
Success (0) or error code.

◆ PwrSnsr_SetTermCount()

EXPORT int PwrSnsr_SetTermCount ( SessionID  Vi,
const char *  Channel,
double  TermCount 
)

Set the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken.

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".
TermCount
Returns
Success (0) or error code.

◆ PwrSnsr_SetTermTime()

EXPORT int PwrSnsr_SetTermTime ( SessionID  Vi,
const char *  Channel,
int  TermTime 
)

Set the termination time in seconds (1 - 3600) for statistical capturing. After the time has elapsed, the action determined by TermAction is taken.

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".
TermTime
Returns
Success (0) or error code.

◆ PwrSnsr_StatModeReset()

EXPORT int PwrSnsr_StatModeReset ( SessionID  Vi,
const char *  Channel 
)

Resets statistical capturing mode by clearing the buffers and restarting the aquisition timer.

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".
Returns
Success (0) or error code.