RTP Series API Programming Reference
1.2.1
|
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... | |
Statmode functions
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.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
Power | Relative power in dB |
CondCode | Condition code for the measurement. |
Val | Percent measurement at power. |
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.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
Percent | Statistical percent to retrieve power from. |
CondCode | Condition code for the measurement. |
Val | relative power at percent. |
EXPORT int PwrSnsr_FetchCCDFTrace | ( | SessionID | Vi, |
const char * | Channel, | ||
int | TraceBufferSize, | ||
float | Trace[], | ||
int * | TraceActualSize | ||
) |
Returns the points in the CCDF trace.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TraceBufferSize | |
Trace | |
TraceActualSize |
EXPORT int PwrSnsr_FetchCursorPercent | ( | SessionID | Vi, |
const char * | Channel, | ||
PwrSnsrCondCodeEnum * | CondCode, | ||
double * | Val | ||
) |
Returns the percent CCDF at the cursor.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
CondCode | Condition code for the measurement. |
Val |
EXPORT int PwrSnsr_FetchCursorPower | ( | SessionID | Vi, |
const char * | Channel, | ||
PwrSnsrCondCodeEnum * | CondCode, | ||
double * | Val | ||
) |
Returns the power CCDF in dB at the cursor.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
CondCode | Condition code for the measurement. |
Val |
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.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
Pavg | Long term average power in channel units. |
PavgCond | Condition code. |
Ppeak | Peak power in channel units. |
PpeakCond | Condition code. |
Pmin | Minimum power in channel units. |
PminCond | Condition code. |
PkToAvgRatio | Peak-to-average power in percent or dB. |
PkToAvgRatioCond | Condition code. |
CursorPwr | Power at the cursor in channel units. |
CursorPwrCond | Condition code. |
CursorPct | Statistical percent at the cursor. |
CursorPctCond | Condition code. |
SampleCount | Population size in samples. |
SampleCountCond | Condition code. |
SecondsRun | Number of seconds the measurement has run. |
SecondsRunCond | Condition code. |
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.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
SweepLength | Returns the number of points in the trace. |
SampleRate | Returns the sample rate. |
SweepRate | Returns the number of triggered sweeps per second. |
SweepTime | Returns the sweep time for the trace. |
StartTime | Returns the start time relative to the trigger. |
StatusWord | Internal use - acquisition system status word. |
Get whether statistical capture is enabled.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
Capture |
Get the number of points in the CCDF trace plot.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TraceCount |
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.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
DetectorTemp | Temperature in degrees C at the RF detector. |
CpuTemp | Temperature of the CPU in degrees C. |
MioVoltage | Voltage at the Multi I/O port. |
VccInt10 | Vcc 10 voltage. |
VccAux18 | Vcc Aux 18 voltage. |
Vcc50 | Vcc 50 voltage. |
Vcc25 | Vcc 25 voltage. |
Vcc33 | Vcc 33 voltage. |
EXPORT int PwrSnsr_GetGating | ( | SessionID | Vi, |
const char * | Channel, | ||
PwrSnsrStatGatingEnum * | Gating | ||
) |
Get whether statistical capture is enabled.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". whether the statical capture is gated by markers or free-running. |
Gating |
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).
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
HorizontalOffset |
EXPORT int PwrSnsr_GetHorizontalScale | ( | SessionID | Vi, |
const char * | Channel, | ||
double * | HorizontalScale | ||
) |
Get the statistical mode horizontal scale in dB/Div.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
HorizontalScale |
EXPORT int PwrSnsr_GetPercentPosition | ( | SessionID | Vi, |
const char * | Channel, | ||
double * | PercentPosition | ||
) |
Get the cursor percent on the CCDF plot.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". Channel Channel number. For single instruments, set this to 1. |
PercentPosition |
Get the cursor power in dB on the CCDF plot.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
PowerPosition |
EXPORT int PwrSnsr_GetTermAction | ( | SessionID | Vi, |
const char * | Channel, | ||
PwrSnsrTermActionEnum * | TermAction | ||
) |
Get the termination action for statistical capturing.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TermAction |
Get the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TermCount |
Get the termination time in seconds for statistical capturing. After the time has elapsed, the action determined by TermAction is taken.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TermTime |
Set whether statistical capture is enabled.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
Capture |
Set the number of points (1 - 16384) in the CCDF trace plot.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TraceCount |
EXPORT int PwrSnsr_SetGating | ( | SessionID | Vi, |
const char * | Channel, | ||
PwrSnsrStatGatingEnum | Gating | ||
) |
Set whether the statical capture is gated by markers or free-running.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
Gating |
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).
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
HorizontalOffset |
EXPORT int PwrSnsr_SetHorizontalScale | ( | SessionID | Vi, |
const char * | Channel, | ||
double | HorizontalScale | ||
) |
Set the statistical mode horizontal scale in dB/Div.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
HorizontalScale |
EXPORT int PwrSnsr_SetPercentPosition | ( | SessionID | Vi, |
const char * | Channel, | ||
double | PercentPosition | ||
) |
Set the cursor percent on the CCDF plot.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
PercentPosition |
Set the cursor power in dB on the CCDF plot.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
PowerPosition |
EXPORT int PwrSnsr_SetTermAction | ( | SessionID | Vi, |
const char * | Channel, | ||
PwrSnsrTermActionEnum | TermAction | ||
) |
Set the termination action for statistical capturing.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TermAction |
Set the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TermCount |
Set the termination time in seconds (1 - 3600) for statistical capturing. After the time has elapsed, the action determined by TermAction is taken.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |
TermTime |
Resets statistical capturing mode by clearing the buffers and restarting the aquisition timer.
Vi | The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session. |
Channel | Channel number. For single instruments, set this to "CH1". |