Skip to content

NI RFmx SpecAn Configuration Functions

Dane Stull edited this page Feb 18, 2022 · 8 revisions

Configuration Functions

RFmxSpecAn_CfgRF

int32 __stdcall RFmxSpecAn_CfgRF (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 centerFrequency, float64 referenceLevel, float64 externalAttenuation);

Purpose

Configures the RF properties of the signal specified by the selector string.

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.
centerFrequency float64 Specifies the carrier frequency, in Hz, of the RF signal that needs to be acquired. The signal analyzer tunes to this frequency.
referenceLevel float64 Specifies the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices. The default of this property is hardware dependent.
externalAttenuation float64 Specifies the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.

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_CfgFrequency

int32 __stdcall RFmxSpecAn_CfgFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 centerFrequency);

Purpose

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.

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.
centerFrequency float64 Specifies the carrier frequency, in Hz, of the RF signal that needs to be acquired. The signal analyzer tunes to this 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_CfgReferenceLevel

int32 __stdcall RFmxSpecAn_CfgReferenceLevel (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 referenceLevel);

Purpose

Configures the reference level, which represents the maximum expected power of an RF input signal.

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.
referenceLevel float64 Specifies the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices. The default of this property is hardware dependent.

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_AutoLevel

int32 __stdcall RFmxSpecAn_AutoLevel (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 bandwidth, float64 measurementInterval, float64 *referenceLevel);

Purpose

Examines the incoming signal to calculate the peak power level and sets it as the value of the RFMXSPECAN_ATTR_REFERENCE_LEVEL attribute. Use this function to help calculate an approximate setting for the reference level.

The RFmxSpecAn_AutoLevel function does the following:

  1. Resets the mixer level, mixer level offset, and IF output power offset.
  2. Sets the starting reference level to the maximum reference level supported by the device based on the current RF attenuation, mechanical attenuation and preamp enabled settings.
  3. Iterates to adjust the reference level based on the input signal peak power.
  4. Uses immediate triggering and restores the trigger settings back to user setting after completing execution.

When using PXIe-5663, 5665, or 5668 devices, NI recommends that you set an appropriate value for mechanical attenuation before calling the RFmxSpecAn_AutoLevel function. Setting an appropriate value for mechanical attenuation reduces the number of times the attenuator settings are changed by this function, thus reducing wear and tear, and maximizing the life time of the attenuator. You can also specify the starting reference level using the RFMXSPECAN_ATTR_AUTO_LEVEL_INITIAL_REFERENCE_LEVEL attribute.

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.
bandwidth float64 Specifies the bandwidth, in Hz, of the signal to be analyzed.
measurementInterval float64 Specifies the acquisition length. Use this value to compute the number of samples to acquire from the signal analyzer. This value is expressed in seconds.
Auto Level VI does not use any trigger for acquisition. It ignores the user-configured trigger properties. NI recommends that you set a sufficiently high measurement interval to ensure that the acquired waveform is at least as long as one period of the signal.
Output
Name Type Description
referenceLevel float64* Returns the estimated peak power level of the input signal. This value is expressed in dBm for RF devices and as Vpk-pk for baseband devices.

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_CfgExternalAttenuation

int32 __stdcall RFmxSpecAn_CfgExternalAttenuation (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 externalAttenuation);

Purpose

Specifies the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer.

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.
externalAttenuation float64 Specifies the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.

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

| :- | :- | :- |

Trigger

RFmxSpecAn_CfgIQPowerEdgeTrigger

int32 __stdcall RFmxSpecAn_CfgIQPowerEdgeTrigger (niRFmxInstrHandle instrumentHandle, char selectorString[], char IQPowerEdgeSource[], float64 IQPowerEdgeLevel, int32 IQPowerEdgeSlope, float64 triggerDelay, int32 triggerMinQuietTimeMode, float64 triggerMinQuietTimeDuration, int32 enableTrigger);

Purpose

Configures the device to wait for the complex power of the I/Q data to cross the specified threshold and then marks a reference point within the record. To trigger on bursty signals, specify a minimum quiet time, which ensures that the trigger does not occur in the middle of the burst signal. The quiet time must be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.

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.
IQPowerEdgeSource char[] Specifies the channel from which the device monitors the trigger. The default of this attribute is hardware dependent.
IQPowerEdgeLevel float64 Specifies the power level at which the device triggers. This value is expressed in dB when you set the IQPowerEdgeLevelType parameter to RFMXSPECAN_VAL_IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE_RELATIVE and is expressed in dBm when you set the IQPowerEdgeLevelType parameter to RFMXSPECAN_VAL_IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE_ABSOLUTE. The device asserts the trigger when the signal exceeds the level specified by the value of this parameter, taking into consideration the specified slope. The default of this attribute is hardware dependent.
IQPowerEdgeSlope int32 Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify.
RFMXSPECAN_VAL_IQ_POWER_EDGE_RISING_SLOPE (0) The trigger asserts when the signal power is rising.
RFMXSPECAN_VAL_IQ_POWER_EDGE_FALLING_SLOPE (1) The trigger asserts when the signal power is falling.

| :- | :- | :- | |triggerDelay|float64|Specifies the trigger delay time, in seconds. | |triggerMinQuietTimeMode|int32|Specifies whether the measurement computes the minimum quiet time used for triggering. |

RFMXSPECAN_VAL_TRIGGER_MINIMUM_QUIET_TIME_MODE_MANUAL (0) The minimum quiet time used for triggering is the value of the triggerMinQuietTimeDuration parameter.
RFMXSPECAN_VAL_TRIGGER_MINIMUM_QUIET_TIME_MODE_AUTO (1) The measurement computes the minimum quiet time used for triggering.

| :- | :- | :- | |triggerMinQuietTimeDuration|float64|Specifies the duration, in seconds, for which the signal must be quiet before the signal analyzer arms the I/Q Power Edge trigger. If you set the IQPowerEdgeSlope parameter to RFMXSPECAN_VAL_IQ_POWER_EDGE_RISING_SLOPE, the signal is quiet when it is below the trigger level. If you set the IQPowerEdgeSlope parameter to RFMXSPECAN_VAL_IQ_POWER_EDGE_FALLING_SLOPE, the signal is quiet when it is above the trigger level. | |enableTrigger|int32|Specifies whether to enable the trigger. |

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_CfgSoftwareEdgeTrigger

int32 __stdcall RFmxSpecAn_CfgSoftwareEdgeTrigger (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 triggerDelay, int32 enableTrigger);

Purpose

Configures the device to wait for a software trigger and then marks a reference point within the record.

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.
triggerDelay float64 Specifies the trigger delay time, in seconds.
enableTrigger int32 Specifies whether to enable the trigger.

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_CfgDigitalEdgeTrigger

int32 __stdcall RFmxSpecAn_CfgDigitalEdgeTrigger (niRFmxInstrHandle instrumentHandle, char selectorString[], char digitalEdgeSource[], int32 digitalEdge, float64 triggerDelay, int32 enableTrigger);

Purpose

Configures the device to wait for a digital edge trigger and then marks a reference point within the record. Spectral measurements are sometimes implemented with multiple acquisitions and therefore will require that digital triggers are sent for each acquisition. Multiple factors, including the desired span versus the realtime bandwidth of the hardware, affect the number of acquisitions. RFmx recommends repeating the generation until the measurement is completed in order to ensure that all the acquisitions are triggered.

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.
digitalEdgeSource char[] Specifies the source terminal for the digital edge trigger. The default of this attribute is hardware dependent.
RFMXSPECAN_VAL_PFI0_STR (PFI0) The trigger is received on PFI 0.
RFMXSPECAN_VAL_PFI1_STR (PFI1) The trigger is received on PFI 1.
RFMXSPECAN_VAL_PXI_TRIG0_STR (PXI_Trig0) The trigger is received on PXI trigger line 0.
RFMXSPECAN_VAL_PXI_TRIG1_STR (PXI_Trig1) The trigger is received on PXI trigger line 1.
RFMXSPECAN_VAL_PXI_TRIG2_STR (PXI_Trig2) The trigger is received on PXI trigger line 2.
RFMXSPECAN_VAL_PXI_TRIG3_STR (PXI_Trig3) The trigger is received on PXI trigger line 3.
RFMXSPECAN_VAL_PXI_TRIG4_STR (PXI_Trig4) The trigger is received on PXI trigger line 4.
RFMXSPECAN_VAL_PXI_TRIG5_STR (PXI_Trig5) The trigger is received on PXI trigger line 5.
RFMXSPECAN_VAL_PXI_TRIG6_STR (PXI_Trig6) The trigger is received on PXI trigger line 6.
RFMXSPECAN_VAL_PXI_TRIG7_STR (PXI_Trig7) The trigger is received on PXI trigger line 7.
RFMXSPECAN_VAL_PXI_STAR_STR (PXI_STAR) The trigger is received on the PXI star trigger line.
RFMXSPECAN_VAL_PXIE_DSTARB_STR (PXIe_DStarB) The trigger is received on the PXIe DStar B trigger line.
RFMXSPECAN_VAL_TIMER_EVENT_STR (TimerEvent) The trigger is received from the timer event.

| :- | :- | :- | |digitalEdge|int32|Specifies the trigger edge to detect. |

RFMXSPECAN_VAL_DIGITAL_EDGE_RISING_EDGE (0) The trigger asserts on the rising edge of the signal.
RFMXSPECAN_VAL_DIGITAL_EDGE_FALLING_EDGE (1) The trigger asserts on the falling edge of the signal.

| :- | :- | :- | |triggerDelay|float64|Specifies the trigger delay time, in seconds. | |enableTrigger|int32|Specifies whether to enable the trigger. |

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_DisableTrigger

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

Purpose

Configures the device to not wait for a trigger to mark a reference point within a record. This function defines the signal triggering as immediate.

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.

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_SendSoftwareEdgeTrigger

int32 __stdcall RFmxSpecAn_SendSoftwareEdgeTrigger (niRFmxInstrHandle instrumentHandle);

Purpose

Sends a trigger to the device when you use the RFmxSpecAn Trigger functions to choose a software version of a trigger, and the device is waiting for the trigger to be sent. You can also use this function to override a hardware trigger.

This function returns an error in the following situations:

  • You configure an invalid trigger.
  • You have not previously called the RFmxSpecAn_Initiate function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize function.

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_CfgFrequencyReference

int32 __stdcall RFmxSpecAn_CfgFrequencyReference (niRFmxInstrHandle instrumentHandle, char channelName[], char frequencyReferenceSource[], float64 frequencyReferenceFrequency);

Purpose

Configures the Reference Clock and the frequency reference source.

This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_CfgFrequencyReference function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize function.
channelName char[] Set this parameter to "" (empty string) or NULL.
frequencyReferenceSource char[] Specifies the frequency reference source.
RFMXSPECAN_VAL_ONBOARD_CLOCK_STR ("Onboard Clock") PXIe-5663/5663E: The RFmx driver locks the PXIe-5663/5663E to the PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXIe-5652 to the PXIe-5622 CLK IN terminal. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXIe-5652, connect the REF IN/OUT connector on the PXIe-5652 to the PXIe-5622 CLK IN terminal.

PXIe-5665: The RFmx driver locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the PXIe-5622 CLK IN terminal.

PXIe-5644R/5645R/5646R, PXIe-5840: The RFmx driver locks the device to its onboard clock.
RFMXSPECAN_VAL_REF_IN_STR ("RefIn") PXIe-5663/5663E: Connect the external signal to the PXIe-5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the PXIe-5652 to the PXIe-5622 CLK IN terminal.

PXIe-5665: Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the PXIe-5622 CLK IN connector. If your external clock signal frequency is set to a frequency other than 10 MHz, set the frequencyReferenceFrequency parameter according to the frequency of your external clock signal.

PXIe-5644R/5645R/5646R, PXIe-5840: The RFmx driver locks the device to the signal at the external REF IN connector.
RFMXSPECAN_VAL_PXI_CLK_STR ("PXI_Clk") PXIe-5644R/5645R/5646R, PXIe-5663/5663E/5665, PXIe-5840: The RFmx driver locks the PXIe-5644R/5645R/5646R, PXIe-5663/5663E/5665 to the PXI backplane clock.
RFMXSPECAN_VAL_CLK_IN_STR ("ClkIn") PXIe-5663/5663E: The RFmx driver locks the PXIe-5663/5663E to an external 10 MHz signal. Connect the external signal to the PXIe-5622 CLK IN connector, and connect the PXIe-5622 CLK OUT connector to the FREQ REF IN connector on the PXIe-5652.

PXIe-5665: The RFmx driver locks the PXIe-5665 to an external 100 MHz signal. Connect the external signal to the PXIe-5622 CLK IN connector, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the frequencyReferenceFrequency parameter to 100 MHz.

PXIe-5644R/5645R/5646R, PXIe-5840: This configuration does not apply to the PXIe-5644R/5645R/5646R.

| :- | :- | :- | |frequencyReferenceFrequency|float64|Specifies the Reference Clock rate, in Hz, when the frequencyReferenceSource parameter is set to RFMXSPECAN_VAL_CLK_IN_STR or RFMXSPECAN_VAL_REF_IN_STR.|

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_CfgRFAttenuation

int32 __stdcall RFmxSpecAn_CfgRFAttenuation (niRFmxInstrHandle instrumentHandle, char channelName[], int32 RFAttenuationAuto, float64 RFAttenuationValue);

Purpose

Configures the nominal attenuation and the RFmx driver setting.

This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_CfgRFAttenuation function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize function.
channelName char[] Set this parameter to "" (empty string) or NULL.
RFAttenuationAuto int32 Specifies whether the RFmx driver computes the RF attenuation.
RFMXSPECAN_VAL_RF_ATTENUATION_AUTO_FALSE (0) Specifies that the RFmx driver uses the value configured using the rfAttenuationValue parameter.
RFMXSPECAN_VAL_RF_ATTENUATION_AUTO_TRUE (1) Specifies that the RFmx driver computes the RF attenuation automatically.

| :- | :- | :- | |RFAttenuationValue|float64|Specifies the nominal attenuation setting, in dB, for all attenuators before the first mixer in the RF signal chain when the rfAttenuationAuto parameter is set to RFMXSPECAN_VAL_RF_ATTENUATION_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_CfgMechanicalAttenuation

int32 __stdcall RFmxSpecAn_CfgMechanicalAttenuation (niRFmxInstrHandle instrumentHandle, char channelName[], int32 mechanicalAttenuationAuto, float64 mechanicalAttenuationValue);

Purpose

Configures the mechanical attenuation and the RFmx driver attenuation hardware settings.

This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_CfgMechanicalAttenuation function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize function.
channelName char[] Set this parameter to "" (empty string) or NULL.
mechanicalAttenuationAuto int32 Specifies whether the RFmx driver automatically chooses an attenuation setting based on the hardware settings.
RFMXSPECAN_VAL_MECHANICAL_ATTENUATION_AUTO_FALSE (0) Specifies that the RFmx driver uses the value configured in the mechanicalAttenuationValue parameter.
RFMXSPECAN_VAL_MECHANICAL_ATTENUATION_AUTO_TRUE (1) Specifies that the measurement computes the mechanical attenuation.

| :- | :- | :- | |mechanicalAttenuationValue|float64|Specifies the level of mechanical attenuation, in dB, for the RF path when the mechanicalAttenuationAuto is set to RFMXSPECAN_VAL_MECHANICAL_ATTENUATION_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

| :- | :- | :- |

ACP Configure

RFmxSpecAn_ACPCfgCarrierAndOffsets

int32 __stdcall RFmxSpecAn_ACPCfgCarrierAndOffsets (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 integrationBandwidth, int32 numberOfOffsets, float64 channelSpacing);

Purpose

Configures a carrier channel with offset channels on both sides of the carrier as specified by the number of offsets. The offset channels are separated by +/- n*channel spacing from the center of the carrier. Power is measured over the integration bandwidth for each channel.

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.
integrationBandwidth float64 Specifies the frequency range, in Hz, over which the measurement integrates the carrier power.
numberOfOffsets int32 Specifies the number of offset channels.
channelSpacing float64 Specifies the spacing between offset channels.

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_ACPCfgNumberOfCarriers

int32 __stdcall RFmxSpecAn_ACPCfgNumberOfCarriers (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfCarriers);

Purpose

Configures the number of carriers for the adjacent channel power (ACP) measurement.

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.
numberOfCarriers int32 Specifies the number of carriers.

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_ACPCfgCarrierMode

int32 __stdcall RFmxSpecAn_ACPCfgCarrierMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 carrierMode);

Purpose

Configures whether to consider the carrier power as part of total carrier power measurement.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
carrierMode int32 Specifies whether to consider the carrier power as part of total carrier power measurement.
RFMXSPECAN_VAL_ACP_CARRIER_MODE_PASSIVE (0) The carrier power is not considered as part of total carrier power.
RFMXSPECAN_VAL_ACP_CARRIER_MODE_ACTIVE (1) The carrier power is considered as part of total carrier power.

| :- | :- | :- |

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_ACPCfgCarrierFrequency

int32 __stdcall RFmxSpecAn_ACPCfgCarrierFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 carrierFrequency);

Purpose

Configures the center frequency of the carrier, relative to the RF center frequency.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
carrierFrequency float64 Specifies the center frequency, in Hz, of the carrier, relative to the RF [center frequency](javascript:LaunchMergedHelp('rfmxspecan.chm', 'rfmxspecancvi.chm', 'RFMXSPECAN_ATTR_CENTER_FREQUENCY.html')).

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_ACPCfgCarrierIntegrationBandwidth

int32 __stdcall RFmxSpecAn_ACPCfgCarrierIntegrationBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 integrationBandwidth);

Purpose

Configures the frequency range, in Hz, over which the measurement integrates the carrier power.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
integrationBandwidth float64 Specifies the frequency range, in Hz, over which the measurement integrates the carrier power.

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_ACPCfgCarrierRRCFilter

int32 __stdcall RFmxSpecAn_ACPCfgCarrierRRCFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RRCFilterEnabled, float64 RRCAlpha);

Purpose

Configures the root-raised-cosine (RRC) filter to apply on the carrier channel before measuring the carrier channel power.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
RRCFilterEnabled int32 Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_FALSE (0) The channel power of the acquired carrier channel is measured directly.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_TRUE (1) The RRC filter is applied on the acquired carrier channel before measuring the carrier channel power.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_ACPCfgNumberOfOffsets

int32 __stdcall RFmxSpecAn_ACPCfgNumberOfOffsets (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfOffsets);

Purpose

Configures the number of offsets for the adjacent channel power (ACP) measurement.

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.
numberOfOffsets int32 Specifies the number of offset channels.

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_ACPCfgOffset

int32 __stdcall RFmxSpecAn_ACPCfgOffset (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetFrequency, int32 offsetSideband, int32 offsetEnabled);

Purpose

Configures an offset channel on one or both sides of the carrier with center-to-center spacing as specified by the offset frequency and offset frequency definition. In case of multiple carriers, offset frequency is relative to the closest carrier.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
offsetFrequency float64 Specifies the center or edge frequency, in Hz, of the offset channel, relative to the center frequency of the closest carrier as determined by the RFMXSPECAN_ATTR_ACP_OFFSET_FREQUENCY_DEFINITION attribute. The sign of offset frequency is ignored and the offsetSideband parameter determines whether the upper, lower, or both offsets are measured.
offsetSideband int32 Specifies whether the offset segment is present on one side, or on both sides of the carriers.
RFMXSPECAN_VAL_ACP_OFFSET_SIDEBAND_NEGATIVE (0) Configures a lower offset segment, which is an offset segment with negative offset frequency, relative to the lowest center frequency of the carrier.
RFMXSPECAN_VAL_ACP_OFFSET_SIDEBAND_POSITIVE (1) Configures an upper offset segment, which is an offset segment with positive offset frequency, relative to the highest center frequency of the carrier.
RFMXSPECAN_VAL_ACP_OFFSET_SIDEBAND_BOTH (2) Specifies that both negative and positive offset segments are configured.

| :- | :- | :- | |offsetEnabled|int32|Specifies whether to enable the offset channel for ACP measurement. |

RFMXSPECAN_VAL_ACP_OFFSET_ENABLED_FALSE (0) Disables the offset channel for ACP measurement.
RFMXSPECAN_VAL_ACP_OFFSET_ENABLED_TRUE (1) Enables the offset channel for ACP measurement.

| :- | :- | :- |

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_ACPCfgOffsetIntegrationBandwidth

int32 __stdcall RFmxSpecAn_ACPCfgOffsetIntegrationBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 integrationBandwidth);

Purpose

Configures the frequency range, in Hz, over which the measurement integrates the offset channel power.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
integrationBandwidth float64 Specifies the frequency range, in Hz, over which the measurement integrates the carrier power.

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_ACPCfgOffsetPowerReference

int32 __stdcall RFmxSpecAn_ACPCfgOffsetPowerReference (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 offsetReferenceCarrier, int32 offsetReferenceSpecific);

Purpose

Configures the power reference to use for measuring the relative power of the offset channel.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
offsetReferenceCarrier int32 Specifies the carrier to be used as power reference to measure offset channel relative power. The offset channel power is measured only if you set the RFMXSPECAN_ATTR_ACP_CARRIER_MODE attribute of the reference carrier to RFMXSPECAN_VAL_ACP_CARRIER_MODE_ACTIVE.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_CLOSEST (0) The measurement uses the power measured in the carrier closest to the offset channel center frequency, as the power reference.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_HIGHEST (1) The measurement uses the highest power measured among all the active carriers as the power reference.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_COMPOSITE (2) The measurement uses the sum of powers measured in all the active carriers as the power reference.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_SPECIFIC (3) The measurement uses the power measured in the carrier that has an index specified by the RFMXSPECAN_ATTR_ACP_OFFSET_POWER_REFERENCE_SPECIFIC attribute, as the power reference.

| :- | :- | :- | |offsetReferenceSpecific|int32|Specifies the index of the carrier to be used as the reference carrier. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the offsetReferenceCarrier parameter to RFMXSPECAN_VAL_ACP_OFFSET_REFERENCE_CARRIER_SPECIFIC.|

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_ACPCfgOffsetRelativeAttenuation

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

Purpose

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

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
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_ACPCfgOffsetRRCFilter

int32 __stdcall RFmxSpecAn_ACPCfgOffsetRRCFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RRCFilterEnabled, float64 RRCAlpha);

Purpose

Configures the root raised cosine (RRC) channel filter to be applied on the offset channel before measuring channel power.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
RRCFilterEnabled int32 Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_FALSE (0) The channel power of the acquired carrier channel is measured directly.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_TRUE (1) The RRC filter is applied on the acquired carrier channel before measuring the carrier channel power.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_ACPCfgPowerUnits

int32 __stdcall RFmxSpecAn_ACPCfgPowerUnits (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 powerUnits);

Purpose

Configures the units for the absolute power.

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.
powerUnits int32 Specifies the units for the absolute power.
RFMXSPECAN_VAL_ACP_POWER_UNITS_DBM (0) The absolute powers are reported in dBm.
RFMXSPECAN_VAL_ACP_POWER_UNITS_DBM_PER_HZ (1) The absolute powers are reported in dBm/Hz.

| :- | :- | :- |

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_ACPCfgMeasurementMethod

int32 __stdcall RFmxSpecAn_ACPCfgMeasurementMethod (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 measurementMethod);

Purpose

Configures the method for performing the adjacent channel power (ACP) measurement.

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.
measurementMethod int32 Specifies the method for performing the ACP measurement.
RFMXSPECAN_VAL_ACP_MEASUREMENT_METHOD_NORMAL (0) The ACP measurement acquires the spectrum using the same signal analyzer setting across frequency bands. Use this method when measurement speed is desirable over higher dynamic range.
RFMXSPECAN_VAL_ACP_MEASUREMENT_METHOD_DYNAMIC_RANGE (1) The ACP measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range.
supportedDevices: PXIe-5665, PXIe-5668.
RFMXSPECAN_VAL_ACP_MEASUREMENT_METHOD_SEQUENTIAL_FFT (2)

The ACP measurement acquires I/Q samples for a duration specified by the RFMXSPECAN_ATTR_ACP_SWEEP_TIME_INTERVAL attribute. These samples are divided into smaller chunks. The size of each chunk is defined by the RFMXSPECAN_ATTR_ACP_SEQUENTIAL_FFT_SIZE attribute. The overlap between the chunks is defined by the RFMXSPECAN_ATTR_ACP_FFT_OVERLAP_MODE attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged to get the spectrum and is used to compute ACP. If the total acquired samples is not an integer multiple of the FFT size, the remaining samples at the end of acquisition are not used for the measurement. Sequential FFT method should be used for the following scenarios.

1. While performing fast ACP measurements by utilizing smaller FFT sizes. However, accuracy of the results may be reduced.

2. When measuring signals with time-varying spectral characteristics, sequential FFT with overlap mode set to Automatic should be used.

The following attributes have limited support when you set the RFMXSPECAN_ATTR_ACP_MEASUREMENT_METHOD attribute to RFMXSPECAN_VAL_ACP_MEASUREMENT_METHOD_SEQUENTIAL_FFT.

 The RFMXSPECAN_ATTR_ACP_RBW_FILTER_AUTO_BANDWIDTH attribute will only support RFMXSPECAN_VAL_ACP_RBW_AUTO_TRUE value.

   The RFMXSPECAN_ATTR_ACP_RBW_FILTER_TYPE attribute will only support RFMXSPECAN_VAL_ACP_RBW_FILTER_TYPE_FFT_BASED value.

   The RFMXSPECAN_ATTR_ACP_SWEEP_TIME_AUTO attribute will only support RFMXSPECAN_VAL_ACP_SWEEP_TIME_AUTO_FALSE value.

   The RFMXSPECAN_ATTR_ACP_FFT_WINDOW attribute will only support RFMXSPECAN_VAL_ACP_FFT_WINDOW_NONE value.

   The RFMXSPECAN_ATTR_ACP_AVERAGING_COUNT attribute will only support a value of 1.

   The RFMXSPECAN_ATTR_ACP_NOISE_COMPENSATION_ENABLED attribute will only support RFMXSPECAN_VAL_ACP_NOISE_COMPENSATION_ENABLED_FALSE value.

   The RFMXSPECAN_ATTR_ACP_NUMBER_OF_ANALYSIS_THREADS attribute will only support a value of 1.

   The RFMXSPECAN_ATTR_ACP_AMPLITUDE_CORRECTION_TYPE attribute will only support a value of RFMXSPECAN_VAL_ACP_AMPLITUDE_CORRECTION_TYPE_RF_CENTER_FREQUENCY.

   The RFMXSPECAN_ATTR_ACP_OFFSET_RELATIVE_ATTENUATION attribute will only support a value of 0.

| :- | :- | :- |

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_ACPCfgNoiseCompensationEnabled

int32 __stdcall RFmxSpecAn_ACPCfgNoiseCompensationEnabled (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 noiseCompensationEnabled);

Purpose

Configures compensation of the channel powers for the inherent noise floor of the signal analyzer.

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.
noiseCompensationEnabled int32 Specifies whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer.
RFMXSPECAN_VAL_ACP_NOISE_COMPENSATION_ENABLED_FALSE (0) Disables compensation of the channel powers for the noise floor of the signal analyzer.
RFMXSPECAN_VAL_ACP_NOISE_COMPENSATION_ENABLED_TRUE (1)

Enables compensation of the channel powers for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the ACP measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again.

Supported Devices: PXIe-5663/5665/5668, PXIe-5830/5831/5832

| :- | :- | :- |

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_ACPValidateNoiseCalibrationData

int32 __stdcall RFmxSpecAn_ACPValidateNoiseCalibrationData (niRFmxInstrHandle instrumentHandle, char selectorString[], int32* noiseCalibrationDataValid);

Purpose

Indicates whether calibration data is valid for the configuration specified by the signal name in the selectorString parameter.

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.
Output
Name Type Description
noiseCalibrationDataValid int32* Returns whether the calibration data is valid.

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_ACPCfgRBWFilter

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

Purpose

Configures the resolution bandwidth (RBW) filter.

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.
RBWAuto int32 Specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the ACP topic for more information about RBW and sweep time.
RFMXSPECAN_VAL_ACP_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_ACP_RBW_AUTO_TRUE (1) The measurement computes the RBW.

| :- | :- | :- | |RBW|float64|Specifies the bandwidth, in Hz, of the RBW filter used to sweep the acquired carrier signal, when you set the RBWAuto parameter to RFMXSPECAN_VAL_ACP_RBW_AUTO_FALSE. | |RBWFilterType|int32|Specifies the shape of the digital RBW filter. |

RFMXSPECAN_VAL_ACP_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_ACP_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_ACP_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_ACP_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_ACP_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_ACPCfgSweepTime

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

Purpose

Configures the sweep time.

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.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXSPECAN_VAL_ACP_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXSPECAN_VAL_ACP_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_ACP_RBW_FILTER_BANDWIDTH topic for more information about RBW.

| :- | :- | :- | |sweepTimeInterval|float64|Specifies the sweep time, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_ACP_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_ACPCfgAveraging

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

Purpose

Configures averaging for the adjacent channel power (ACP) measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_ACP_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_ACP_AVERAGING_ENABLED_TRUE (1) The measurement uses the averagingCount parameter to calculate the number of acquisitions over which the spectrum is averaged.

| :- | :- | :- | |averagingCount|int32|Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXSPECAN_VAL_ACP_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_ACP_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_ACP_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithm scale.
RFMXSPECAN_VAL_ACP_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_ACP_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_ACP_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_ACPCfgFFT

int32 __stdcall RFmxSpecAn_ACPCfgFFT (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 FFTWindow, float64 FFTPadding);

Purpose

Configures window and FFT to obtain a spectrum for the adjacent channel power (ACP) measurement.

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.
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_ACP_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_ACP_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_ACP_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_ACP_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_ACP_FFT_WINDOW_GAUSSIAN (4) Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
RFMXSPECAN_VAL_ACP_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_ACP_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_ACP_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

| :- | :- | :- | |FFTPadding|float64|Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula: waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth of the device.|

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_ACPCfgOffsetFrequencyDefinition

int32 __stdcall ACPCfgOffsetFrequencyDefinition (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 offsetFrequencyDefinition);

Purpose

Configures the offset frequency definition for the ACP measurement.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
offsetFrequencyDefinition int32 Specifies the offset frequency definition. The default value is RFMXSPECAN_VAL_ACP_CARRIER_CENTER_TO_OFFSET_CENTER.
RFMXSPECAN_VAL_ACP_CARRIER_CENTER_TO_OFFSET_CENTER (0) The offset frequency is defined from the center of the closest carrier to the center of the offset channel.
RFMXSPECAN_VAL_ACP_CARRIER_CENTER_TO_OFFSET_EDGE (1) The offset frequency is defined from the center of the closest carrier to the nearest edge of the offset channel.

| :- | :- | :- |

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

| :- | :- | :- |

ACP Array Apis

RFmxSpecAn_ACPCfgOffsetArray

int32 __stdcall RFmxSpecAn_ACPCfgOffsetArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetFrequency[], int32 offsetSideband[], int32 offsetEnabled[], int32 numberOfElements);

Purpose

Configures an offset channel on one or both sides of carrier with center-to-center spacing as specified by the offset frequency and offset frequency definition. In case of multiple carriers, offset frequency is relative to the closest carrier.

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.
offsetFrequency float64[] Specifies an array of center or edge frequencies, in Hz, of the offset channel, relative to the center frequency of the closest carrier as determined by the RFMXSPECAN_ATTR_ACP_OFFSET_FREQUENCY_DEFINITION attribute determines whether the upper, lower, or both offsets are measured.
offsetSideband int32[] Specifies whether the offset segment is present on one side, or on both sides of the carriers. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_ACP_OFFSET_FREQUENCY_SIDEBAND_NEG (0) Configures a lower offset segment, which is an offset segment with negative offset frequency, relative to the lowest center frequency of the carrier.
RFMXSPECAN_VAL_ACP_OFFSET_FREQUENCY_SIDEBAND_POS (1) Configures an upper offset segment, which is an offset segment with positive offset frequency, relative to the highest center frequency of the carrier.
RFMXSPECAN_VAL_ACP_OFFSET_FREQUENCY_SIDEBAND_BOTH (2) Specifies that both negative and positive offset segments are configured.

| :- | :- | :- | |offsetEnabled|int32[]|Specifies whether to enable the offset channel for ACP measurement. Specify NULL if you do not want to set a value for this array. |

RFMXSPECAN_VAL_ACP_OFFSET_ENABLED_FALSE (0) Disables the offset channel for ACP measurement.
RFMXSPECAN_VAL_ACP_OFFSET_ENABLED_TRUE (1) Enables the offset channel for ACP measurement.

| :- | :- | :- | |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_ACPCfgOffsetPowerReferenceArray

int32 __stdcall RFmxSpecAn_ACPCfgOffsetPowerReferenceArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 offsetPowerReferenceCarrier[], int32 offsetPowerReferenceSpecific[], int32 numberOfElements);

Purpose

Configures the power reference to use for measuring the relative power of the offset channel.

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.
offsetPowerReferenceCarrier int32[] Specifies the array of carriers to be used as power reference to measure offset channel relative power. The offset channel power is measured only if you set the RFMXSPECAN_ATTR_ACP_CARRIER_MODE attribute of the reference carrier to RFMXSPECAN_VAL_ACP_CARRIER_MODE_ACTIVE. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_CLOSEST (0) The measurement uses the power measured in the carrier closest to the offset channel center frequency, as the power reference.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_HIGHEST (1) The measurement uses the highest power measured among all the active carriers as the power reference.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_COMPOSITE (2) The measurement uses the sum of powers measured in all the active carriers as the power reference.
RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_SPECIFIC (3) The measurement uses the power measured in the carrier that has an index specified by the RFMXSPECAN_ATTR_ACP_OFFSET_POWER_REFERENCE_SPECIFIC attribute, as the power reference.

| :- | :- | :- | |offsetPowerReferenceSpecific|int32[]|Specifies the array of carrier indexes to use as the reference carrier for each offset channel. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the offsetPowerReferenceCarrier parameter to RFMXSPECAN_VAL_ACP_OFFSET_POWER_REFERENCE_CARRIER_SPECIFIC. 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_ACPCfgOffsetRelativeAttenuationArray

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

Purpose

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

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.
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_ACPCfgOffsetRRCFilterArray

int32 __stdcall RFmxSpecAn_ACPCfgOffsetRRCFilterArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RRCFilterEnabled[], float64 RRCAlpha[], int32 numberOfElements);

Purpose

Configures the RRC channel filter to be applied on the offset channel before measuring channel power.

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.
RRCFilterEnabled int32[] Specifies whether to apply the RRC filter on the acquired offset channel before measuring the offset channel power. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_FALSE (0) The channel power of the acquired offset channel is measured directly.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_TRUE (1) The measurement applies the RRC filter on the acquired offset channel before measuring the offset channel power.

| :- | :- | :- | |RRCAlpha|float64[]|Specifies an array of roll-off factors of the RRC filter to apply on the acquired offset channel before measuring the offset channel power. 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

| :- | :- | :- |

CCDF Configure

RFmxSpecAn_CCDFCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_CCDFCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Configures the acquisition time, in seconds, for the complementary cumulative distribution function (CCDF) measurement.

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.
measurementInterval float64 Specifies the acquisition time, in seconds, for the measurement.

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_CCDFCfgRBWFilter

int32 __stdcall RFmxSpecAn_CCDFCfgRBWFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 RBW, int32 RBWFilterType, float64 RRCAlpha);

Purpose

Configures the resolution bandwidth (RBW) filter to measure the power statistics of the signal as seen through this filter.

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.
RBW float64 Specifies the bandwidth, in Hz, of the RBW filter used to measure the signal.
RBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_NONE (5) The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_GAUSSIAN (1) The RBW filter has a Gaussian response.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_FLAT (2) The RBW filter has a flat response.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) The RBW filter has a response of a 4-pole synchronously-tuned filter.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_SYNCH_TUNED_5 (4) The RBW filter has a response of a 5-pole synchronously-tuned filter.
RFMXSPECAN_VAL_CCDF_RBW_FILTER_TYPE_RRC (6) The RRC filter with the roll-off specified by the RRCAlpha parameter is used as the RBW filter.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_CCDFCfgNumberOfRecords

int32 __stdcall RFmxSpecAn_CCDFCfgNumberOfRecords (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfRecords);

Purpose

Configures the number of acquisitions used for the complementary cumulative distribution function (CCDF) measurement.

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.
numberOfRecords int32 Specifies the number of acquisitions used for the CCDF measurement.

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_CCDFCfgThreshold

int32 __stdcall RFmxSpecAn_CCDFCfgThreshold (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 thresholdEnabled, float64 thresholdLevel, int32 thresholdType);

Purpose

Configures the threshold level for the samples that need to be considered for the complementary cumulative distribution function (CCDF) measurement. Enable the threshold when analyzing burst signals or signals with dead time.

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.
thresholdEnabled int32 Specifies whether to enable thresholding of the acquired samples to be used for the measurement.
RFMXSPECAN_VAL_CCDF_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the measurement.
RFMXSPECAN_VAL_CCDF_THRESHOLD_ENABLED_TRUE (1) The samples above the threshold level specified in the thresholdLevel parameter are considered for the measurement.

| :- | :- | :- | |thresholdLevel|float64|Specifies either the relative or absolute threshold power level based on the value of the thresholdType parameter. | |thresholdType|int32|Specifies the reference for the power level used for thresholding. |

RFMXSPECAN_VAL_CCDF_THRESHOLD_TYPE_RELATIVE (0) The threshold is relative to the peak power, in dB, of the acquired samples.
RFMXSPECAN_VAL_CCDF_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

| :- | :- | :- |

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

| :- | :- | :- |

CHP Configure

RFmxSpecAn_CHPCfgSpan

int32 __stdcall RFmxSpecAn_CHPCfgSpan (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 span);

Purpose

Configures the frequency range, in Hz, around the center frequency, to acquire for the CHP measurement.

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.
span float64 Specifies the frequency range, in Hz, around the center frequency, to acquire for the measurement.

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_CHPCfgIntegrationBandwidth

int32 __stdcall RFmxSpecAn_CHPCfgIntegrationBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 integrationBandwidth);

Purpose

Configures the frequency range, in Hz, over which the measurement integrates the power.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
integrationBandwidth float64 Specifies the frequency range, in Hz, over which the measurement integrates the carrier power.

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_CHPCfgRRCFilter

int32 __stdcall RFmxSpecAn_CHPCfgRRCFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RRCFilterEnabled, float64 RRCAlpha);

Purpose

Configures the root raised cosine (RRC) filter to apply on the channel before measuring the channel power.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
RRCFilterEnabled int32 Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.
RFMXSPECAN_VAL_CHP_RRC_FILTER_ENABLED_FALSE (0) The measurement measures the channel power directly on the acquired channel.
RFMXSPECAN_VAL_CHP_RRC_FILTER_ENABLED_TRUE (1) The measurement applies the RRC filter on the acquired channel before measuring the channel power.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_CHPCfgNumberOfCarriers

int32 __stdcall RFmxSpecAn_CHPCfgNumberOfCarriers (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfCarriers);

Purpose

Configures the number of carriers for a channel power (CHP) measurement.

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.
numberOfCarriers int32 Specifies the number of carriers.

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_CHPCfgCarrierOffset

int32 __stdcall RFmxSpecAn_CHPCfgCarrierOffset (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 carrierFrequency);

Purpose

Configures the center frequency of the carrier, relative to the RF center frequency.

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 carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
carrierFrequency float64 Specifies the center frequency, in Hz, of the carrier, relative to the RF center 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_CHPValidateNoiseCalibrationData

int32 __stdcall RFmxSpecAn_CHPValidateNoiseCalibrationData (niRFmxInstrHandle instrumentHandle, char selectorString[], int32* noiseCalibrationDataValid);

Purpose

Indicates whether calibration data is valid for the configuration specified by the signal name in the selectorString parameter.

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.
Output
Name Type Description
noiseCalibrationDataValid int32* Returns whether the calibration data is valid.

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_CHPCfgRBWFilter

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

Purpose

Configures the resolution bandwidth (RBW) filter.

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.
RBWAuto int32 Specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the CHP topic for more information about RBW and sweep time.
RFMXSPECAN_VAL_CHP_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_CHP_RBW_AUTO_TRUE (1) The measurement computes the RBW.

| :- | :- | :- | |RBW|float64|Specifies the bandwidth, in Hz, of the RBW filter used to sweep the acquired carrier signal, when you set the RBWAuto parameter to RFMXSPECAN_VAL_CHP_RBW_AUTO_FALSE. | |RBWFilterType|int32|Specifies the shape of the digital RBW filter. |

RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_CHP_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_CHP_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_CHPCfgSweepTime

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

Purpose

Configures the sweep time.

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.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXSPECAN_VAL_CHP_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXSPECAN_VAL_CHP_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_CHP_RBW_FILTER_BANDWIDTH attribute.

| :- | :- | :- | |sweepTimeInterval|float64|Specifies the sweep time, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_CHP_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_CHPCfgAveraging

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

Purpose

Configures averaging for the channel power (CHP) measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_CHP_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_CHP_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_CHP_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_CHP_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithm scale.
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_CHP_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_CHP_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_CHPCfgFFT

int32 __stdcall RFmxSpecAn_CHPCfgFFT (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 FFTWindow, float64 FFTPadding);

Purpose

Configures window and FFT to obtain a spectrum for the channel power (CHP) measurement.

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.
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_CHP_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_CHP_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_CHP_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_CHP_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_CHP_FFT_WINDOW_GAUSSIAN (4) Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
RFMXSPECAN_VAL_CHP_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_CHP_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_CHP_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

| :- | :- | :- | |FFTPadding|float64|Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula: waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth of the device.|

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

| :- | :- | :- |

Fcnt Configure

RFmxSpecAn_FCntCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_FCntCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Configures the acquisition time, in seconds, for the frequency count (FCnt) measurement.

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.
measurementInterval float64 Specifies the acquisition time, in seconds, for the measurement.

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_FCntCfgRBWFilter

int32 __stdcall RFmxSpecAn_FCntCfgRBWFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 RBW, int32 RBWFilterType, float64 RRCAlpha);

Purpose

Configures the resolution bandwidth (RBW) filter to be applied before measuring the frequency.

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.
RBW float64 Specifies the bandwidth, in Hz, of the RBW filter used to measure the signal.
RBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_NONE (5) The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_GAUSSIAN (1) The RBW filter has a Gaussian response.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_FLAT (2) The RBW filter has a flat response.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) The RBW filter has a response of a 4-pole synchronously-tuned filter.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_SYNCH_TUNED_5 (4) The RBW filter has a response of a 5-pole synchronously-tuned filter.
RFMXSPECAN_VAL_FCNT_RBW_FILTER_TYPE_RRC (6) The RRC filter with the roll-off specified by RRCAlpha parameter is used as the RBW filter.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_FCntCfgThreshold

int32 __stdcall RFmxSpecAn_FCntCfgThreshold (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 thresholdEnabled, float64 thresholdLevel, int32 thresholdType);

Purpose

Configures the threshold level for the samples that need to be considered for the frequency count (FCnt) measurement. Enable the threshold when analyzing burst signals or signals with dead time.

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.
thresholdEnabled int32 Specifies whether to enable thresholding of the acquired samples to be used for the measurement.
RFMXSPECAN_VAL_FCNT_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the measurement.
RFMXSPECAN_VAL_FCNT_THRESHOLD_ENABLED_TRUE (1) The samples above the threshold level specified in the thresholdLevel parameter are considered for the measurement.

| :- | :- | :- | |thresholdLevel|float64|Specifies either the relative or absolute threshold power level based on the value of the thresholdType parameter. | |thresholdType|int32|Specifies the reference for the power level used for thresholding. |

RFMXSPECAN_VAL_FCNT_THRESHOLD_TYPE_RELATIVE (0) The threshold is relative to the peak power, in dB, of the acquired samples.
RFMXSPECAN_VAL_FCNT_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

| :- | :- | :- |

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_FCntCfgAveraging

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

Purpose

Configures averaging for the frequency count (FCnt) measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_FCNT_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_FCNT_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_FCNT_AVERAGING_ENABLED_TRUE.| |averagingType|int32|Specifies the averaging type for averaging multiple acquisitions.|

RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MEAN (6) The mean of the instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.
RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MAXIMUM (3) The maximum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.
RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MINIMUM (4) The minimum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement.
RFMXSPECAN_VAL_FCNT_AVERAGING_TYPE_MINMAX (7) The maximum instantaneous signal phase difference over multiple acquisitions is used for the frequency measurement. The sign of the phase difference is ignored to find the maximum instantaneous value.

| :- | :- | :- |

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

| :- | :- | :- |

Harmonics Configure

RFmxSpecAn_HarmCfgFundamentalRBW

int32 __stdcall RFmxSpecAn_HarmCfgFundamentalRBW (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 RBW, int32 RBWFilterType, float64 RRCAlpha);

Purpose

Configures the resolution bandwidth (RBW) filter to be applied on the acquired signal. The bandwidth of the filter specified is applied on the fundamental signal.

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.
RBW float64 Specifies the bandwidth, in Hz, of the RBW filter used to acquire the fundamental signal.
RBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_NONE (5) The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_SYNCH_TUNED_5 (4) An RBW filter with a 5-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_HARM_RBW_FILTER_TYPE_RRC (6) The measurement uses RRC FIR coefficients for filtering.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_HarmCfgFundamentalMeasurementInterval

int32 __stdcall RFmxSpecAn_HarmCfgFundamentalMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Configures the acquisition time, in seconds, for acquiring the fundamental signal.

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.
measurementInterval float64 Specifies the acquisition time, in seconds, for the measurement.

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_HarmCfgNumberOfHarmonics

int32 __stdcall RFmxSpecAn_HarmCfgNumberOfHarmonics (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfHarmonics);

Purpose

Configures the number of harmonics, including fundamental, to measure.

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.
numberOfHarmonics int32 Specifies the number of harmonics, including fundamental, to measure.

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_HarmCfgAutoHarmonics

int32 __stdcall RFmxSpecAn_HarmCfgAutoHarmonics (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 autoHarmonicsSetupEnabled);

Purpose

Configures auto configuration of successive harmonics.

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.
autoHarmonicsSetupEnabled int32 Specifies whether to enable auto configuration of successive harmonics.
RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_FALSE (0) The measurement uses manual configuration for the harmonic order, harmonic bandwidth, and harmonic measurement interval.
RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_TRUE (1) The measurement uses the RFMXSPECAN_ATTR_HARM_NUMBER_OF_HARMONICS attribute and configuration of the fundamental to configure successive harmonics.

Bandwidth of Nth order harmonic = N * (Bandwidth of fundamental).

Measurement interval of Nth order harmonics = (Measurement interval of fundamental)/N

| :- | :- | :- |

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_HarmCfgHarmonic

int32 __stdcall RFmxSpecAn_HarmCfgHarmonic (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 harmonicOrder, float64 harmonicBandwidth, int32 harmonicEnabled, float64 harmonicMeasurementInterval);

Purpose

Configures the harmonic frequency, acquisition bandwidth, and acquisition time for the harmonic, when you set the RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED attribute to RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_FALSE.

Use "harmonic<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 harmonic number. If you do not specify the signal name, the default signal instance is used.

Example:

"harmonic0"

"signal::sig1/harmonic0"

You can use the RFmxSpecAn_BuildHarmonicString2.
harmonicOrder int32 Specifies the order of the harmonic.

Frequency of Nth order harmonic = N * (Frequency of fundamental)
harmonicBandwidth float64 Specifies the resolution bandwidth, in Hz, for the harmonic.
harmonicEnabled int32 Specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD).
RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_FALSE (0) Disables the harmonic for measurement.
RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_TRUE (1) Enables the harmonic for measurement.

| :- | :- | :- | |harmonicMeasurementInterval|float64|Specifies the acquisition time, in seconds, for the harmonic.|

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_HarmCfgAveraging

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

Purpose

Configures averaging for the harmonics 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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_HARM_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_HARM_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_HARM_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_HARM_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithm scale.
RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_HARM_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_HARM_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_HarmCfgHarmonicArray

int32 __stdcall RFmxSpecAn_HarmCfgHarmonicArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 harmonicOrder[], float64 harmonicBandwidth[], int32 harmonicEnabled[], float64 harmonicMeasurementInterval[], int32 numberOfElements);

Purpose

Configures the harmonic frequency, acquisition bandwidth, and acquisition time for the harmonic, when you set the RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED attribute to RFMXSPECAN_VAL_HARM_AUTO_HARMONICS_SETUP_ENABLED_FALSE.

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.
harmonicOrder int32[] Specifies the order of the harmonic.

Frequency of Nth order harmonic = N * (Frequency of fundamental)
harmonicBandwidth float64[] Specifies the array of resolution bandwidths, in Hz, for the harmonic.
harmonicEnabled int32[] Specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD).
RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_FALSE (0) Disables the harmonic for measurement.
RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_TRUE (1) Enables the harmonic for measurement.

| :- | :- | :- | |harmonicMeasurementInterval|float64[]|Specifies the array of acquisition times, in seconds, for the harmonic. | |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

| :- | :- | :- |

OBW Configure

RFmxSpecAn_OBWCfgSpan

int32 __stdcall RFmxSpecAn_OBWCfgSpan (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 span);

Purpose

Configures the frequency range, in Hz, around the center frequency, to acquire for the measurement.

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.
span float64 Specifies the frequency range, in Hz, around the center frequency, to acquire for the measurement.

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_OBWCfgBandwidthPercentage

int32 __stdcall RFmxSpecAn_OBWCfgBandwidthPercentage (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 bandwidthPercentage);

Purpose

Configures the percentage of the total power that is contained in the occupied bandwidth (OBW).

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.
bandwidthPercentage float64 Specifies the percentage of the total power that is contained in the OBW.

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_OBWCfgPowerUnits

int32 __stdcall RFmxSpecAn_OBWCfgPowerUnits (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 powerUnits);

Purpose

Configures the units for the absolute power.

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.
powerUnits int32 Specifies the units for the absolute power.
RFMXSPECAN_VAL_OBW_POWER_UNITS_DBM (0) The absolute powers are reported in dBm.
RFMXSPECAN_VAL_OBW_POWER_UNITS_DBM_PER_HZ (1) The absolute powers are reported in dBm/Hz.

| :- | :- | :- |

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_OBWCfgRBWFilter

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

Purpose

Configures the resolution bandwidth (RBW) filter.

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.
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_OBW_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_OBW_RBW_AUTO_TRUE (1) The measurement computes the RBW.

| :- | :- | :- | |RBW|float64|Specifies the bandwidth, in Hz, of the RBW filter used to sweep the acquired carrier signal, when you set the RBWAuto parameter to RFMXSPECAN_VAL_OBW_RBW_AUTO_FALSE.| |RBWFilterType|int32|Specifies the shape of the digital RBW filter. |

RFMXSPECAN_VAL_OBW_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_OBW_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_OBW_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_OBW_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_OBW_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_OBWCfgSweepTime

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

Purpose

Configures the sweep time.

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.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXSPECAN_VAL_OBW_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXSPECAN_VAL_OBW_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_OBW_RBW_FILTER_BANDWIDTH attribute.

| :- | :- | :- | |sweepTimeInterval|float64|Specifies the sweep time, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_OBW_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_OBWCfgAveraging

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

Purpose

Configures averaging for the occupied bandwidth (OBW) measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_OBW_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_OBW_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_OBW_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_OBW_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_OBW_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithm scale.
RFMXSPECAN_VAL_OBW_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_OBW_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_OBW_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_OBWCfgFFT

int32 __stdcall RFmxSpecAn_OBWCfgFFT (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 FFTWindow, float64 FFTPadding);

Purpose

Configures window and FFT to obtain a spectrum for the occupied bandwidth (OBW) measurement.

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.
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_OBW_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_OBW_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_OBW_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_OBW_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_OBW_FFT_WINDOW_GAUSSIAN (4) Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
RFMXSPECAN_VAL_OBW_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_OBW_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_OBW_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

| :- | :- | :- | |FFTPadding|float64|Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula: waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth of the device.|

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

| :- | :- | :- |

SEM Configure

RFmxSpecAn_SEMCfgNumberOfCarriers

int32 __stdcall RFmxSpecAn_SEMCfgNumberOfCarriers (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfCarriers);

Purpose

Configures the number of carriers for the spectral emission mask (SEM) measurement.

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.
numberOfCarriers int32 Specifies the number of carriers.

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_SEMCfgCarrierEnabled

int32 __stdcall RFmxSpecAn_SEMCfgCarrierEnabled (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 carrierEnabled);

Purpose

Configures whether to consider the carrier power as part of total carrier power measurement.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
carrierEnabled int32 Specifies whether to consider the carrier power as part of total carrier power measurement.
RFMXSPECAN_VAL_SEM_ENABLED_FALSE (0) The carrier power is not considered as part of the total carrier power.
RFMXSPECAN_VAL_SEM_ENABLED_TRUE (1) The carrier power is considered as part of the total carrier power.

| :- | :- | :- |

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_SEMCfgCarrierFrequency

int32 __stdcall RFmxSpecAn_SEMCfgCarrierFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 carrierFrequency);

Purpose

Configures the center frequency, in hertz (Hz), of the carrier, relative to the RF center frequency.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used. Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
carrierFrequency float64 Specifies the center frequency, in hertz (Hz), of the carrier, relative to the RF center 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_SEMCfgCarrierChannelBandwidth

int32 __stdcall RFmxSpecAn_SEMCfgCarrierFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[],float64 carrierChannelBandwidth);

Purpose

Configures the channel bandwidth of the carrier.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used. Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
carrierChannelBandwidth float64 Specifies the channel bandwidth of the carrier. It is used to calculate the values of the RFMXSPECAN_ATTR_SEM_OFFSET_START_FREQUENCY attribute to RFMXSPECAN_VAL_SEM_CARRIER_EDGE_TO_MEASUREMENT_BANDWIDTH_CENTER or RFMXSPECAN_VAL_SEM_CARRIER_EDGE_TO_MEASUREMENT_BANDWIDTH_EDGE.

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_SEMCfgCarrierIntegrationBandwidth

int32 __stdcall RFmxSpecAn_SEMCfgCarrierIntegrationBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 integrationBandwidth);

Purpose

Configures the frequency range, in hertz (Hz), over which the measurement integrates the carrier power.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
integrationBandwidth float64 Specifies the frequency range, in Hz, over which the measurement integrates the carrier power.

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_SEMCfgCarrierRBWFilter

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

Purpose

Configures the resolution bandwidth (RBW) filter of the carrier signal.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
RBWAuto int32 Specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the SEM topic for more information about RBW and sweep time.
RFMXSPECAN_VAL_SEM_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_SEM_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 carrier signal, when you set the RBWAuto parameter to RFMXSPECAN_VAL_SEM_RBW_AUTO_FALSE.| |RBWFilterType|int32|Specifies the shape of the digital RBW filter. |

RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_SEM_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_SEMCfgCarrierRRCFilter

int32 __stdcall RFmxSpecAn_SEMCfgCarrierRRCFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 RRCFilterEnabled, float64 RRCAlpha);

Purpose

Configures the root raised cosine (RRC) channel filter to apply on the acquired carrier channel before measuring the channel power. RRC alpha is the filter roll off.

Use "carrier<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 and carrier number. If you do not specify the signal name, the default signal instance is used.

Example:

"carrier0"

"signal::sig1/carrier0"

You can use the RFmxSpecAn_BuildCarrierString2.
RRCFilterEnabled int32 Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_FALSE (0) The channel power of the acquired carrier channel is measured directly.
RFMXSPECAN_VAL_ACP_RRC_FILTER_ENABLED_TRUE (1) The RRC filter is applied on the acquired carrier channel before measuring the carrier channel power.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_SEMCfgNumberOfOffsets

int32 __stdcall RFmxSpecAn_SEMCfgNumberOfOffsets (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfOffsets);

Purpose

Configures the number of offset segments for the spectral emission mask (SEM) measurement.

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.
numberOfOffsets int32 Specifies the number of offset segments.

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_SEMCfgOffsetFrequency

int32 __stdcall RFmxSpecAn_SEMCfgOffsetFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetStartFrequency, float64 offsetStopFrequency, int32 offsetEnabled, int32 offsetSideband);

Purpose

Configures the offset frequency start and stop values and specifies whether the offset segment is present on one side, or on both sides of the carriers.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used. Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
offsetStartFrequency float64 Specifies the start frequency, in hertz (Hz), of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the RFMXSPECAN_ATTR_SEM_OFFSET_FREQUENCY_DEFINITION attribute.
offsetStopFrequency float64 Specifies the stop frequency, in hertz (Hz), of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the RFMXSPECAN_RANGE_TABLE_SEM_OFFSET_FREQUENCY_DEFINITION attribute.
offsetEnabled int32 Specifies whether to enable the offset segment for the SEM measurement.
RFMXSPECAN_VAL_SEM_OFFSET_ENABLED_FALSE (0) Disables the offset segment for the SEM measurement.
RFMXSPECAN_VAL_SEM_OFFSET_ENABLED_TRUE (1) Enables the offset segment for the SEM measurement.

| :- | :- | :- | |offsetSideband|int32|Specifies whether the offset segment is present on one side, or on both sides of the carriers. |

RFMXSPECAN_VAL_SEM_OFFSET_SIDEBAND_NEGATIVE (0) Configures a lower offset segment to the left of the leftmost carrier.
RFMXSPECAN_VAL_SEM_OFFSET_SIDEBAND_POSITIVE (1) Configures a lower offset segment to the left of the rightmost carrier.
RFMXSPECAN_VAL_SEM_OFFSET_SIDEBAND_BOTH (2) Configures both negative and positive offset segments.

| :- | :- | :- |

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_SEMCfgOffsetRBWFilter

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

Purpose

Configures the resolution bandwidth (RBW) filter of the offset segment.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
RBWAuto int32 Specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the SEM topic for more information about RBW and sweep time.
RFMXSPECAN_VAL_SEM_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_SEM_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_SEM_RBW_AUTO_FALSE.| |RBWFilterType|int32|Specifies the shape of the digital RBW filter. |

RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_SEM_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_SEMCfgOffsetBandwidthIntegral

int32 __stdcall RFmxSpecAn_SEMCfgOffsetBandwidthIntegral (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 bandwidthIntegral);

Purpose

Configures the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the resolution bandwidth (RBW).

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
bandwidthIntegral int32 Specifies the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the RBW. If you set this parameter to a value greater than 1, the measurement acquires the spectrum with a narrow resolution and then processes it digitally to get a wider resolution that is equal to the product of the bandwidth integral and the RBW.

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_SEMCfgOffsetRelativeAttenuation

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

Purpose

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

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
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_SEMCfgOffsetLimitFailMask

int32 __stdcall RFmxSpecAn_SEMCfgOffsetLimitFailMask (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 limitFailMask);

Purpose

Specifies the criteria to determine the measurement fail status.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
limitFailMask int32 Specifies the criteria to determine the measurement fail status.
RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_ABSOLUTE_AND_RELATIVE (0) The measurement fails if the power in the segment exceeds both the absolute and relative masks.
RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_ABSOLUTE_OR_RELATIVE (1) The measurement fails if the power in the segment exceeds either the absolute or relative mask.
RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_ABSOLUTE (2) The measurement fails if the power in the segment exceeds the absolute mask.
RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_RELATIVE (3) The measurement fails if the power in the segment exceeds the relative mask.

| :- | :- | :- |

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_SEMCfgOffsetAbsoluteLimit

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

Purpose

Configures the absolute limit mode and specifies the absolute power limits corresponding to the beginning and end of the offset segment.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
absoluteLimitMode int32 Specifies whether the absolute limit mask is a flat line or a line with a slope.
RFMXSPECAN_VAL_SEM_OFFSET_ABSOLUTE_LIMIT_MODE_MANUAL (0) The line specified by the RFMXSPECAN_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_START attribute values as the two ends is considered as the mask.
RFMXSPECAN_VAL_SEM_OFFSET_ABSOLUTE_LIMIT_MODE_COUPLE (1) The two ends of the line are coupled to the value of the RFMXSPECAN_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_START attribute.

| :- | :- | :- | |absoluteLimitStart|float64|Specifies the absolute power limit, in dBm, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SEM_OFFSET_ABSOLUTE_LIMIT_MODE_COUPLE.| |absoluteLimitStop|float64|Specifies the absolute power limit, in dBm, corresponding to the end of the offset segment. This parameter is ignored when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SEM_OFFSET_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_SEMCfgOffsetFrequencyDefinition

int32 __stdcall RFmxSpecAn_SEMCfgOffsetFrequencyDefinition (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 offsetFrequencyDefinition);

Purpose

Configures the offset frequency definition for the SEM measurement.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
offsetFrequencyDefinition int32 Specifies the definition of the start frequency and stop frequency of the offset segments from the nearest carrier channels.
RFMXSPECAN_VAL_SEM_CARRIER_CENTER_TO_MEASUREMENT_BANDWIDTH_CENTER (0) The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the center of the offset segment measurement bandwidth. Measurement Bandwidth = Resolution Bandwidth * Bandwidth Integral.
RFMXSPECAN_VAL_SEM_CARRIER_CENTER_TO_MEASUREMENT_BANDWIDTH_EDGE (1) The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the nearest edge of the offset segment measurement bandwidth.
RFMXSPECAN_VAL_SEM_CARRIER_EDGE_TO_MEASUREMENT_BANDWIDTH_CENTER (2) The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the center of the nearest offset segment measurement bandwidth.
RFMXSPECAN_VAL_SEM_CARRIER_EDGE_TO_MEASUREMENT_BANDWIDTH_EDGE (3) The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the edge of the nearest offset segment measurement bandwidth.

| :- | :- | :- |

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_SEMCfgOffsetRelativeLimit

int32 __stdcall RFmxSpecAn_SEMCfgOffsetRelativeLimit (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 relativeLimitMode, float64 relativeLimitStart, float64 relativeLimitStop);

Purpose

Configures the relative limit mode and specifies the relative power limits corresponding to the beginning and end of the offset segment.

Use "offset<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 and offset number. If you do not specify the signal name, the default signal instance is used.

Example:

"offset0"

"signal::sig1/offset0"

You can use the RFmxSpecAn_BuildOffsetString2.
relativeLimitMode int32 Specifies whether the relative limit mask is a flat line or a line with a slope.
RFMXSPECAN_VAL_SEM_OFFSET_RELATIVE_LIMIT_MODE_MANUAL (0) The line specified by the RFMXSPECAN_ATTR_SEM_OFFSET_RELATIVE_LIMIT_START attribute values as the two ends is considered as the mask.
RFMXSPECAN_VAL_SEM_OFFSET_RELATIVE_LIMIT_MODE_COUPLE (1) The two ends of the line are coupled to the value of the RFMXSPECAN_ATTR_SEM_OFFSET_RELATIVE_LIMIT_START attribute.

| :- | :- | :- | |relativeLimitStart|float64|Specifies the relative power limit, in dB, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the relativeLimitMode parameter to RFMXSPECAN_VAL_SEM_RELATIVE_LIMIT_MODE_COUPLE. | |relativeLimitStop|float64|Specifies the relative power limit, in dB, corresponding to the end of the offset segment. This parameter is ignored if you set the relativeLimitMode parameter to RFMXSPECAN_VAL_SEM_RELATIVE_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_SEMCfgPowerUnits

int32 __stdcall RFmxSpecAn_SEMCfgPowerUnits (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 powerUnits);

Purpose

Configures the units for the absolute power.

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.
powerUnits int32 Specifies the units for the absolute power.
RFMXSPECAN_VAL_SEM_POWER_UNITS_DBM (0) The absolute powers are reported in dBm.
RFMXSPECAN_VAL_SEM_POWER_UNITS_DBM_PER_HZ (1) The absolute powers are reported in dBm/Hz.

| :- | :- | :- |

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_SEMCfgReferenceType

int32 __stdcall RFmxSpecAn_SEMCfgReferenceType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 referenceType);

Purpose

Configures whether the power reference is the integrated power or the peak power in the closest carrier channel.

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.
referenceType int32 Specifies whether the power reference is the integrated power or the peak power in the closest carrier channel. The leftmost carrier is the carrier closest to all the lower (negative) offset segments. The rightmost carrier offset is the carrier closest to all the upper (positive) offset segments.
RFMXSPECAN_VAL_SEM_REFERENCE_TYPE_INTEGRATION (0) The power reference is the integrated power of the closest carrier.
RFMXSPECAN_VAL_SEM_REFERENCE_TYPE_PEAK (1) The power reference is the peak power of the closest carrier.

| :- | :- | :- |

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_SEMCfgSweepTime

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

Purpose

Configures the sweep time.

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.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXSPECAN_VAL_SEM_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXSPECAN_VAL_SEM_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_SEM_OFFSET_RBW_FILTER_BANDWIDTH attributes.

| :- | :- | :- | |sweepTimeInterval|float64|Specifies the sweep time, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_SEM_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_SEMCfgAveraging

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

Purpose

Configures averaging for the spectral emission mask (SEM) measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_SEM_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_SEM_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_SEM_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_SEM_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_SEM_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithm scale.
RFMXSPECAN_VAL_SEM_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_SEM_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_SEM_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_SEMCfgFFT

int32 __stdcall RFmxSpecAn_SEMCfgFFT (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 FFTWindow, float64 FFTPadding);

Purpose

Configures the FFT window and padding to obtain a spectrum for the spectral emission mask (SEM) measurement.

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.
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_SEM_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_SEM_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_SEM_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_SEM_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_SEM_FFT_WINDOW_GAUSSIAN (4) Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
RFMXSPECAN_VAL_SEM_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_SEM_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_SEM_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

| :- | :- | :- | |FFTPadding|float64|Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula: waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth of the device.|

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

| :- | :- | :- |

SEM Array Apis

RFmxSpecAn_SEMCfgOffsetFrequencyArray

int32 __stdcall RFmxSpecAn_SEMCfgOffsetFrequencyArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetStartFrequency[], float64 offsetStopFrequency[], int32 offsetEnabled[], int32 offsetSideband[], int32 numberOfElements);

Purpose

Configures the offset frequency start and stop values and specifies whether the offset segment is present on one side, or on both sides of the carriers.

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.
offsetStartFrequency float64[] Specifies the array of start frequencies, in hertz (Hz), of each offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the RFMXSPECAN_ATTR_SEM_OFFSET_FREQUENCY_DEFINITION attribute. Specify NULL if you do not want to set a value for this array.
offsetStopFrequency float64[] Specifies the array of stop frequencies, in hertz (Hz), of each offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the RFMXSPECAN_RANGE_TABLE_SEM_OFFSET_FREQUENCY_DEFINITION attribute. Specify NULL if you do not want to set a value for this array.
offsetEnabled int32[] Specifies whether to enable the offset segment for the SEM measurement. Specify NULL if you do not want to set a value for this array.
RFMXSPECAN_VAL_SEM_OFFSET_ENABLED_FALSE (0) Disables the offset segment for the SEM measurement.
RFMXSPECAN_VAL_SEM_OFFSET_ENABLED_TRUE (1) Enables the offset segment for the SEM measurement.

| :- | :- | :- | |offsetSideband|int32[]|Specifies whether the offset segment is present on one side, or on both sides of the carriers. Specify NULL if you do not want to set a value for this array. |

RFMXSPECAN_VAL_SEM_OFFSET_SIDEBAND_NEGATIVE (0) Configures a lower offset segment to the left of the leftmost carrier.
RFMXSPECAN_VAL_SEM_OFFSET_SIDEBAND_POSITIVE (1) Configures an upper offset segment to the right of the rightmost carrier.
RFMXSPECAN_VAL_SEM_OFFSET_SIDEBAND_BOTH (2) Configures both negative and positive offset segments.

| :- | :- | :- | |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_SEMCfgOffsetRBWFilterArray

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

Purpose

Configures the resolution bandwidth (RBW) filter of the offset segment.

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.
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 SEM 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_SEM_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_SEM_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 offset segment, when you set the RBWAuto parameter to RFMXSPECAN_VAL_SEM_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_SEM_RBW_FILTER_TYPE_FFTBASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_SEM_RBW_FILTER_TYPE_SYNCHTUNED4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_SEM_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_SEMCfgOffsetRelativeAttenuationArray

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

Purpose

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

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.
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_SEMCfgOffsetAbsoluteLimitArray

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

Purpose

Configures the absolute limit mode and specifies the absolute power limits corresponding to the beginning and end of the offset segment.

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.
absoluteLimitMode int32[] Specifies whether the absolute limit mask 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_SEM_OFFSET_ABSOLUTE_LIMIT_MODE_MANUAL (0) The line specified by the RFMXSPECAN_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_START attribute values as the two ends is considered as the mask.
RFMXSPECAN_VAL_SEM_OFFSET_ABSOLUTE_LIMIT_MODE_COUPLE (1) The two ends of the line are coupled to the value of the RFMXSPECAN_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_START attribute.

| :- | :- | :- | |absoluteLimitStart|float64[]|Specifies the absolute power limit, in dBm, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SEM_OFFSET_ABSOLUTE_LIMIT_MODE_COUPLE. Specify NULL if you do not want to set a value for this array.| |absoluteLimitStop|float64[]|Specifies the absolute power limit, in dBm, corresponding to the end of the offset segment. This parameter is ignored when you set the absoluteLimitMode parameter to RFMXSPECAN_VAL_SEM_OFFSET_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_SEMCfgOffsetRelativeLimitArray

int32 __stdcall RFmxSpecAn_SEMCfgOffsetRelativeLimitArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 relativeLimitMode[], float64 relativeLimitStart[], float64 relativeLimitStop[], int32 numberOfElements);

Purpose

Configures the relative limit mode and specifies the relative power limits corresponding to the beginning and end of the offset segment.

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.
relativeLimitMode int32[] Specifies whether the relative limit mask 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_SEM_RELATIVE_LIMIT_MODE_MANUAL (0) The line specified by the RFMXSPECAN_ATTR_SEM_OFFSET_RELATIVE_LIMIT_START attribute values as the two ends is considered as the mask.
RFMXSPECAN_VAL_SEM_RELATIVE_LIMIT_MODE_COUPLE (1) The two ends of the line are coupled to the value of the RFMXSPECAN_ATTR_SEM_OFFSET_RELATIVE_LIMIT_START attribute.

| :- | :- | :- | |relativeLimitStart|float64[]|Specifies the array of relative power limits, in dB, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the relativeLimitMode parameter to RFMXSPECAN_VAL_SEM_RELATIVE_LIMIT_MODE_COUPLE. Specify NULL if you do not want to set a value for this array.| |relativeLimitStop|float64[]|Specifies the array of relative power limits, in dB, corresponding to the end of the offset segment. This parameter is ignored if you set the relativeLimitMode parameter to RFMXSPECAN_VAL_SEM_RELATIVE_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

| :- | :- | :- |

Spectrum Configure

RFmxSpecAn_SpectrumCfgSpan

int32 __stdcall RFmxSpecAn_SpectrumCfgSpan (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 span);

Purpose

Configures the frequency range, in hertz (Hz), around the center frequency, to acquire for the spectrum measurement.

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.
span float64 Specifies the frequency range, in hertz (Hz), around the center frequency, to acquire for the measurement.

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_SpectrumCfgFrequencyStartStop

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

Purpose

Configures the start frequency and stop frequency for the spectrum measurement.

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.
startFrequency float64 Specifies the start frequency, in hertz (Hz), for the spectrum measurement.
stopFrequency float64 Specifies the stop frequency, in Hz, for the spectrum measurement.

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_SpectrumCfgPowerUnits

int32 __stdcall RFmxSpecAn_SpectrumCfgPowerUnits (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 spectrumPowerUnits);

Purpose

Configures the units for the absolute power.

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.
spectrumPowerUnits int32 Specifies the units for the absolute power.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_DBM (0) The absolute powers are reported in dBm.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_DBM_PER_HZ (1) The absolute powers are reported in dBm/Hz.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_DBW (2) The absolute powers are reported in dBW.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_DBV (3) The absolute powers are reported in dBV.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_DBMV (4) The absolute powers are reported in dBmV.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_DBUV (5) The absolute powers are reported in dBuV.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_WATTS (6) The absolute powers are reported in W.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_VOLTS (7) The absolute powers are reported in volts.
RFMXSPECAN_VAL_SPECTRUM_POWER_UNITS_VOLTS_SQUARED (8) The absolute powers are reported in volts2.

| :- | :- | :- |

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_SpectrumCfgRBWFilter

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

Purpose

Configures the resolution bandwidth (RBW) filter.

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.
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_SPECTRUM_RBW_AUTO_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_SPECTRUM_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 carrier signal, when you set the RBWAuto parameter to RFMXSPECAN_VAL_SPECTRUM_RBW_AUTO_FALSE. | |RBWFilterType|int32|Specifies the shape of the digital RBW filter. |

RFMXSPECAN_VAL_SPECTRUM_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_SPECTRUM_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_SPECTRUM_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_SPECTRUM_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_SPECTRUM_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_SpectrumCfgSweepTime

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

Purpose

Configures the sweep time.

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.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXSPECAN_VAL_SPECTRUM_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXSPECAN_VAL_SPECTRUM_SWEEP_TIME_AUTO_TRUE (1) The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_SPECTRUM_RBW_FILTER_BANDWIDTH attribute.

| :- | :- | :- | |sweepTimeInterval|float64|Specifies the sweep time, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_SPECTRUM_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_SpectrumCfgAveraging

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

Purpose

Configures averaging for the spectrum measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_SPECTRUM_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_SPECTRUM_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_SPECTRUM_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_SPECTRUM_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_SPECTRUM_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithm scale.
RFMXSPECAN_VAL_SPECTRUM_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXSPECAN_VAL_SPECTRUM_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXSPECAN_VAL_SPECTRUM_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_SpectrumCfgFFT

int32 __stdcall RFmxSpecAn_SpectrumCfgFFT (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 FFTWindow, float64 FFTPadding);

Purpose

Configures window and FFT to obtain a spectrum for the spectrum measurement.

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.
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_SPECTRUM_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_SPECTRUM_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_SPECTRUM_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_SPECTRUM_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_SPECTRUM_FFT_WINDOW_GAUSSIAN (4) Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
RFMXSPECAN_VAL_SPECTRUM_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_SPECTRUM_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_SPECTRUM_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

| :- | :- | :- | |FFTPadding|float64|Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula: waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth of the device.|

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_SpectrumCfgNoiseCompensationEnabled

int32 __stdcall RFmxSpecAn_SpectrumCfgNoiseCompensationEnabled (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 noiseCompensationEnabled);

Purpose

Configures compensation of the spectrum for the inherent noise floor of the signal analyzer.

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.
noiseCompensationEnabled int32

Specifies whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer.

Supported Devices: PXIe-5663/5665/5668, PXIe-5830/5831/5832

RFMXSPECAN_VAL_SPECTRUM_NOISE_COMPENSATION_ENABLED_FALSE (0) Disables compensation of the spectrum for the noise floor of the signal analyzer.
RFMXSPECAN_VAL_SPECTRUM_NOISE_COMPENSATION_ENABLED_TRUE (1) Enables compensation of the spectrum for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the Spectrum measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again.

| :- | :- | :- |

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_SpectrumCfgDetector

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

Purpose

Configures 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.
detectorType int32 Specifies the type of detector to be used.
RFMXSPECAN_VAL_SPECTRUM_DETECTOR_TYPE_NONE (0) The detector is disabled.
RFMXSPECAN_VAL_SPECTRUM_DETECTOR_TYPE_SAMPLE (1) The central point in the bucket is detected.
RFMXSPECAN_VAL_SPECTRUM_DETECTOR_TYPE_NORMAL (2) The maximum and minimum values of the samples are detected in alternate buckets.
RFMXSPECAN_VAL_SPECTRUM_DETECTOR_TYPE_PEAK (3) The maximum value of the samples in the bucket is detected.
RFMXSPECAN_VAL_SPECTRUM_DETECTOR_TYPE_NEGATIVE_PEAK (4) The minimum value of the samples in the bucket is detected.
RFMXSPECAN_VAL_SPECTRUM_DETECTOR_TYPE_AVERAGE_RMS (5) The average RMS of all the samples in the bucket is detected.
RFMXSPECAN_VAL_SPECTRUM_DETECTOR_TYPE_AVERAGE_VOLTAGE (6) The average voltage of all the samples in the bucket is detected.
RFMXSPECAN_VAL_SPECTRUM_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_SpectrumCfgVBWFilter

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

Purpose

Configures the VBW settings including VBW Auto, VBW(Hz) and VBW to RBW ratio.

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.
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_SPECTRUM_VBW_FILTER_AUTO_BANDWIDTH_False (0) Specify the video bandwidth in the VBW parameter. The VBWToRBWRatio parameter is disregarded in this mode.
RFMXSPECAN_VAL_SPECTRUM_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_SPECTRUM_VBW_FILTER_VBW_TO_RBW_RATIO attribute and the RFMXSPECAN_ATTR_SPECTRUM_RBW_FILTER_AUTO_BANDWIDTH attribute. The value of the VBW parameter is disregarded in this mode.

| :- | :- | :- | |VBW|float64|Specifies the video bandwidth when you set the VBWAuto parameter RFMXSPECAN_VAL_SPECTRUM_VBW_FILTER_AUTO_BANDWIDTH_False. This value is expressed in Hz. | |VBWToRBWRatio|float64|Specifies the VBW to RBW Ratio when you set the VBWAuto parameter to RFMXSPECAN_VAL_SPECTRUM_VBW_FILTER_AUTO_BANDWIDTH_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

| :- | :- | :- |

RFmxSpecAn_SpectrumValidateNoiseCalibrationData

int32 __stdcall RFmxSpecAn_SpectrumValidateNoiseCalibrationData (niRFmxInstrHandle instrumentHandle, char selectorString[], int32* noiseCalibrationDataValid);

Purpose

Indicates whether calibration data is valid for the configuration specified by the signal name in the selectorString parameter.

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.
Output
Name Type Description
noiseCalibrationDataValid int32* Returns whether the calibration data is valid.

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 Configure

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.
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.
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.
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.
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.
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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 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.
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.
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.
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.
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.
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

| :- | :- | :- |

TXP Configure

RFmxSpecAn_TXPCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_TXPCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Specifies the acquisition time, in seconds, for the transmit power (TXP) measurement.

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.
measurementInterval float64 Specifies the acquisition time, in seconds, for the measurement.

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_TXPCfgRBWFilter

int32 __stdcall RFmxSpecAn_TXPCfgRBWFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 RBW, int32 RBWFilterType, float64 RRCAlpha);

Purpose

Configures the resolution bandwidth (RBW) filter to measure the power of the signal as seen through this filter.

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.
RBW float64 Specifies the bandwidth, in hertz (Hz), of the RBW filter used to measure the signal.
RBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_NONE (5) The measurement does not use any RBW filtering.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_GAUSSIAN (1) The RBW filter has a Gaussian response.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_FLAT (2) The RBW filter has a flat response.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) The RBW filter has a response of a 4-pole synchronously-tuned filter.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_SYNCH_TUNED_5 (4) The RBW filter has a response of a 5-pole synchronously-tuned filter.
RFMXSPECAN_VAL_TXP_RBW_FILTER_TYPE_RRC (6) The RRC filter with the roll-off specified by RRCAlpha parameter is used as the RBW filter.

| :- | :- | :- | |RRCAlpha|float64|Specifies the roll-off factor for the root-raised-cosine (RRC) filter. |

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_TXPCfgThreshold

int32 __stdcall RFmxSpecAn_TXPCfgThreshold (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 thresholdEnabled, float64 thresholdLevel, int32 thresholdType);

Purpose

Configures the threshold level for the samples that need to be considered for the transmit power (TXP) measurement. Enable the threshold when analyzing burst signals or signals with dead time.

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.
thresholdEnabled int32 Specifies whether to enable thresholding of the acquired samples to be used for the measurement.
RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the measurement.
RFMXSPECAN_VAL_TXP_THRESHOLD_ENABLED_TRUE (1) The samples above the threshold level specified in the thresholdLevel parameter are considered for the measurement.

| :- | :- | :- | |thresholdLevel|float64|Specifies either the relative or absolute threshold power level based on the value of the thresholdType parameter. | |thresholdType|int32|Specifies the reference for the power level used for thresholding. |

RFMXSPECAN_VAL_TXP_THRESHOLD_TYPE_RELATIVE (0) The threshold is relative to the peak power, in dB, of the acquired samples.
RFMXSPECAN_VAL_TXP_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

| :- | :- | :- |

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_TXPCfgAveraging

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

Purpose

Configures averaging for the transmit power (TXP) measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_TXP_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_TXP_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_TXP_AVERAGING_ENABLED_TRUE.| |averagingType|int32|Specifies the averaging type for averaging the power over multiple acquisitions. The averaged power trace is used for the measurement. Refer to the Averaging section of the Spectrum topic for more information about averaging types. |

RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_RMS (0) The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_LOG (1) The power trace is averaged in a logarithm scale.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_SCALAR (2) The square root of the power trace is averaged.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_MAXIMUM (3) The peak power in the power trace at each sample instance is retained from one acquisition to the next.
RFMXSPECAN_VAL_TXP_AVERAGING_TYPE_MINIMUM (4) The least power in the power trace at each sample instance 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_TXPCfgVBWFilter

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

Purpose

Configures VBW settings including the VBW mode, video bandwidth (VBW), and the VBW to RBW ratio.

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.
VBWAuto int32 specifies whether the VBW is expressed directly or computed based on VBW to RBW ratio. The default value is True.
RFMXSPECAN_VAL_TXP_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_TXP_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_TXP_VBW_FILTER_VBW_TO_RBW_RATIO attribute and the TXP RBW attribute. The value of the TXP VBW attribute is disregarded in this mode.

| :- | :- | :- | |VBW|float64|specifies the video bandwidth when you set the VBW Auto parameter to False. This value is expressed in Hz. The default value is 30KHz. | |VBWToRBWRatio|float64|Specifies the VBW to RBW Ratio when you set the VBW Auto parameter to True. The default value is 3.|

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

| :- | :- | :- |

AMPM Configure

RFmxSpecAn_AMPMCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_AMPMCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Configures the acquisition time, in seconds, for the AMPM measurement.

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.
measurementInterval float64 Specifies the duration, in seconds, of the reference waveform considered for the AMPM measurement. When the reference waveform contains an idle duration, the AMPM measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform.

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_AMPMCfgMeasurementSampleRate

int32 __stdcall RFmxSpecAn_AMPMCfgMeasurementSampleRate (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sampleRateMode, float64 sampleRate);

Purpose

Configures the acquisition sample rate, in samples per second (S/s), for the AMPM measurement.

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.
sampleRateMode int32 Specifies whether the acquisition sample rate is based on the reference waveform.
RFMXSPECAN_VAL_AMPM_MEASUREMENT_SAMPLE_RATE_MODE_USER (0) The acquisition sample rate is defined by the value of the sampleRate parameter.
RFMXSPECAN_VAL_AMPM_MEASUREMENT_SAMPLE_RATE_MODE_REFERENCE_WAVEFORM (1) The acquisition sample rate is set to match the sample rate of the reference waveform.

| :- | :- | :- | |sampleRate|float64|Specifies the acquisition sample rate, in S/s, when you set the sampleRateMode parameter to RFMXSPECAN_VAL_AMPM_MEASUREMENT_SAMPLE_RATE_MODE_USER.|

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_AMPMCfgSynchronizationMethod

int32 __stdcall RFmxSpecAn_AMPMCfgSynchronizationMethod (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 synchronizationMethod);

Purpose

Configures the synchronization method used to synchronize the reference waveform and acquired waveform.

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.
synchronizationMethod int32 Specifies the method used for synchronization of acquired waveform with reference waveform.
RFMXSPECAN_VAL_AMPM_SYNCHRONIZATION_METHOD_DIRECT (0) Synchronizes the acquired and reference waveforms assuming that sample rate is sufficient to prevent aliasing in intermediate operations. This method is recommended when the measurement sampling rate is high.
RFMXSPECAN_VAL_AMPM_SYNCHRONIZATION_METHOD_ALIAS_PROTECTED (1) Synchronizes the acquired and reference waveforms while ascertaining that intermediate operations are not impacted by aliasing. This method is recommended for non-contiguous carriers separated by a large gap, and/or when the measurement sampling rate is low. Refer to AMPM concept help for more information.

| :- | :- | :- |

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_AMPMCfgDUTAverageInputPower

int32 __stdcall RFmxSpecAn_AMPMCfgDUTAverageInputPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 DUTAverageInputPower);

Purpose

Configures the average power, in dBm, of the signal at the device under test (DUT) input port.

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.
DUTAverageInputPower float64 Specifies the average power, in dBm, of the signal at the DUT input port.

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_AMPMCfgReferenceWaveform

int32 __stdcall RFmxSpecAn_AMPMCfgReferenceWaveform (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0, float64 dx, NIComplexSingle referenceWaveform[], int32 arraySize, int32 idleDurationPresent, int32 signalType);

Purpose

Configures the reference waveform and its properties for the AMPM measurement.

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.
x0 float64 Specifies the start time, in seconds.
dx float64 Specifies the sample duration, in seconds.
referenceWaveform NIComplexSingle[] Specifies the complex baseband samples, in volts.
arraySize int32 Specifies the size of the referenceWaveform array.
idleDurationPresent int32 Specifies whether the reference waveform contains an idle duration.
RFMXSPECAN_VAL_AMPM_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_FALSE (0) The reference waveform does not contain an idle duration.
RFMXSPECAN_VAL_AMPM_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_TRUE (1) The reference waveform contains an idle duration.

| :- | :- | :- | |signalType|int32|Specifies whether the reference waveform is a modulated signal or tones. |

RFMXSPECAN_VAL_AMPM_SIGNAL_TYPE_MODULATED (0) The reference waveform is a cellular or connectivity standard signal.
RFMXSPECAN_VAL_AMPM_SIGNAL_TYPE_TONES (1) The reference waveform is a continuous signal of one or more tones.

| :- | :- | :- |

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_AMPMCfgReferenceWaveformSplit

int32 __stdcall RFmxSpecAn_AMPMCfgReferenceWaveformSplit (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0, float64 dx, float32 I[], float32 Q[], int32 arraySize, int32 idleDurationPresent, int32 signalType);

Purpose

Configures the reference waveform and its attributes for the AMPM measurement.

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.
x0 float64 Specifies the start time, in seconds.
dx float64 Specifies the sample duration, in seconds.
I float32[] Specifies the real part of complex baseband samples, in volts.
Q float32[] Specifies the imaginary part of complex baseband samples, in volts.
arraySize int32 Specifies the size of I and Q array.
idleDurationPresent int32 Specifies whether the reference waveform contains an idle duration.
RFMXSPECAN_VAL_AMPM_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_FALSE (0) The reference waveform does not contain an idle duration.
RFMXSPECAN_VAL_AMPM_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_TRUE (1) The reference waveform contains an idle duration.

| :- | :- | :- | |signalType|int32|Specifies whether the reference waveform is a modulated signal or tones. |

RFMXSPECAN_VAL_AMPM_SIGNAL_TYPE_MODULATED (0) The reference waveform is a cellular or connectivity standard signal.
RFMXSPECAN_VAL_AMPM_SIGNAL_TYPE_TONES (1) The reference waveform is a continuous signal of one or more tones.

| :- | :- | :- |

Return Value

Name Type Description

RFmxSpecAn_AMPMCfgReferencePowerType

int32 __stdcall RFmxSpecAn_AMPMCfgReferencePowerType" (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 referencePowerType);

Purpose

Configures reference power used for AM to AM and AM to PM traces.

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.
averagingEnabled int32 Specifies the reference power used for AM to AM and AM to PM traces. The default value is Input.
RFMXSPECAN_VAL_AMPM_REFERENCE_POWER_TYPE_INPUT (0) The instantaneous powers at the input port of device under test (DUT) forms the x-axis of AM to AM and AM to PM traces.
RFMXSPECAN_VAL_AMPM_REFERENCE_POWER_TYPE_OUTPUT (1) The instantaneous powers at the output port of DUT forms the x-axis of AM to AM and AM to PM traces.

| :- | :- | :- |

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_AMPMCfgAMToAMCurveFit

int32 __stdcall RFmxSpecAn_AMPMCfgAMToAMCurveFit (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 AMToAMCurveFitOrder, int32 AMToAMCurveFitType);

Purpose

Configures the degree of the polynomial and the cost-function for approximating the measured AM-to-AM response of the device under test (DUT).

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.
AMToAMCurveFitOrder int32 Specifies the degree of the polynomial used to approximate the AM-to-AM characteristic of the device under test.
AMToAMCurveFitType int32 Specifies the polynomial approximation cost-function of the device under test AM-to-AM characteristic.
RFMXSPECAN_VAL_AMPM_AM_TO_AM_CURVE_FIT_TYPE_LEAST_SQUARE (0) Minimizes the energy of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_AM_CURVE_FIT_TYPE_LEAST_ABSOLUTE_RESIDUAL (1) Minimizes the magnitude of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_AM_CURVE_FIT_TYPE_BISQUARE (2) Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

| :- | :- | :- |

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_AMPMCfgAMToPMCurveFit

int32 __stdcall RFmxSpecAn_AMPMCfgAMToPMCurveFit (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 AMToPMCurveFitOrder, int32 AMToPMCurveFitType);

Purpose

Configures the degree of the polynomial and the cost-function, for approximating the measured AM-to-PM response of the device under test (DUT).

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.
AMToPMCurveFitOrder int32 Specifies the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test.
AMToPMCurveFitType int32 Specifies the polynomial approximation cost-function of the device under test AM-to-PM characteristic.
RFMXSPECAN_VAL_AMPM_AM_TO_PM_CURVE_FIT_TYPE_LEAST_SQUARE (0) Minimizes the energy of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_PM_CURVE_FIT_TYPE_LEAST_ABSOLUTE_RESIDUAL (1) Minimizes the magnitude of the polynomial approximation error.
RFMXSPECAN_VAL_AMPM_AM_TO_PM_CURVE_FIT_TYPE_BISQUARE (2) Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

| :- | :- | :- |

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_AMPMCfgThreshold

int32 __stdcall RFmxSpecAn_AMPMCfgThreshold (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 thresholdEnabled, float64 thresholdLevel, int32 thresholdType);

Purpose

Configures the threshold level for the samples that need to be considered for the AMPM measurement.

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.
thresholdEnabled int32 Specifies whether to enable thresholding of the acquired samples to use for the measurement.
RFMXSPECAN_VAL_AMPM_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the measurement.
RFMXSPECAN_VAL_AMPM_THRESHOLD_ENABLED_TRUE (1) The samples above the threshold level specified in the thresholdLevel parameter are considered for the measurement.

| :- | :- | :- | |thresholdLevel|float64|Specifies either the relative or absolute threshold power level based on the value of the thresholdType parameter. | |thresholdType|int32|Specifies the reference for the power level used for thresholding. |

RFMXSPECAN_VAL_AMPM_THRESHOLD_TYPE_RELATIVE (0) The threshold of the acquired samples is relative to the peak power, in dB.
RFMXSPECAN_VAL_AMPM_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

| :- | :- | :- |

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_AMPMCfgAveraging

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

Purpose

Configures averaging for the AMPM measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_AMPM_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_AMPM_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_AMPM_AVERAGING_ENABLED_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

| :- | :- | :- |

RFmxSpecAn_AMPMCfgCompressionPoints

int32 __stdcall RFmxSpecAn_AMPMCfgCompressionPoints( niRFmxInstrHandle instrumentHandle, char selectorString[], int32 compressionPointEnabled, float64 compressionLevel[], int32 arraySize );

Purpose

Configures the threshold level for the samples that need to be considered for the AMPM measurement.

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.
compressionPointEnabled int32 Enables computation of compression points corresponding to the compression levels specified by the Compression Level parameter.
compressionLevel float64[] Specifies the compression levels for which the compression points are computed when the Compression Point Enabled parameter is set to True. This value is expressed in dB.
arraySize int32 Specifies the size of the 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

| :- | :- | :- |

DFD Configure

RFmxSpecAn_DPDCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_DPDCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Specifies the duration, in seconds, of the reference waveform considered for the DPD measurement. When the reference waveform contains an idle duration, the DPD measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform.

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.
measurementInterval float64 Specifies the acquisition time, in seconds, for the DPD measurement. This parameter also specifies the duration of the reference waveform considered for the DPD measurement. When the reference waveform contains an idle duration, the DPD measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform.

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_DPDCfgMeasurementSampleRate

int32 __stdcall RFmxSpecAn_DPDCfgMeasurementSampleRate (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sampleRateMode, float64 sampleRate);

Purpose

Configures the acquisition sample rate, in samples per second (S/s), for the DPD measurement.

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.
sampleRateMode int32 Specifies the acquisition sample rate configuration mode.
RFMXSPECAN_VAL_DPD_MEASUREMENT_SAMPLE_RATE_MODE_USER (0) The acquisition sample rate is defined by the value of the sampleRate parameter.
RFMXSPECAN_VAL_DPD_MEASUREMENT_SAMPLE_RATE_MODE_REFERENCE_WAVEFORM (1) The acquisition sample rate is set to match the sample rate of the reference waveform.

| :- | :- | :- | |sampleRate|float64|Specifies the acquisition sample rate,in S/s, when you set the sampleRateMode parameter to RFMXSPECAN_VAL_DPD_MEASUREMENT_SAMPLE_RATE_MODE_USER. |

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_DPDCfgSynchronizationMethod

int32 __stdcall RFmxSpecAn_DPDCfgSynchronizationMethod (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 synchronizationMethod);

Purpose

Configures the synchronization method used to synchronize the reference waveform and acquired waveform.

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.
synchronizationMethod int32 Specifies the method used for synchronization of acquired waveform with reference waveform.
RFMXSPECAN_VAL_DPD_SYNCHRONIZATION_METHOD_DIRECT (0) Synchronizes the acquired and reference waveforms assuming that sample rate is sufficient to prevent aliasing in intermediate operations. This method is recommended when the measurement sampling rate is high.
RFMXSPECAN_VAL_DPD_SYNCHRONIZATION_METHOD_ALIAS_PROTECTED (1) Synchronizes the acquired and reference waveforms while ascertaining that intermediate operations are not impacted by aliasing. This method is recommended for non-contiguous carriers separated by a large gap, and/or when the measurement sampling rate is low. Refer to DPD concept help for more information.

| :- | :- | :- |

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_DPDCfgDUTAverageInputPower

int32 __stdcall RFmxSpecAn_DPDCfgDUTAverageInputPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 DUTAverageInputPower);

Purpose

Configures the average power, in dBm, of the signal at the device under test (DUT) input port.

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.
DUTAverageInputPower float64 Specifies the average power, in dBm, of the signal at the DUT input port.

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_DPDCfgReferenceWaveform

int32 __stdcall RFmxSpecAn_DPDCfgReferenceWaveform (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0, float64 dx, NIComplexSingle referenceWaveform[], int32 arraySize, int32 idleDurationPresent, int32 signalType);

Purpose

Configures the complex baseband equivalent of the RF signal applied at the input port of the device under test (DUT) when performing the DPD measurement.

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.
x0 float64 Specifies the start time, in seconds.
dx float64 Specifies the sample duration, in seconds.
referenceWaveform NIComplexSingle[] Specifies the complex baseband samples, as an array of voltage values.
arraySize int32 Specifies the size of the referenceWaveform array.
idleDurationPresent int32 Specifies whether the reference waveform contains an idle duration.
RFMXSPECAN_VAL_DPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_FALSE (0) The reference waveform does not contain an idle duration.
RFMXSPECAN_VAL_DPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_TRUE (1) The reference waveform contains an idle duration.

| :- | :- | :- | |signalType|int32|Specifies whether the reference waveform is a modulated signal or tones.|

RFMXSPECAN_VAL_DPD_SIGNAL_TYPE_MODULATED (0) The reference waveform is a cellular or connectivity standard signal.
RFMXSPECAN_VAL_DPD_SIGNAL_TYPE_TONES (1) The reference waveform is a continuous signal of one or more tones.

| :- | :- | :- |

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_DPDCfgReferenceWaveformSplit

int32 __stdcall RFmxSpecAn_DPDCfgReferenceWaveformSplit (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0, float64 dx, float32 I[], float32 Q[], int32 arraySize, int32 idleDurationPresent, int32 signalType);

Purpose

Configures the complex baseband equivalent of the RF signal applied at the input port of the DUT when performing the DPD measurement.

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.
x0 float64 Specifies the start time, in seconds.
dx float64 Specifies the sample duration, in seconds.
I float32[] Specifies the real part of complex baseband samples, in volts.
Q float32[] Specifies the imaginary part of complex baseband samples, in volts.
arraySize int32 Specifies the size of I and Q array.
idleDurationPresent int32 Specifies whether the reference waveform contains an idle duration.
RFMXSPECAN_VAL_DPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_FALSE (0) The reference waveform does not contain an idle duration.
RFMXSPECAN_VAL_DPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_TRUE (1) The reference waveform contains an idle duration.

| :- | :- | :- | |signalType|int32|Specifies whether the reference waveform is a modulated signal or tones.|

RFMXSPECAN_VAL_DPD_SIGNAL_TYPE_MODULATED (0) The reference waveform is a cellular or connectivity standard signal.
RFMXSPECAN_VAL_DPD_SIGNAL_TYPE_TONES (1) The reference waveform is a continuous signal of one or more tones.

| :- | :- | :- |

Return Value

Name Type Description

RFmxSpecAn_DPDCfgDPDModel

int32 __stdcall RFmxSpecAn_DPDCfgDPDModel (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 DPDModel);

Purpose

Configures the DPD model used by the DPD measurement.

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.
DPDModel int32 Specifies the DPD model used by the DPD measurement.
RFMXSPECAN_VAL_DPD_APPLY_DPD_USER_DPD_MODEL_LOOKUP_TABLE (0) This model computes the complex gain coefficients applied to linearize systems with negligible memory effects.
RFMXSPECAN_VAL_DPD_APPLY_DPD_USER_DPD_MODEL_MEMORY_POLYNOMIAL (1) This model computes the memory polynomial predistortion coefficients used to linearize systems with moderate memory effects.
RFMXSPECAN_VAL_DPD_APPLY_DPD_USER_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL (2) This model computes the generalized memory polynomial predistortion coefficients used to linearize systems with significant memory effects.

| :- | :- | :- |

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_DPDCfgLookupTableStepSize

int32 __stdcall RFmxSpecAn_DPDCfgLookupTableStepSize (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 stepSize);

Purpose

Configures the step size, in dB, of input power levels in the predistortion lookup table when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.

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.
stepSize float64 Specifies the step size, in dB, of the input power levels in the predistortion lookup table when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.

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_DPDCfgLookupTableAMToAMCurveFit

int32 __stdcall RFmxSpecAn_DPDCfgLookupTableAMToAMCurveFit (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 AMToAMCurveFitOrder, int32 AMToAMCurveFitType);

Purpose

Configures the degree of the polynomial and the approximation method used for polynomial approximation of the AM-to-AM response of the device under test (DUT) when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.

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.
AMToAMCurveFitOrder int32 Specifies the degree of the polynomial used to approximate the AM-to-AM characteristic of the DUT when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.
AMToAMCurveFitType int32 Specifies the cost-function for polynomial approximation of the AM-to-AM characteristic of the DUT when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_AM_TO_AM_CURVE_FIT_TYPE_LEAST_SQUARE (0) Minimizes the energy of the polynomial approximation error.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_AM_TO_AM_CURVE_FIT_TYPE_LEAST_ABSOLUTE_RESIDUAL (1) Minimizes the magnitude of the polynomial approximation error.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_AM_TO_AM_CURVE_FIT_TYPE_BISQUARE (2) Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

| :- | :- | :- |

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_DPDCfgLookupTableAMToPMCurveFit

int32 __stdcall RFmxSpecAn_DPDCfgLookupTableAMToPMCurveFit (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 AMToPMCurveFitOrder, int32 AMToPMCurveFitType);

Purpose

Configures the degree of the polynomial and the approximation method used for polynomial approximation of the AM-to-PM response of the device under test (DUT) when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.

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.
AMToPMCurveFitOrder int32 Specifies the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.
AMToPMCurveFitType int32 Specifies the cost-function for polynomial approximation of the AM-to-PM characteristic of the device under test when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_AM_TO_PM_CURVE_FIT_TYPE_LEAST_SQUARE (0) Minimizes the energy of the polynomial approximation error.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_AM_TO_PM_CURVE_FIT_TYPE_LEAST_ABSOLUTE_RESIDUAL (1) Minimizes the magnitude of the polynomial approximation error.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_AM_TO_PM_CURVE_FIT_TYPE_BISQUARE (2) Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

| :- | :- | :- |

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_DPDCfgLookupTableThreshold

int32 __stdcall RFmxSpecAn_DPDCfgLookupTableThreshold (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 thresholdEnabled, float64 thresholdLevel, int32 thresholdType);

Purpose

Configures the threshold level for the samples considered for the DPD measurement when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_LOOKUP_TABLE. Set the thresholdEnabled parameter to RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_THRESHOLD_ENABLED_TRUE to reject low-power signals affected by noise and distortion.

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.
thresholdEnabled int32 Specifies whether to enable thresholding of the acquired samples.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_THRESHOLD_ENABLED_FALSE (0) All samples are considered for the measurement.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_THRESHOLD_ENABLED_TRUE (1) The samples above the threshold level specified in the thresholdLevel parameter are considered for the measurement.

| :- | :- | :- | |thresholdLevel|float64|Specifies either the relative or absolute threshold power level based on the value of the thresholdType parameter. | |thresholdType|int32|Specifies the reference for the power level used for thresholding.|

RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_THRESHOLD_TYPE_RELATIVE (0) The threshold of the acquired samples is relative to the peak power, in dB.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_THRESHOLD_TYPE_ABSOLUTE (1) The threshold is the absolute power, in dBm.

| :- | :- | :- |

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_DPDCfgLookupTableType

int32 __stdcall RFmxSpecAn_DPDCfgLookupTableType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 lookupTableType);

Purpose

Configures the type of DPD Lookup Table.

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.
lookupTableType int32 Specifies the type of the DPD lookup table (LUT).
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_TYPE_LOG (0) Input powers in the LUT are specified in dBm.
RFMXSPECAN_VAL_DPD_LOOKUP_TABLE_TYPE_LINEAR (1) Input powers in the LUT are specified in watts.

| :- | :- | :- |

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_DPDCfgMemoryPolynomial

int32 __stdcall RFmxSpecAn_DPDCfgMemoryPolynomial (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 memoryPolynomialOrder, int32 memoryPolynomialMemoryDepth);

Purpose

Configures the order and memory depth of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_MEMORY_POLYNOMIAL or RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL.

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.
memoryPolynomialOrder int32 Specifies the order of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_MEMORY_POLYNOMIAL or RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Ka in the equation for the generalized memory polynomial.
memoryPolynomialMemoryDepth int32 Specifies the memory depth of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_MEMORY_POLYNOMIAL or RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Qa in the equation for the generalized memory polynomial.

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_DPDCfgGeneralizedMemoryPolynomialCrossTerms

int32 __stdcall RFmxSpecAn_DPDCfgGeneralizedMemoryPolynomialCrossTerms (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 memoryPolynomialLeadOrder, int32 memoryPolynomialLagOrder, int32 memoryPolynomialLeadMemoryDepth, int32 memoryPolynomialLagMemoryDepth, int32 memoryPolynomialMaximumLead, int32 memoryPolynomialMaximumLag);

Purpose

Configures the cross terms of the generalized memory polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL function to configure the normal terms in the DPD polynomial and the cross terms when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL.

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.
memoryPolynomialLeadOrder int32 Specifies the lead order cross term of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Kc in the equation for the generalized memory polynomial.
memoryPolynomialLagOrder int32 Specifies the lag order cross term of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Kb in the equation for the generalized memory polynomial.
memoryPolynomialLeadMemoryDepth int32 Specifies the lead memory depth cross term of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Qc in the equation for the generalized memory polynomial. The value of this parameter must be greater than or equal to the value of the memoryPolynomialMaximumLead parameter.
memoryPolynomialLagMemoryDepth int32 Specifies the lag memory depth cross term of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Qb in the equation for the generalized memory polynomial.
memoryPolynomialMaximumLead int32 Specifies the maximum lead stagger cross term of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Mc in the equation for the generalized memory polynomial.
memoryPolynomialMaximumLag int32 Specifies the maximum lag stagger cross term of the DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. This value corresponds to Mb in the equation for the generalized memory polynomial.

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_DPDCfgIterativeDPDEnabled

int32 __stdcall RFmxSpecAn_DPDCfgIterativeDPDEnabled (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 iterativeDPDEnabled);

Purpose

Configures the iterative computation of the DPD polynomial in accordance with the [indirect-learning architecture](javascript:LaunchHelp('rfmxspecan.chm', 'DPD.html')) when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_MEMORY_POLYNOMIAL or RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL.

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.
iterativeDPDEnabled int32 Specifies whether to enable iterative computation of the DPD results DPD polynomial using the indirect-learning architecture.
RFMXSPECAN_VAL_DPD_ITERATIVE_DPD_ENABLED_FALSE (0) The DPD results DPD polynomial is computed without considering the value of the DPD previous DPD polynomial.
RFMXSPECAN_VAL_DPD_ITERATIVE_DPD_ENABLED_TRUE (1) The DPD Results DPD polynomial is computed based on the value of the DPD previous DPD polynomial.

| :- | :- | :- |

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_DPDCfgPreviousDPDPolynomial

int32 __stdcall RFmxSpecAn_DPDCfgPreviousDPDPolynomial (niRFmxInstrHandle instrumentHandle, char selectorString[], NIComplexSingle previousDPDPolynomial[], int32 arraySize);

Purpose

Configures the previous DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_ITERATIVE_DPD_ENABLED_TRUE to apply the previous DPD polynomial on the reference waveform. This reference waveform is used to compute the value of the DPD polynomial for the current iteration.

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.
previousDPDPolynomial NIComplexSingle[] Specifies an array of values for the previous DPD polynomial.
arraySize int32 Specifies the size of the previousDPDPolynomial 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_DPDCfgPreviousDPDPolynomialSplit

int32 __stdcall RFmxSpecAn_DPDCfgPreviousDPDPolynomialSplit (niRFmxInstrHandle instrumentHandle, char selectorString[], float32 I[], float32 Q[], int32 arraySize);

Purpose

Configures the previous DPD polynomial when you set the RFMXSPECAN_ATTR_DPD_MODEL attribute to RFMXSPECAN_VAL_DPD_MODEL_MEMORY_POLYNOMIAL or RFMXSPECAN_VAL_DPD_MODEL_GENERALIZED_MEMORY_POLYNOMIAL. Set the Iterative DPD Enabled attribute to true, to apply the previous DPD polynomial on the reference waveform, which is used to compute the value of the DPD polynomial for the current iteration.

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.
I float32[] Specifies the real part of an array of values for the previous DPD polynomial.
Q float32[] Specifies the imaginary part of an array of values for the previous DPD polynomial.
arraySize int32 Specifies the size of I and Q array.

Return Value

Name Type Description

RFmxSpecAn_DPDCfgAveraging

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

Purpose

Configures averaging for the DPD measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_DPD_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_DPD_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_DPD_AVERAGING_ENABLED_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

| :- | :- | :- |

RFmxSpecAn_DPDApplyPreDPDSignalConditioning

int32 __stdcall RFmxSpecAn_DPDApplyPreDPDSignalConditioning (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0In, float64 dxIn, NIComplexSingle waveformIn[], int32 arraySizeIn, int32 idleDurationPresent, float64* x0Out, float64* dxOut, NIComplexSingle waveformOut[], int32 arraySizeOut, int32* actualArraySize, float64* PAPR);

Purpose

Applies crest factor reduction on the input waveform.

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.
x0In float64 Specifies the start time, in seconds.
dxIn float64 Specifies the sample duration, in seconds.
waveformIn NIComplexSingle[] Specifies the complex baseband samples, in volts.
arraySizeIn int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
idleDurationPresent int32 Specifies whether the waveform contains an idle duration.
RFMXSPECAN_VAL_DPD_APPLY_DPD_IDLE_DURATION_PRESENT_FALSE (0) The waveform does not contain an idle duration.
RFMXSPECAN_VAL_DPD_APPLY_DPD_IDLE_DURATION_PRESENT_TRUE (1) The waveform contains an idle duration.

| :- | :- | :- | |waveformOut|NIComplexSingle[]|Returns the complex baseband samples, in volts.| |arraySizeOut|int32|Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.| |Output||| |Name|Type|Description| |x0Out|float64*|Returns the start time, in seconds.| |dxOut|float64*|Returns the sample duration, in seconds.| |actualArraySize|int32*|Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.| |PAPR|float64*|Returns the peak-to-average power ratio of the waveform obtained after applying pre-DPD signal conditioning on the input waveform. This value is expressed in dB. |

Return Value

Name Type Description

RFmxSpecAn_DPDApplyPreDPDSignalConditioningSplit

int32 __stdcall RFmxSpecAn_DPDApplyPreDPDSignalConditioningSplit (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0In, float64 dxIn, float32 waveformInI[], float32 waveformInQ[], int32 arraySizeIn, int32 idleDurationPresent, float64* x0Out, float64* dxOut, float32 waveformOutI[], float32 waveformOutQ[], int32 arraySizeOut, int32* actualArraySize, float64* PAPR);

Purpose

Applies crest factor reduction on the input waveform.

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.
x0In float64 Specifies the start time, in seconds.
dxIn float64 Specifies the sample duration, in seconds.
waveformInI float32[] Specifies the real part of complex baseband samples, in volts.
waveformInQ float32[] Specifies the imaginary part of complex baseband samples, in volts.
arraySizeIn int32 Specifies the size ofWaveformInI and WaveformInQ array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
idleDurationPresent int32 Specifies whether the waveform contains an idle duration.
RFMXSPECAN_VAL_DPD_APPLY_DPD_IDLE_DURATION_PRESENT_FALSE (0) The waveform does not contain an idle duration.
RFMXSPECAN_VAL_DPD_APPLY_DPD_IDLE_DURATION_PRESENT_TRUE (1) The waveform contains an idle duration.

| :- | :- | :- | |waveformOutI|float32[]|Returns the real part of complex baseband samples, in volts.| |waveformOutQ|float32[]|Returns the imaginary part of complex baseband samples, in volts.| |arraySizeOut|int32|Specifies the size of WaveformOutI and WaveformOutQ array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.| |Output||| |Name|Type|Description| |x0Out|float64*|Returns the start time, in seconds.| |dxOut|float64*|Returns the sample duration, in seconds.| |actualArraySize|int32*|Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.| |PAPR|float64*|Returns the peak-to-average power ratio of the waveform obtained after applying pre-DPD signal conditioning on the input waveform. This value is expressed in dB. |

Return Value

Name Type Description

IQ Configure

RFmxSpecAn_IQCfgAcquisition

int32 __stdcall RFmxSpecAn_IQCfgAcquisition (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 sampleRate, int32 numberOfRecords, float64 acquisitionTime, float64 pretriggerTime);

Purpose

Configures the acquisition settings for the I/Q measurement.

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.
sampleRate float64 Specifies the acquisition sample rate, in samples per second (S/s).
numberOfRecords int32 Specifies the number of records to acquire.
acquisitionTime float64 Specifies the acquisition time, in seconds, for the I/Q measurement.
pretriggerTime float64 Specifies the pretrigger time, in seconds, for the I/Q measurement.

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_IQCfgBandwidth

int32 __stdcall RFmxSpecAn_IQCfgBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 bandwidthAuto, float64 bandwidth);

Purpose

Configures the bandwidth for the I/Q measurement.

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.
bandwidthAuto int32 Specifies whether the measurement computes the minimum acquisition bandwidth.
RFMXSPECAN_VAL_IQ_AUTO_BANDWIDTH_FALSE (0) The measurement uses the value of the bandwidth parameter as the minimum acquisition bandwidth.
RFMXSPECAN_VAL_IQ_AUTO_BANDWIDTH_TRUE (1) The measurement uses 0.8 * sample rate as the minimum signal bandwidth.

| :- | :- | :- | |bandwidth|float64|Specifies the minimum acquisition bandwidth, in hertz (Hz), when you set the bandwidthAuto parameter to RFMXSPECAN_VAL_IQ_AUTO_BANDWIDTH_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

| :- | :- | :- |

IM Configure

RFmxSpecAn_IMCfgFrequencyDefinition

int32 __stdcall RFmxSpecAn_IMCfgFrequencyDefinition (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 frequencyDefinition);

Purpose

Configures whether you can specify the tones and intermod frequencies as either relative to the RF center frequency or as absolute frequencies.

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.
frequencyDefinition int32 Specifies whether you can specify the tones and intermod frequencies as either relative to the RF center frequency or as absolute frequencies.
RFMXSPECAN_VAL_IM_FREQUENCY_DEFINITION_RELATIVE (0) The tone and intermod frequencies are relative to the RF center frequency.
RFMXSPECAN_VAL_IM_FREQUENCY_DEFINITION_ABSOLUTE (1) The tone and intermod frequencies are absolute frequencies. The measurement ignores the RF center 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_IMCfgFundamentalTones

int32 __stdcall RFmxSpecAn_IMCfgFundamentalTones (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 lowerToneFrequency, float64 upperToneFrequency);

Purpose

Configures the frequencies of the upper and lower frequencies in a two-tone input signal.

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.
lowerToneFrequency float64 Specifies the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz.
upperToneFrequency float64 Specifies the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz.

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_IMCfgAutoIntermodsSetup

int32 __stdcall RFmxSpecAn_IMCfgAutoIntermodsSetup (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 autoIntermodsSetupEnabled, int32 maximumIntermodOrder);

Purpose

Configures whether the measurement computes the intermod frequencies or uses manually specified frequencies.

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.
autoIntermodsSetupEnabled int32 Specifies whether the measurement computes the intermod frequencies or uses manually specified frequencies.
RFMXSPECAN_VAL_IM_AUTO_INTERMODS_SETUP_ENABLED_FALSE (0) The measurement uses the values that you specify for the RFMXSpecAn_ATTR_IM_LOWER_INTERMOD_FREQUENCY attributes.
RFMXSPECAN_VAL_IM_AUTO_INTERMODS_SETUP_ENABLED_TRUE (1) The measurement computes intermod frequencies. The number of intermods to measure is based on the value of the maximumIntermodOrder parameter.

| :- | :- | :- | |maximumIntermodOrder|int32|Specifies the order up to which the RFmx driver measures odd order intermodulation products when you set the autoIntermodsSetupEnabled parameter to RFMXSPECAN_VAL_IM_AUTO_INTERMODS_SETUP_ENABLED_TRUE. The lower and upper intermodulation products are measured for each order. |

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_IMCfgMeasurementMethod

int32 __stdcall RFmxSpecAn_IMCfgMeasurementMethod (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 measurementMethod);

Purpose

Configures the method for performing the IM measurement.

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.
measurementMethod int32 Specifies the method for performing the IM measurement.
RFMXSPECAN_VAL_IM_MEASUREMENT_METHOD_NORMAL (0) The IM measurement acquires the spectrum using the same signal analyzer settings across frequency bands. Use this method when the fundamental tone separation is not large.
**Supported devices:**PXIe-5644/5645/5646/5840/5841/5830/5831/5832, PXIe-5663/5665/5668.
RFMXSPECAN_VAL_IM_MEASUREMENT_METHOD_DYNAMIC_RANGE (1) The IM measurement acquires a segmented spectrum using the signal analyzer specific optimizations for different frequency bands. The spectrum is acquired in segments, one per tone or intermod frequency to be measured. The span of each acquired spectral segment is equal to the frequency separation between the two input tones, or 1 MHz, whichever is smaller.
Use this method to configure the IM measurement and the signal analyzer for maximum dynamic range instead of measurement speed.
**Supported devices:**PXIe-5665/5668
RFMXSPECAN_VAL_IM_MEASUREMENT_METHOD_SEGMENTED (2) Similar to the dynamicRange method, this method also acquires a segmented spectrum, except that signal analyzer is not explicitly configured to provide maximum dynamic range. Use this method when the frequency separation of the two input tones is large and the measurement accuracy can be traded off for measurement speed.
**Supported devices:**PXIe-5644/5645/5646/5840/5841/5830/5831/5832, PXIe-5663/5665/5668

| :- | :- | :- |

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_IMCfgNumberOfIntermods

int32 __stdcall RFmxSpecAn_IMCfgNumberOfIntermods (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfIntermods);

Purpose

Configures the number of intermods to measure when you set the RFMXSpecAn_ATTR_IM_AUTO_INTERMODS_SETUP_ENABLED attribute to RFMXSPECAN_VAL_IM_AUTO_INTERMODS_SETUP_ENABLED_FALSE.

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.
numberOfIntermods int32 Specifies the number of intermods to measure when you set the RFMXSpecAn_ATTR_IM_AUTO_INTERMODS_SETUP_ENABLED attribute to RFMXSPECAN_VAL_IM_AUTO_INTERMODS_SETUP_ENABLED_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_IMCfgIntermod

int32 __stdcall RFmxSpecAn_IMCfgIntermod (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 intermodOrder, float64 lowerIntermodFrequency, float64 upperIntermodFrequency, int32 intermodSide, int32 intermodEnabled);

Purpose

Configures the intermod order, intermod side, lower intermod frequency, and upper intermod frequency when you set the RFMXSpecAn_ATTR_IM_AUTO_INTERMODS_SETUP_ENABLED attribute to RFMXSPECAN_VAL_IM_AUTO_INTERMODS_SETUP_ENABLED_FALSE. Use "intermod<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[] Specifies a selector string comprising of the signal name and intermod number. If you do not specify the signal name, the default signal instance is used.
Example:
"intermod0"
"signal::sig1/intermod0"
You can use the RFmxSpecAn_BuildIntermodString function to build the selector string.
intermodOrder int32 Specifies the order of the intermod.
lowerIntermodFrequency float64 Specifies the frequency of the lower intermodulation product. This value is expressed in Hz.
upperIntermodFrequency float64 Specifies the frequency of the upper intermodulation product. This value is expressed in Hz.
intermodSide int32 Specifies whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them.
RFMXSPECAN_VAL_IM_INTERMOD_SIDE_LOWER (0) Measures the intermodulation product corresponding to the lowerIntermodFrequency parameter.
RFMXSPECAN_VAL_IM_INTERMOD_SIDE_UPPER (1) Measures the intermodulation product corresponding to the upperIntermodFrequency parameter.
RFMXSPECAN_VAL_IM_INTERMOD_SIDE_BOTH (2) Measures the intermodulation product corresponding to both lowerIntermodFrequency and upperIntermodFrequency parameters.

| :- | :- | :- | |intermodEnabled|int32|Specifies whether to enable an intermod for the IM measurement. |

RFMXSPECAN_VAL_IM_INTERMOD_ENABLED_FALSE (0) Disables an intermod for the IM measurement. The results for the disabled intermods are displayed as NaN.
RFMXSPECAN_VAL_IM_INTERMOD_ENABLED_TRUE (1) Enables an intermod for the IM measurement.

| :- | :- | :- |

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_IMCfgRBWFilter

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

Purpose

Configures the RBW filter.

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.
RBWAuto int32 Specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the Spectral Measurements topic for more details on RBW and sweep time.
RFMXSPECAN_VAL_IM_RBW_FILTER_AUTO_BANDWIDTH_FALSE (0) The measurement uses the RBW that you specify in the RBW parameter.
RFMXSPECAN_VAL_IM_RBW_FILTER_AUTO_BANDWIDTH_TRUE (1) The measurement computes the RBW.

| :- | :- | :- | |RBW|float64|Specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBWAuto parameter to RFMXSPECAN_VAL_IM_RBW_FILTER_AUTO_BANDWIDTH_FALSE. This value is expressed in Hz. | |RBWFilterType|int32|Specifies the response of the digital RBW filter. |

RFMXSPECAN_VAL_IM_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXSPECAN_VAL_IM_RBW_FILTER_TYPE_GAUSSIAN (1) An RBW filter with a Gaussian response is applied.
RFMXSPECAN_VAL_IM_RBW_FILTER_TYPE_FLAT (2) An RBW filter with a flat response is applied.
RFMXSPECAN_VAL_IM_RBW_FILTER_TYPE_SYNCH_TUNED_4 (3) An RBW filter with a 4-pole synchronously-tuned response is applied.
RFMXSPECAN_VAL_IM_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_IMCfgSweepTime

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

Purpose

Configures the sweep time.

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.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXSPECAN_VAL_IM_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXSPECAN_VAL_IM_SWEEP_TIME_AUTO_TRUE (1) The measurement computes the sweep time based on the value of the RFMXSpecAn_ATTR_IM_RBW_FILTER_BANDWIDTH attribute.

| :- | :- | :- | |sweepTimeInterval|float64|Specifies the sweep time, in seconds, when you set the sweepTimeAuto parameter to RFMXSPECAN_VAL_IM_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_IMCfgAveraging

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

Purpose

Configures averaging for the IM measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_IM_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_IM_AVERAGING_ENABLED_TRUE (1) The measurement uses the value of 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_IM_AVERAGING_ENABLED_TRUE. | |averagingType|int32|Specifies the averaging type for averaging the power over multiple acquisitions. The averaged power trace is used for the measurement. Refer to the Averaging section of the Spectrum topic for more information about averaging types. |

RFMXSPECAN_VAL_IM_AVERAGING_TYPE_RMS (0) The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXSPECAN_VAL_IM_AVERAGING_TYPE_LOG (1) The power trace is averaged in a logarithmic scale.
RFMXSPECAN_VAL_IM_AVERAGING_TYPE_SCALAR (2) The square root of the power trace is averaged.
RFMXSPECAN_VAL_IM_AVERAGING_TYPE_MAXIMUM (3) The peak power in the power trace at each sample instance is retained from one acquisition to the next.
RFMXSPECAN_VAL_IM_AVERAGING_TYPE_MINIMUM (4) The least power in the power trace at each sample instance 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_IMCfgFFT

int32 __stdcall RFmxSpecAn_IMCfgFFT (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 FFTWindow, float64 FFTPadding);

Purpose

Configures the window and FFT to obtain a spectrum for the IM measurement.

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.
FFTWindow int32 Specifies the FFT window type to use to reduce spectral leakage. Refer to the Window and FFT section of the Spectral Measurements topic for more information about FFT window types.
RFMXSPECAN_VAL_IM_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_IM_FFT_WINDOW_FLAT_TOP (1) Measures single-tone amplitudes accurately.
RFMXSPECAN_VAL_IM_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_IM_FFT_WINDOW_HAMMING (3) Analyzes closely-spaced sine waves.
RFMXSPECAN_VAL_IM_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_IM_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_IM_FFT_WINDOW_BLACKMAN_HARRIS (6) Useful as a general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.
RFMXSPECAN_VAL_IM_FFT_WINDOW_KAISER_BESSEL (7) Separates two tones with frequencies close to each other but with widely-differing amplitudes.

| :- | :- | :- | |FFTPadding|float64|Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula: waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth of the device.|

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

| :- | :- | :- |

IM Array Apis

RFmxSpecAn_IMCfgIntermodArray

int32 __stdcall RFmxSpecAn_IMCfgIntermodArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 intermodOrder[], float64 lowerIntermodFrequency[], float64 upperIntermodFrequency[], int32 intermodSide[], int32 intermodEnabled[], int32 numberOfElements);

Purpose

Configures the intermod order, intermod side, lower intermod frequency, and upper intermod frequency when you set the RFMXSPECAN_ATTR_IM_AUTO_INTERMODS_SETUP_ENABLED attribute to RFMXSPECAN_VAL_IM_AUTO_INTERMODS_SETUP_ENABLED_FALSE.

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.
intermodOrder int32[] Specifies array of orders of the intermod.
lowerIntermodFrequency float64[] Specifies an array of the frequencies of the lower intermodulation products. This value is expressed in Hz.
upperIntermodFrequency float64[] Specifies an array of frequencies of the upper intermodulation products. This value is expressed in Hz.
intermodSide int32[] Specifies whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them.
RFMXSPECAN_VAL_IM_INTERMOD_SIDE_LOWER (0) Measures the intermodulation product corresponding to the lowerIntermodFrequency parameter.
RFMXSPECAN_VAL_IM_INTERMOD_SIDE_UPPER (1) Measures the intermodulation product corresponding to the upperIntermodFrequency parameter.
RFMXSPECAN_VAL_IM_INTERMOD_SIDE_BOTH (2) Measures the intermodulation product corresponding to the lowerIntermodFrequency and upperIntermodFrequency parameters.

| :- | :- | :- | |intermodEnabled|int32[]|Specifies whether to enable an intermod for the IM measurement. |

RFMXSPECAN_VAL_IM_INTERMOD_ENABLED_FALSE (0) Disables the intermod for the IM measurement. The results for the disabled intermods are displayed as NaN.
RFMXSPECAN_VAL_IM_INTERMOD_ENABLED_TRUE (1) Enables the intermod for the IM measurement.

| :- | :- | :- | |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

| :- | :- | :- |

NF Configure

RFmxSpecAn_NFRecommendReferenceLevel

int32 __stdcall RFmxSpecAn_NFRecommendReferenceLevel (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 DUTMaxGain, float64 DUTMaxNoiseFigure, float64* referenceLevel);

Purpose

Computes and sets an appropriate reference level based on the expected maximum DUT gain, maximum DUT noise figure, and other measurement and analyzer attributes. You must not set the RFMXINSTR_ATTR_MIXER_LEVEL attributes in order to obtain an appropriate recommended reference level.

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.
DUTMaxGain float64 Returns the expected maximum gain from the DUT. This value is expressed in dB.
DUTMaxNoiseFigure float64 Returns the expected maximum noise figure of the DUT. This value is expressed in dB.
Output
Name Type Description
referenceLevel float64* Returns the recommended reference level for the NF measurement. This value is expressed in dBm for RF devices and as Vpk-pk for baseband devices.

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_NFClearCalibrationDatabase

int32 __stdcall RFmxSpecAn_NFClearCalibrationDatabase (niRFmxInstrHandle instrumentHandle, char calibrationSetupID[]);

Purpose

Clear the noise figure calibration data for Cold Source and Y-Factor method. Calibration data associated with the selected VSA is cleared for the Cold Source method while calibration data associated with the noise source name and the VSA is cleared for the Y-Factor method.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize function.
calibrationSetupID char[] Associates a unique string identifier with the hardware setup used to perform calibration for the NF measurement.

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_NFCfgFrequencyList_StartStopStep

int32 __stdcall RFmxSpecAn_NFCfgFrequencyList_StartStopStep (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency, float64 stopFrequency, float64 stepSize);

Purpose

Configures the list of frequencies at which to perform the noise figure (NF) measurement. The start frequency and stop frequency points are inclusive in the frequency list.

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.
startFrequency float64 Specifies the lowest frequency at which to perform the NF measurement. This value is expressed in Hz.
stopFrequency float64 Specifies the highest frequency at which to perform the NF measurement. This value is expressed in Hz.
stepSize float64 Specifies the spacing between adjacent frequency points in the list of frequencies at which to perform the NF measurement. This value is expressed in Hz.

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_NFCfgFrequencyList_StartStopPoints

int32 __stdcall RFmxSpecAn_NFCfgFrequencyList_StartStopPoints (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency, float64 stopFrequency, int32 numberOfPoints);

Purpose

Configures the list of frequencies at which the noise figure (NF) measurement has to be performed. The start frequency and stop frequency points are inclusive in the frequency list.

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.
startFrequency float64 Specifies the lowest frequency at which to perform the NF measurement. This value is expressed in Hz.
stopFrequency float64 Specifies the highest frequency at which to perform the NF measurement. This value is expressed in Hz.
numberOfPoints int32 Specifies the number of frequency points in the list of frequencies at which to perform the NF measurement. This value is expressed in Hz.

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_NFCfgFrequencyList

int32 __stdcall RFmxSpecAn_NFCfgFrequencyList (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 frequencyList[], int32 arraySize);

Purpose

Configures the list of frequencies at which to perform the noise figure (NF) measurement.

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.
frequencyList float64[] Specifies the list of frequencies at which the NF of the DUT is computed. This value is expressed in Hz.
arraySize int32 Specifies the size of the 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_NFCfgMeasurementBandwidth

int32 __stdcall RFmxSpecAn_NFCfgMeasurementBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementBandwidth);

Purpose

Configures the effective noise-bandwidth in which power measurements are performed in the noise figure (NF) measurement.

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.
measurementBandwidth float64 Specifies the effective noise-bandwidth in which power measurements are performed for the NF measurement. This value is expressed in Hz.

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_NFCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_NFCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval);

Purpose

Configures the duration for which the signals are acquired at each frequency to perform the noise figure (NF) measurement.

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.
measurementInterval float64 Specifies the duration for which signals are acquired at each frequency which you specify in the RFMXSPECAN_ATTR_NF_FREQUENCY_LIST attribute. This value is expressed in seconds.

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_NFCfgAveraging

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

Purpose

Configures averaging for the noise figure (NF) measurement.

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.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXSPECAN_VAL_NF_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXSPECAN_VAL_NF_AVERAGING_ENABLED_TRUE (1) The measurement uses the value of 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_NF_AVERAGING_ENABLED_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

| :- | :- | :- |

RFmxSpecAn_NFCfgMeasurementMethod

int32 __stdcall RFmxSpecAn_NFCfgMeasurementMethod (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 measurementMethod);

Purpose

Configures the noise figure (NF) measurement to use either the Y-Factor or the cold source method.

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.
measurementMethod int32 Specifies the measurement method used to perform the NF measurement.
RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_Y_FACTOR (0) The NF measurement computes the noise figure of the DUT using a noise source with a calibrated excess-noise ratio (ENR).
supportedDevices: PXIe-5665 (3.6 GHz), PXIe-5668, PXIe-5644/5645/5646, PXIe-5840/5841, PXIe 5830/5831/5832.
Refer to the NF concept topic for more information.
RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_COLD_SOURCE (1) The NF measurement computes the noise figure of the DUT using a 50 ohm microwave termination as the noise source.
supportedDevices: PXIe-5644/5645/5646, PXIe-5840/5841, PXIe-5830/5831/5832.
Refer to the NF concept topic for more information.

| :- | :- | :- |

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_NFCfgYFactorMode

int32 __stdcall RFmxSpecAn_NFCfgYFactorMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 yFactorMode);

Purpose

Configures the Y-Factor based noise figure (NF) measurement to perform the calibration step or the measurement step.

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.
yFactorMode int32 Specifies whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT when you set the RFMXSpecAn_ATTR_NF_MEASUREMENT_METHOD attribute to RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_Y_FACTOR.
RFMXSPECAN_VAL_NF_Y_FACTOR_MODE_MEASURE (0) The NF measurement computes the noise characteristics of the DUT, compensating for the noise figure of the analyzer.
RFMXSPECAN_VAL_NF_Y_FACTOR_MODE_CALIBRATE (1) The NF measurement computes the noise characteristics of the analyzer.

| :- | :- | :- |

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_NFCfgYFactorNoiseSourceENR

int32 __stdcall RFmxSpecAn_NFCfgYFactorNoiseSourceENR (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 ENRFrequency[], float64 ENR[], float64 coldTemperature, float64 offTemperature, char noiseSourceName[], int32 arraySize);

Purpose

Configures excess noise ratio (ENR) and temperature of the noise source used by the Y-Factor method.

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.
ENRFrequency float64[] Specifies an array of frequencies corresponding to the effective noise ratio (ENR) values specified by the ENR parameter. This value is expressed in Hz. The default value is an empty array.
ENR float64[] Specifies the array of ENR values of the noise source as a function of the frequency. This value is expressed in dB. The corresponding frequencies are specified by the ENRFreq parameter. This attribute is used only when you set the RFMXSPECAN_ATTR_NF_MEASUREMENT_METHOD attribute to RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_Y_FACTOR. This value is expressed in dB.
coldTemperature float64 Specifies the calibrated cold noise temperature of the noise source used in the Y-Factor method. This value is expressed in kelvin.
offTemperature float64 Specifies the physical temperature of the noise source used in the Y-Factor method when the noise source is turned off. This value is expressed in kelvin.
arraySize int32 Specifies the size of the 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_NFCfgYFactorNoiseSourceLoss

int32 __stdcall RFmxSpecAn_NFCfgYFactorNoiseSourceLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 noiseSourceLossCompensationEnabled, float64 noiseSourceLossFrequency[], float64 noiseSourceLoss[], float64 noiseSourceLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss inherent to the noise source used in the Y-Factor method that is common to the calibration and the measurement steps.

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.
noiseSourceLossCompensationEnabled int32 Specifies whether the noise figure (NF) measurement should account for ohmic losses inherent to the noise source used in the Y-Factor method common to the calibration and measurement steps.
noiseSourceLossFrequency float64[] Specifies the array of the frequencies corresponding to the ohmic loss inherent to the noise source used in the Y-Factor method specified by the noiseSourceLoss parameter. This value is expressed in Hz.
noiseSourceLoss float64[] Specifies an array of the ohmic losses inherent to the noise source used in the Y-Factor method. This value is expressed in dB. This loss is accounted for by the NF measurement when you set the noiseSourceLossCompensationEnabled parameter to true.
You must specify the frequencies at which the losses were measured using the noiseSourceLossFrequency parameter.
noiseSourceLossTemperature float64 Specifies the physical temperature of the ohmic loss elements specified in the noiseSourceLoss parameter. This value is expressed in kelvin.
arraySize int32 Specifies the size of the 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_NFCfgYFactorNoiseSourceSettlingTime

int32 __stdcall RFmxSpecAn_NFCfgYFactorNoiseSourceSettlingTime (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 settlingTime);

Purpose

Configures the time required for the acquisition to wait till the noise source used in the Y-Factor method settles to hot or cold state when the noise source is powered on or off.

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.
settlingTime float64 Specifies the time to wait till the noise source used in the Y-Factor method settles to either hot or cold state when the noise source is enabled or disabled. This value is expressed in seconds.

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_NFCfgDUTInputLoss

int32 __stdcall RFmxSpecAn_NFCfgDUTInputLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 DUTInputLossCompensationEnabled, float64 DUTInputLossFrequency[], float64 DUTInputLoss[], float64 DUTInputLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss, as a function of frequency, of the loss elements between the noise source and the input port of the DUT, excluding the losses that are common to the calibration step and the measurement step.

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.
DUTInputLossCompensationEnabled int32 Specifies whether the noise figure (NF) measurement accounts for ohmic losses between the noise source and the input port of the DUT, excluding the losses that are common to calibration and the measurement steps for the Y-Factor method, which are specified by the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS attribute.
RFMXSPECAN_VAL_NF_DUT_INPUT_LOSS_COMPENSATION_ENABLED_FALSE (0) The measurement ignores ohmic losses.
RFMXSPECAN_VAL_NF_DUT_INPUT_LOSS_COMPENSATION_ENABLED_TRUE (1) The measurement accounts for the ohmic losses.

| :- | :- | :- | |DUTInputLossFrequency|float64[]|Specifies an array of frequencies corresponding to the value of the DUTInputLoss parameter. This value is expressed in Hz. To specify a constant loss value for all frequencies, you must set this attribute to an empty array. | |DUTInputLoss|float64[]|Specifies an array of the the ohmic losses between the noise source and the input port of the DUT, as a function of the frequency. This value is expressed in dB. You must exclude any loss which is inherent to the noise source and is common between the calibration and measurement steps, and configure the loss using the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS attribute. Specify the frequencies at which the losses were measured using the DUTInputLossFrequency parameter. To specify a constant loss value for all frequencies, you should set the DUTInputLossFrequency attribute to an empty array and set the DUTInputLossFrequency parameter to a single element array, where the value of that element is equal to the frequency-independent loss. This loss is accounted for by the NF measurement when you set the DUTInputLossCompensationEnabled parameter to RFMXSPECAN_VAL_NF_DUT_INPUT_LOSS_COMPENSATION_ENABLED_TRUE. | |DUTInputLossTemperature|float64|Specifies the physical temperature of the ohmic loss elements considered in the DUTInputLoss parameter. This value is expressed in kelvin. | |arraySize|int32|Specifies the size of the 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_NFCfgDUTOutputLoss

int32 __stdcall RFmxSpecAn_NFCfgDUTOutputLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 DUTOutputLossCompensationEnabled, float64 DUTOutputLossFrequency[], float64 DUTOutputLoss[], float64 DUTOutputLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss, as a function of frequency, of the loss elements between the output port of the DUT and the input port of the analyzer.

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.
DUTOutputLossCompensationEnabled int32 Specifies whether the noise figure (NF) measurement accounts for ohmic losses between the output port of the DUT and the input port of the analyzer.
RFMXSPECAN_VAL_NF_DUT_OUTPUT_LOSS_COMPENSATION_ENABLED_FALSE (0) The measurement ignores ohmic losses.
RFMXSPECAN_VAL_NF_DUT_OUTPUT_LOSS_COMPENSATION_ENABLED_TRUE (1) The measurement accounts for the ohmic losses.

| :- | :- | :- | |DUTOutputLossFrequency|float64[]|Specifies the array of frequencies corresponding to the value of the RFMXSpecAn_ATTR_NF_DUT_OUTPUT_LOSS attribute. This value is expressed in Hz. | |DUTOutputLoss|float64[]|Specifies the array of ohmic losses between the output port of the DUT and the input port of the analyzer, as a function of frequency. This value is expressed in dB. This loss is accounted for by the NF measurement when you set the DUTOutputLossCompensationEnabled parameter to RFMXSPECAN_VAL_NF_DUT_OUTPUT_LOSS_COMPENSATION_ENABLED_TRUE.
Specify the array of frequencies at which the losses were measured using the DUTOutputLossFrequency parameter. | |DUTOutputLossTemperature|float64|Specifies the physical temperature of the ohmic loss elements specified by the RFMXSpecAn_ATTR_NF_DUT_OUTPUT_LOSS attribute. This value is expressed in kelvin. | |arraySize|int32|Specifies the size of the 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_NFCfgCalibrationLoss

int32 __stdcall RFmxSpecAn_NFCfgCalibrationLoss (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 calibrationLossCompensationEnabled, float64 calibrationLossFrequency[], float64 calibrationLoss[], float64 calibrationLossTemperature, int32 arraySize);

Purpose

Configures the ohmic loss, as a function of frequency, of the loss elements between the noise source and the input port of the analyzer during the calibration step, excluding the loss specified as the noise source loss.

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.
calibrationLossCompensationEnabled int32 Specifies whether the noise figure (NF) measurement accounts for the ohmic losses between the noise source and input port of the analyzer during the calibration step, excluding any losses which you have specified using the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS attribute.
RFMXSPECAN_VAL_NF_CALIBRATION_LOSS_COMPENSATION_ENABLED_FALSE (0) The NF measurement ignores the ohmic losses.
RFMXSPECAN_VAL_NF_CALIBRATION_LOSS_COMPENSATION_ENABLED_TRUE (1) The NF measurement accounts for the ohmic losses.

| :- | :- | :- | |calibrationLossFrequency|float64[]|Specifies an array of frequencies corresponding to the ohmic losses between the source and the input port of the analyzer. This value is expressed in Hz. This parameter is applicable only when you set the RFMXSPECAN_ATTR_NF_Y_FACTOR_MODE attribute to RFMXSPECAN_VAL_NF_COLD_SOURCE_MODE_CALIBRATE and set the RFMXSPECAN_ATTR_NF_MEASUREMENT_METHOD attribute to RFMXSPECAN_VAL_NF_MEASUREMENT_METHOD_COLD_SOURCE. | |calibrationLoss|float64[]|Specifies the array of ohmic losses between the noise source and input port of the analyzer during calibration, as a function of frequency. You must exclude any loss specified by the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_LOSS attribute. This loss is accounted for by the NF measurement when you set the calibrationLossCompensationEnabled parameter to RFMXSPECAN_VAL_NF_CALIBRATION_LOSS_COMPENSATION_ENABLED_TRUE.
This parameter specifies the frequencies at which the calibrationLossFrequency parameter measures the losses. | |calibrationLossTemperature|float64|Specifies the physical temperature of the ohmic loss elements specified by the RFMXSPECAN_ATTR_NF_CALIBRATION_LOSS attribute. This value is expressed in kelvin. | |arraySize|int32|Specifies the size of the 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_NFCfgColdSourceMode

int32 __stdcall RFmxSpecAn_NFCfgColdSourceMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 coldSourceMode);

Purpose

Configures the cold source based noise figure (NF) measurement to perform the calibration step or the measurement step.

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.
coldSourceMode int32 Specifies whether the measurement should calibrate the noise characteristics of the analyzer or compute the noise characteristics of the DUT for the cold source method.
RFMXSPECAN_VAL_NF_COLD_SOURCE_MODE_MEASURE (0) NF measurement computes the noise characteristics of the DUT and compensates for the noise figure of the analyzer.
RFMXSPECAN_VAL_NF_COLD_SOURCE_MODE_CALIBRATE (1) NF measurement computes the noise characteristics of the analyzer.

| :- | :- | :- |

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_NFCfgColdSourceInputTermination

int32 __stdcall RFmxSpecAn_NFCfgColdSourceInputTermination (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 terminationVSWR[], float64 terminationVSWRFrequency[], float64 terminationTemperature, int32 arraySize);

Purpose

Configures the characteristics of the microwave termination used as a noise source in the cold source method.

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.
terminationVSWR float64[] Specifies an array of voltage standing wave ratios (VSWR) as a function of frequency of the microwave termination used as the noise source in cold source method. The corresponding array of frequencies is specified by the terminationVSWRFrequency parameter.
In most cases, the exact VSWR of the microwave termination may not be known. Hence, NI recommends that you set this parameter to an empty array, in which case the noise figure (NF) measurement assumes that the VSWR of the microwave termination is unity for all frequencies.
terminationVSWRFrequency float64[] Specifies an array of frequencies corresponding to the VSWRs of the microwave termination used in the cold source method as specified by the terminationVSWR parameter. This value is expressed in Hz.
terminationTemperature float64 Specifies the physical temperature of the microwave termination used as the noise source in the cold source method. This value is expressed in kelvin.
arraySize int32 Specifies the size of the 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_NFCfgColdSourceDUTSParameters

int32 __stdcall RFmxSpecAn_NFCfgColdSourceDUTSParameters (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 DUTSParametersFrequency[], float64 DUTS21[], float64 DUTS12[], float64 DUTS11[], float64 DUTS22[], int32 arraySize);

Purpose

Configures the scattering parameters of the DUT as a function of the frequency, for use in the cold source measurement method.

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.
DUTSParametersFrequency float64[] Specifies the array of frequencies corresponding to the s-parameters of the DUT specified by the DUTS21, DUTS12, DUTS11, and DUTS22 parameters. This value is expressed in Hz.
DUTS21 float64[] Specifies an array of the gains of the DUT as a function of frequency, when the output port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
DUTS12 float64[] Specifies an array of the input-isolations of the DUT as a function of frequency, when the input port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
DUTS11 float64[] Specifies an array of the input-reflections of the DUT as a function of frequency, when the output port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
DUTS22 float64[] Specifies an array of the output-reflections of the DUT as a function of frequency, when the input port of the DUT is terminated with an impedance equal to the characteristic impedance. This value is expressed in dB. The corresponding array of frequencies is specified by the DUTSParametersFrequency parameter.
arraySize int32 Specifies the size of the 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_NFValidateCalibrationData

int32 __stdcall RFmxSpecAn_NFValidateCalibrationData( niRFmxInstrHandle instrumentHandle, char selectorString[], int32* calibrationDataValid );

Purpose

Indicates whether calibration data is valid for configuration specified by the signal name in the Selector string attribute.

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.
calibrationDataValid int32* Returns whether the calibration data is valid.
RFMXSPECAN_VAL_CALIBRATION_DATA_VALID_FALSE (0) Returns false if the calibration data is not present for one or more frequency points in the list.
RFMXSPECAN_VAL_CALIBRATION_DATA_VALID_TRUE (1) Returns true if the calibration data is present for all frequencies in the list.

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

| :- | :- | :- |

Phasenoise Configure

RFmxSpecAn_PhaseNoiseCfgRangeDefinition

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgRangeDefinition (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 rangeDefinition);

Purpose

Specifies how the measurement computes offset subranges.

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.
rangeDefinition int32 Specifies how the measurement computes offset subranges.
RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_MANUAL (0) Specify the offset sub-ranges used for the measurement. Use the RFMXSPECAN_ATTR_PHASENOISE_RANGE_START_FREQUENCY attribute and the RFMXSPECAN_ATTR_PHASENOISE_RANGE_STOP_FREQUENCY attribute to configure single or multiple range start and range stop frequencies.
RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO (1) Measurement computes offset sub-ranges by dividing the user configured offset range into multiple decade sub-ranges. The range is specified by the RFMXSPECAN_ATTR_PHASENOISE_START_FREQUENCY and the RFMXSPECAN_ATTR_PHASENOISE_STOP_FREQUENCY attributes.

| :- | :- | :- |

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_PhaseNoiseCfgAutoRange

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgAutoRange (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 startFrequency, float64 stopFrequency, float64 RBWPercentage);

Purpose

Configures the offset range and the RBW percentage when you set the RFMXSpecAn_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO.

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.
startFrequency float64 Specifies the start frequency of the offset frequency when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO. This value is expressed in Hz.
stopFrequency float64 Specifies the stop frequency of the offset frequency range when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO. This value is expressed in Hz.
RBWPercentage float64 Specifies the RBW as a percentage of the start frequencyof each sub-range when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_AUTO. This value is expressed as a percentage.

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_PhaseNoiseCfgNumberOfRanges

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

Purpose

Configures the number of offset ranges when you set the RFMXSpecAn_ATTR_PHASENOISE_RANGE_DEFINITION attribute to Manual.

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.
numberOfRanges int32 Specifies the number of manual 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_PhaseNoiseCfgRangeArray

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgRangeArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 rangeStartFrequency[], float64 rangeStopFrequency[], float64 rangeRBWPercentage[], int32 rangeAveragingCount[], int32 numberOfElements);

Purpose

Configures an array of the offset range, RBW percentage and averaging count when you set the RFMXSpecAn_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_MANUAL.

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.
rangeStartFrequency float64[] Specifies the start frequency for the specified subrange when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_MANUAL.
rangeStopFrequency float64[] Specifies the stop frequency for the specified subrange when you set the RFMXSPECAN_ATTR_PHASENOISE_RANGE_DEFINITION attribute to RFMXSPECAN_VAL_PHASENOISE_RANGE_DEFINITION_MANUAL. This value is expressed in Hz.
rangeRBWPercentage float64[] Specifies the RBW of the start offset of each sub-range. This value is expressed as a percentage.
rangeAveragingCount int32[] Specifies the averaging count for the specified 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_PhaseNoiseCfgAveragingMultiplier

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgAveragingMultiplier (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingMultiplier);

Purpose

Configures the averaging multiplier.

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.
averagingMultiplier int32 Specifies the factor by which the averaging count for each sub-range to increase.

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_PhaseNoiseCfgSmoothing

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgSmoothing (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 smoothingType, float64 smoothingPercentage);

Purpose

Configures the smoothing type and smoothing percentage used to smoothen the measured log plot trace.

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.
smoothingType int32 Specifies the smoothing type used to smoothen a log plot trace.
RFMXSPECAN_VAL_PHASENOISE_SMOOTHING_TYPE_NONE (0) Smoothing is disabled.
RFMXSPECAN_VAL_PHASENOISE_SMOOTHING_TYPE_LINEAR (1) Performs linear moving average filtering on the measured phase noise log plot trace.
RFMXSPECAN_VAL_PHASENOISE_SMOOTHING_TYPE_LOGARITHMIC (2) Performs logarithmic moving average filtering on the measured phase noise log plot trace.
RFMXSPECAN_VAL_PHASENOISE_SMOOTHING_TYPE_MEDIAN (3) Performs moving median filtering on the measured phase noise log plot trace.

| :- | :- | :- | |smoothingPercentage|float64|Specifies the number of points to use in the moving average filter as a percentage of total number of points in the log plot trace. This value is expressed as a percentage. |

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_PhaseNoiseCfgSpotNoiseFrequencyList

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgSpotNoiseFrequencyList (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 frequencyList[], int32 arraySize);

Purpose

Configures a list of frequencies at which the phase noise values are to be read using the smoothed log plot trace.

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.
frequencyList float64[] Specifies an array of offset frequencies at which the corresponding phase noise is measured using the smoothed log plot trace. This value is expressed in Hz.
arraySize int32 Specifies the size of the 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_PhaseNoiseCfgIntegratedNoise

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgIntegratedNoise (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 integratedNoiseRangeDefinition, float64 integratedNoiseStartFrequency[], float64 integratedNoiseStopFrequency[], int32 arraySize);

Purpose

Configures the integrated noise ranges. The smoothed log plot trace is used when computing integrated measurements.

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.
integratedNoiseRangeDefinition int32 Specifies whether to use the complete measurement range for computing integrated measurements, or to use the range that you specify.
integratedNoiseStartFrequency float64[] Specifies an array of the start frequencies for integrated measurement. This value is expressed in Hz.
integratedNoiseStopFrequency float64[] Specifies an array of the stop offset frequencies for integrated measurement. This value is expressed in Hz.
arraySize int32 Specifies the size of the 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_PhaseNoiseCfgSpurRemoval

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgSpurRemoval (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 spurRemovalEnabled, float64 peakExcursion);

Purpose

Configures enabling or disabling of the spur removal and the peak excursion to use when spur removal is enabled.

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.
spurRemovalEnabled int32 Specifies whether the spur removal is enabled or disabled.
RFMXSPECAN_VAL_PHASENOISE_SPUR_REMOVAL_ENABLED_FALSE (0) Disables spur removal on the log plot trace.
RFMXSPECAN_VAL_PHASENOISE_SPUR_REMOVAL_ENABLED_TRUE (1) Enables spur removal on the log plot trace.

| :- | :- | :- | |peakExcursion|float64|Specifies the minimum amplitude variation required in a signal to be considered as a peak. The signal must rise and fall above the threshold level by at least the peak excursion value to be considered as an eligible peak. The threshold is a curve fit performed on the measured phase noise.|

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_PhaseNoiseCfgCancellation

int32 __stdcall RFmxSpecAn_PhaseNoiseCfgCancellation (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 cancellationEnabled, float64 cancellationThreshold, float32 frequency[], float32 referencePhaseNoise[], int32 arraySize);

Purpose

Configures the enabling or disabling of the phase noise cancellation, threshold cancellation, and the reference phase noise used for cancellation.

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.
cancellationEnabled int32 Specifies whether to enable or disable the phase noise cancellation.
RFMXSPECAN_VAL_PHASENOISE_CANCELLATION_ENABLED_FALSE (0) Disables phase noise cancellation.
RFMXSPECAN_VAL_PHASENOISE_CANCELLATION_ENABLED_TRUE (1) Enables phase noise cancellation. Specify the value to be used for phase noise cancellation in the RFMXSPECAN_ATTR_PHASENOISE_CANCELLATION_REFERENCE_PHASE_NOISE attribute.

| :- | :- | :- | |cancellationThreshold|float64|Specifies the minimum delta between the reference and pre-cancellation traces that must exist before any cancellation is performed. The delta is evaluated on a bin per bin basis. This value is expressed in dB.| |frequency|float32[]|Specifies an array of frequency offsets where the reference phase noise has been measured. This value is expressed in Hz. | |referencePhaseNoise|float32[]|Specifies an array of the reference phase noise at the frequency offsets. This value is expressed in dBc/Hz.| |arraySize|int32|Specifies the size of the 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

| :- | :- | :- |

PAVT Configure

RFmxSpecAn_PAVTCfgMeasurementLocationType

int32 __stdcall RFmxSpecAn_PAVTCfgMeasurementLocationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 measurementLocationType);

Purpose

Configures the measurement location type for the segments.

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.
measurementLocationType int32 Specifies whether the location at which the segment is measured is indicated by time or trigger.
RFMXSPECAN_VAL_PAVT_MEASUREMENT_LOCATION_TYPE_TIME (0) The measurement is performed over a single record across multiple segments separated in time. The measurement locations of the segments are specified by the RFMXSPECAN_ATTR_PAVT_SEGMENT_START_TIME attribute. The number of segments is equal to the number of segment start times.
RFMXSPECAN_VAL_PAVT_MEASUREMENT_LOCATION_TYPE_TRIGGER (1) The measurement is performed across segments obtained in multiple records, where each record is obtained when a trigger is received. The number of segments is equal to the number of triggers (records).

| :- | :- | :- |

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_PAVTCfgMeasurementBandwidth

int32 __stdcall RFmxSpecAn_PAVTCfgMeasurementBandwidth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementBandwidth);

Purpose

Configures the measurement bandwidth.

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.
measurementBandwidth float64 Specifies the bandwidth over which the signal is measured. This value is expressed in Hz.

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_PAVTCfgMeasurementIntervalMode

int32 __stdcall RFmxSpecAn_PAVTCfgMeasurementIntervalMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 measurementIntervalMode);

Purpose

Configures the measurement interval mode.

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.
measurementIntervalMode int32 Specifies the mode of configuring the measurement interval.
RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_UNIFORM (0) The time offset from the start of segment and the duration over which the measurement is performed is uniform for all segments and is given by the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_OFFSET attribute respectively.
RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE (1) The time offset from the start of segment and the duration over which the measurement is performed is configured separately for each segment and is given by the RFMXSPECAN_ATTR_PAVT_SEGMENT_MEASUREMENT_OFFSET attribute respectively.

| :- | :- | :- |

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_PAVTCfgNumberOfSegments

int32 __stdcall RFmxSpecAn_PAVTCfgNumberOfSegments (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfSegments);

Purpose

Configures the number of segments.

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.
numberOfSegments int32 Specifies the number of segments to be measured.

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_PAVTCfgSegmentType

int32 __stdcall RFmxSpecAn_PAVTCfgSegmentType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 segmentType);

Purpose

Configures the segment type.

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.
segmentType int32 Specifies the type of segment.
RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_PHASE_AND_AMPLITUDE (0) Phase and amplitude is measured in this segment.
RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_AMPLITUDE (1) Amplitude is measured in this segment.
RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_FREQUENCY_ERROR_MEASUREMENT (2) Frequency error is measured in this segment.

| :- | :- | :- |

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_PAVTCfgSegmentStartTimeStep

int32 __stdcall RFmxSpecAn_PAVTCfgSegmentStartTimeStep (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfSegments, float64 segment0StartTime, float64 segmentInterval);

Purpose

Configures the list of the segment start times based on segment0StartTime and segmentInterval. This function is used when the segments to be measured have equal duration.

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.
numberOfSegments int32 Specifies the number of segments to be measured.
segment0StartTime float64 Specifies the start time for segment0. This value is expressed in seconds.
segmentInterval float64 Specifies the difference in the start times between consecutive segments. This value is expressed in seconds.

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_PAVTCfgSegmentStartTimeList

int32 __stdcall RFmxSpecAn_PAVTCfgSegmentStartTimeList (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 segmentStartTime[], int32 numberOfElements);

Purpose

Configures the list of the segment start times.

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.
segmentStartTime float64[] Specifies the start time of measurement of the segments. This value is expressed in seconds. You can use this parameter only when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_LOCATION_TYPE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_LOCATION_TYPE_TIME.
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_PAVTCfgMeasurementInterval

int32 __stdcall RFmxSpecAn_PAVTCfgMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurermentOffset, float64 measurermentLength);

Purpose

Configures the measurement offset and measurement length for the segments.

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.
measurermentOffset float64 Specifies the time offset from the start of the segment for which the phase and amplitude values are computed. This value is expressed in seconds. The default value is 0.
measurermentLength float64 Specifies the duration within the segment over which the phase and amplitude values are computed. This value is expressed in seconds. The default value is 1 millisecond.

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_PAVTCfgSegmentMeasurementInterval

int32 __stdcall RFmxSpecAn_PAVTCfgSegmentMeasurementInterval (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 segmentMeasurementOffset, float64 segmentMeasurementLength);

Purpose

Configures the segment measurement offset and length for the segments.

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.
segmentMeasurementOffset float64 Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE.
segmentMeasurementLength float64 Specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE.

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

| :- | :- | :- |

PAVT Array Apis

RFmxSpecAn_PAVTCfgSegmentTypeArray

int32 __stdcall RFmxSpecAn_PAVTCfgSegmentTypeArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 segmentType[], int32 numberOfElements);

Purpose

Configures an array of segment types.

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.
segmentType int32[] Specifies the type of segment.
RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_PHASE_AND_AMPLITUDE (0) Phase and amplitude is measured in this segment.
RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_AMPLITUDE (1) Amplitude is measured in this segment.
RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_FREQUENCY_ERROR_MEASUREMENT (2) Frequency error is measured in this segment.

| :- | :- | :- | |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_PAVTCfgSegmentMeasurementIntervalArray

int32 __stdcall RFmxSpecAn_PAVTCfgSegmentMeasurementIntervalArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 segmentMeasurementOffset[], float64 segmentMeasurementLength[], int32 numberOfElements);

Purpose

Configures an array of segment measurement offsets and lengths for the segments.

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.
segmentMeasurementOffset float64[] Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE.
segmentMeasurementLength float64[] Specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the RFMXSPECAN_ATTR_PAVT_MEASUREMENT_INTERVAL_MODE attribute to RFMXSPECAN_VAL_PAVT_MEASUREMENT_INTERVAL_MODE_VARIABLE.
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

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

Getting started with moniker based streaming
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