Skip to content

NI RFmx SpecAn Spur Configuration Functions

Jump to bottom
Alex Starche edited this page Feb 28, 2022 · 3 revisions

Spur Configuration Functions

RFmxSpecAn_SpurCfgNumberOfRanges

int32 __stdcall RFmxSpecAn_SpurCfgNumberOfRanges (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfRanges);

Purpose

Configures the number of ranges.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
numberOfRanges int32 Specifies the number of ranges.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeFrequency

int32 __stdcall RFmxSpecAn_SpurCfgRangeFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency, float64 stopFrequency, int32 rangeEnabled);

Purpose

Configures the frequency start and stop values of the range.

Use "range<n>" as the selector string to configure this function.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name and range number. If you do not specify the signal name, the default signal instance is used.

Example:

"range0"

"signal::sig1/range0"

You can use the RFmxSpecAn_BuildRangeString2) function to build the selector string).
startFrequency float64 Specifies the start of the frequency range, in hertz (Hz), for the measurement.
stopFrequency float64 Specifies the stop of the frequency range, in hertz (Hz), for the measurement.
rangeEnabled int32 Specifies whether to measure the Spurs in the frequency range.
RFMXSPECAN_VAL_SPUR_RANGE_ENABLED_FALSE (0) Disables the acquisition of the frequency range.
RFMXSPECAN_VAL_SPUR_RANGE_ENABLED_TRUE (1) Enables measurement of Spurs in the frequency range.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeRBWFilter

int32 __stdcall RFmxSpecAn_SpurCfgRangeRBWFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RBWAuto, float64 RBW, int32 RBWFilterType);

Purpose

Configures the resolution bandwidth (RBW) filter.

Use "range<n>" as the selector string to configure this function.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name and range number. If you do not specify the signal name, the default signal instance is used.

Example:

"range0"

"signal::sig1/range0"

You can use the RFmxSpecAn_BuildRangeString2) function to build the selector string).
RBWAuto int32 Specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the Spectrum) topic for more information about RBW and sweep time.
RFMXSPECAN_VAL_SPUR_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_SPUR_RBW_AUTO_TRUE (1) The measurement computes the RBW.
RBW float64 Specifies the bandwidth, in hertz (Hz), of the RBW filter used to sweep the acquired offset segment, when you set the RBWAuto parameter to RFMXSPECAN_VAL_SPUR_RBW_AUTO_FALSE.
RBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_SYNCH_TUNED_5 (4) An RBW filter with a 5-pole synchronously-tuned response is applied.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeSweepTime

int32 __stdcall RFmxSpecAn_SpurCfgRangeSweepTime (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sweepTimeAuto, float64 sweepTimeInterval);

Purpose

Configures the sweep time.

Use "range<n>" as the selector string to configure this function.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name and range number. If you do not specify the signal name, the default signal instance is used.

Example:

"range0"

"signal::sig1/range0"

You can use the RFmxSpecAn_BuildRangeString2) function to build the selector string).
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the RFMXSPECAN_ATTR_SPUR_RANGE_SWEEP_TIME_INTERVAL) attribute.
RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_SPUR_RANGE_RBW_FILTER_BANDWIDTH) attribute.
sweepTimeInterval float64 Specifies the sweep time, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_FALSE.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeAbsoluteLimit

int32 __stdcall RFmxSpecAn_SpurCfgRangeAbsoluteLimit (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 absoluteLimitMode, float64 absoluteLimitStart, float64 absoluteLimitStop);

Purpose

Configures the absolute power limits corresponding to the beginning and end of the frequency range.

Use "range<n>" as the selector string to configure this function.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name and range number. If you do not specify the signal name, the default signal instance is used.

Example:

"range0"

"signal::sig1/range0"

You can use the RFmxSpecAn_BuildRangeString2) function to build the selector string).
absoluteLimitMode int32 Specifies whether the absolute limit threshold is a flat line or a line with a slope.
RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_MANUAL (0) The line specified by the RFMXSPECAN_ATTR_SPUR_RANGE_ABSOLUTE_LIMIT_START) and RFMXSPECAN_ATTR_SPUR_RANGE_ABSOLUTE_LIMIT_STOP) attribute values as the two ends is considered as the mask.
RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_COUPLE (1) The two ends of the line are coupled to the value of the RFMXSPECAN_ATTR_SPUR_RANGE_ABSOLUTE_LIMIT_START attribute.
absoluteLimitStart float64 Specifies the absolute power limit, in dBm, corresponding to the beginning of the frequency range. The value of this parameter is also set as the absolute power limit for the range when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_COUPLE.
absoluteLimitStop float64 Specifies the absolute power limit, in dBm, corresponding to the end of the frequency range. This parameter is ignored when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_COUPLE.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeRelativeAttenuation

int32 __stdcall RFmxSpecAn_SpurCfgRangeRelativeAttenuation (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 relativeAttenuation);

Purpose

Specifies the attenuation, in dB, relative to the external attenuation.

Use "range<n>" as the selector string to configure this function.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name and range number. If you do not specify the signal name, the default signal instance is used.

Example:

"range0"

"signal::sig1/range0"

You can use the RFmxSpecAn_BuildRangeString2) function to build the selector string).
relativeAttenuation float64 Specifies the attenuation, in dB, relative to the external attenuation. Use this parameter to compensate for variations in external attenuation when the offset channels are spread wide in frequency.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeNumberOfSpursToReport

int32 __stdcall RFmxSpecAn_SpurCfgRangeNumberOfSpursToReport (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfSpursToReport);

Purpose

Specifies the number of Spurs that the measurement must report in the frequency range.

Use "range<n>" as the selector string to configure this function.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name and range number. If you do not specify the signal name, the default signal instance is used.

Example:

"range0"

"signal::sig1/range0"

You can use the RFmxSpecAn_BuildRangeString2) function to build the selector string).
numberOfSpursToReport int32 Specifies the number of Spurs that the measurement must report in the frequency range.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgTraceRangeIndex

int32 __stdcall RFmxSpecAn_SpurCfgTraceRangeIndex (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 traceRangeIndex);

Purpose

Specifies the index of the range used to store and retrieve the spurious emission (Spur) trace.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
traceRangeIndex int32 Specifies the index of the range used to store and retrieve spurious emission (Spur) traces. This parameter is not used if you set the RFMXSPECAN_ATTR_SPUR_ALL_TRACES_ENABLED) attribute to RFMXSPECAN_VAL_FALSE. When you set this parameter to -1, the measurement stores and retrieves traces for all enabled ranges.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgAveraging

int32 __stdcall RFmxSpecAn_SpurCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount, int32 averagingType);

Purpose

Configures averaging for the spurious emission (Spur) measurement.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_SPUR_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_SPUR_AVERAGING_ENABLED_TRUE (1) The measurement uses the averagingCount parameter to calculate the number of acquisitions over which the measurement is averaged.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXSPECAN_VAL_SPUR_AVERAGING_ENABLED_TRUE.
averagingType int32 Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement. Refer to the Averaging section of the Spectrum) topic for more information about averaging types.
RFMXSPECAN_VAL_SPUR_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_SPUR_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithm scale.
RFMXSPECAN_VAL_SPUR_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_SPUR_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_SPUR_AVERAGING_TYPE_MINIMUM (4) The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgFFTWindowType

int32 __stdcall RFmxSpecAn_SpurCfgFFTWindowType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 FFTWindow);

Purpose

Configures the FFT window to obtain a spectrum for the spurious emission (Spur) measurement.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
FFTWindow int32 Specifies the FFT window type to use to reduce spectral leakage. Refer to the Window and FFT section of the Spectrum) topic for more information about FFT window types.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_NONE (0) Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_HANNING (2) Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_GAUSSIAN (4) Provides a balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_BLACKMAN (5) Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_BLACKMAN_HARRIS (6) Useful as a good general purpose window, having side lobe rejection >90dB and having a moderately wide main lobe.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangePeakCriteria

int32 __stdcall RFmxSpecAn_SpurCfgRangePeakCriteria (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 threshold, float64 excursion);

Purpose

Configures the peak threshold and peak excursion criteria which a peak should meet to be classified as a spurious emission (Spur).

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name and range number. If you do not specify the signal name, the default signal instance is used.

Example:

"range0"

"signal::sig1/range0"

You can use the RFmxSpecAn_BuildRangeString2) function to build the selector string).
threshold float64 Specifies the threshold level, in dBm, above which the measurement detects spurs in the range.
excursion float64 Specifies the peak excursion value, in dB, used to find the spurs in the spectrum. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered as a spur.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeDetector

int32 __stdcall RFmxSpecAn_SpurCfgRangeDetector (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 detectorType, int32 detectorPoints);

Purpose

Configures the detector settings including detector type and the number of points to be detected. Use "range<n>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
detectorType int32 Specifies the type of detector to be used.
RFMXSPECAN_VAL_SPUR_FFT_WINDOW_FLAT_TOP (0) The detector is disabled.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_NONE (0) The detector is disabled.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_SAMPLE (1) The middle sample in the bucket is detected.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_NORMAL (02 The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_PEAK (3) The maximum value of the samples in the bucket is detected.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_NEGATIVE_PEAK (4) The minimum value of the samples in the bucket is detected.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_AVERAGE_RMS (5) The average RMS of all the samples in the bucket is detected.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_AVERAGE_VOLTAGE (6) The average voltage of all the samples in the bucket is detected.
RFMXSPECAN_VAL_SPUR_RANGE_DETECTOR_TYPE_AVERAGE_LOG (7) The average log of all the samples in the bucket is detected.
detectorPoints int32 Specifies the number of points after the detector is applied.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeVBWFilter

int32 __stdcall RFmxSpecAn_SpurCfgRangeVBWFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 VBWAuto, float64 VBW, float64 VBWToRBWRatio);

Purpose

Configures the video bandwidth (VBW) settings including VBW Auto, VBW, and VBW to RBW ratio for the specified range. Use "range<n>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
VBWAuto int32 Specifies whether the VBW is expressed directly or computed based on VBW to RBW ratio. This value is expressed in Hz.
RFMXSPECAN_VAL_SPUR_RANGE_VBW_FILTER_AUTO_BANDWIDTH_FALSE (0) Specify the video bandwidth in the VBW parameter. The VBW to RBW Ratio parameter is disregarded in this mode.
RFMXSPECAN_VAL_SPUR_RANGE_VBW_FILTER_AUTO_BANDWIDTH_TRUE (1) Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the RFMXSPECAN_ATTR_SPUR_RANGE_VBW_FILTER_VBW_TO_RBW_RATIO attribute and the Spur Range RBW attribute. The value of the Spur Range VBW attribute is disregarded in this mode.
VBW float64 Specifies the video bandwidth when you set the VBWAuto parameter false. This value is expressed in Hz.
VBWToRBWRatio float64 Specifies the VBW to RBW Ratio when you set the VBWAuto parameter to True.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Spur Array Apis

RFmxSpecAn_SpurCfgRangeFrequencyArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeFrequencyArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency[], float64 stopFrequency[], int32 rangeEnabled[], int32 numberOfElements);

Purpose

Configures the frequency start and stop values and specifies whether to enable measurement of the spurious emissions (Spur) in the frequency range.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
startFrequency float64[] Specifies the array of start frequencies of the frequency range, in hertz (Hz), for the measurement. Specify NULL if you do not want to set a value for this array.
stopFrequency float64[] Specifies the array of stop frequencies of the frequency range, in hertz (Hz), for the measurement. Specify NULL if you do not want to set a value for this array.
rangeEnabled int32[] Specifies whether to measure the Spurs in the frequency range.
RFMXSPECAN_VAL_SPUR_RANGE_ENABLED_FALSE (0) Disables the acquisition of the frequency range.
RFMXSPECAN_VAL_SPUR_RANGE_ENABLED_TRUE (1) Enables measurement of Spurs in the frequency range.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeRBWArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeRBWArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RBWAuto[], float64 RBW[], int32 RBWFilterType[], int32 numberOfElements);

Purpose

Configures the resolution bandwidth (RBW) filter.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
RBWAuto int32[] Specifies the array of RBWAuto which determines whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the Spectrum) topic for more information about RBW and sweep time. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_SPUR_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_SPUR_RBW_AUTO_TRUE (1) The measurement computes the RBW.
RBW float64[] Specifies the array of bandwidths, in hertz (Hz), of the RBW filter used to sweep the acquired range, when you set the RBWAuto parameter to RFMXSPECAN_VAL_SPUR_RBW_AUTO_FALSE. Specify NULL if you do not want to set a value for this array.
RBWFilterType int32[] Specifies the array of shapes of the digital RBW filter. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_FFTBASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_SYNCHTUNED4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_SPUR_RBW_FILTER_TYPE_SYNCHTUNED5 (4) An RBW filter with a 5-pole synchronously-tuned response is applied.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeSweepTimeArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeSweepTimeArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sweepTimeAuto[], float64 sweepTimeInterval[], int32 numberOfElements);

Purpose

Configures the sweep time.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
sweepTimeAuto int32[] Specifies whether the measurement computes the sweep time. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the RFMXSPECAN_ATTR_SPUR_RANGE_SWEEP_TIME_INTERVAL) attribute.
RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_SPUR_RANGE_RBW_FILTER_BANDWIDTH) attribute.
sweepTimeInterval float64[] Specifies the array of sweep times, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_FALSE. Specify NULL if you do not want to set a value for this array.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeAbsoluteLimitArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeAbsoluteLimitArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 absoluteLimitMode[], float64 absoluteLimitStart[], float64 absoluteLimitStop[], int32 numberOfElements);

Purpose

Configures the absolute power limits corresponding to the beginning and end of the frequency range and specifies whether the absolute limit threshold is a flat line or a line with a slope.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
absoluteLimitMode int32[] Specifies whether the absolute limit threshold is a flat line or a line with a slope. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_MANUAL (0) The line specified by the RFMXSPECAN_ATTR_SPUR_RANGE_ABSOLUTE_LIMIT_START) and RFMXSPECAN_ATTR_SPUR_RANGE_ABSOLUTE_LIMIT_STOP) attribute values as the two ends is considered as the mask.
RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_COUPLE (1) The two ends of the line are coupled to the value of the RFMXSPECAN_ATTR_SPUR_RANGE_ABSOLUTE_LIMIT_START attribute.
absoluteLimitStart float64[] Specifies the array of absolute power limits, in dBm, corresponding to the beginning of the frequency range. The value of this parameter is also set as the absolute power limit for the range when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_COUPLE. Specify NULL if you do not want to set a value for this array.
absoluteLimitStop float64[] Specifies the array of absolute power limits, in dBm, corresponding to the end of the frequency range. This parameter is ignored when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SPUR_ABSOLUTE_LIMIT_MODE_COUPLE. Specify NULL if you do not want to set a value for this array.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeRelativeAttenuationArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeRelativeAttenuationArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 relativeAttenuation[], int32 numberOfElements);

Purpose

Specifies the attenuation, in dB, relative to the external attenuation.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
relativeAttenuation float64[] Specifies an array of attenuation values, in dB, relative to the external attenuation. Use this parameter to compensate for the variations in external attenuation when offset channels are spread wide in frequency. Specify NULL if you do not want to set a value for this array.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeNumberOfSpursToReportArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeNumberOfSpursToReportArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfSpursToReport[], int32 numberOfElements);

Purpose

Specifies the number of Spurs that the measurement must report in the frequency range.

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
numberOfSpursToReport int32[] Specifies the array of number of Spurs that the measurement must report in the frequency range. Specify NULL if you do not want to set a value for this array.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangePeakCriteriaArray

int32 __stdcall RFmxSpecAn_SpurCfgRangePeakCriteriaArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 threshold [], float64 excursion [], int32 numberOfElements );

Purpose

Configures arrays of peak threshold and peak excursion criteria which a peak should meet to be classified as a spurious emission (Spur).

Supported devices: PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
threshold float64[] Specifies the array of threshold levels, in dBm, above which the measurement detects spurs in the range.
excursion float64[] Specifies the array of peak excursion values, in dB, used to find the spurs in the spectrum. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered as a spur.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeDetectorArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeDetectorArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 detectorType[], int32 detectorPoints[], int32 numberOfElements);

Purpose

Configures an array of the detector settings including detector type and the number of points to be detected.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
detectorType int32[] Specifies an array of the type of detector to be used.
detectorPoints int32[] Specifies an array of the number of points after the detector is applied.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxSpecAn_SpurCfgRangeVBWFilterArray

int32 __stdcall RFmxSpecAn_SpurCfgRangeVBWFilterArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 VBWAuto[], float64 VBW[], float64 VBWToRBWRatio[], int32 numberOfElements);

Purpose

Configures an array of the VBW settings, including VBW Auto, VBW, and VBW to RBW ratio for the specified range.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString char[] Comprises the signal name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

You can use the RFmxSpecAn_BuildSignalString) function to build the selector string).
VBWAuto int32[] Specifies whether the VBW is expressed directly or computed based on VBW to RBW ratio. This value is expressed in Hz.
RFMXSPECAN_VAL_SPUR_RANGE_VBW_FILTER_AUTO_BANDWIDTH_FALSE (0) Specify the video bandwidth in the VBW parameter. The VBW to RBW Ratio parameter is disregarded in this mode.
RFMXSPECAN_VAL_SPUR_RANGE_VBW_FILTER_AUTO_BANDWIDTH_TRUE (1) Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the RFMXSPECAN_ATTR_SPUR_RANGE_VBW_FILTER_VBW_TO_RBW_RATIO attribute and the Spur Range RBW attribute. The value of the Spur Range VBW attribute is disregarded in this mode.
VBW float64[] Specifies the video bandwidth when you set the VBWAuto parameter false. This value is expressed in Hz.
VBWToRBWRatio float64[] Specifies the VBW to RBW Ratio when you set the VBWAuto parameter to True.
numberOfElements int32 Specifies the number of elements in each array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Table of Contents

Home

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally