NI RFmx SpecAn Configuration Functions

Configuration Functions

• RFmxSpecAn_CfgRF
• RFmxSpecAn_CfgFrequency
• RFmxSpecAn_CfgReferenceLevel
• RFmxSpecAn_AutoLevel
• RFmxSpecAn_CfgExternalAttenuation
• Trigger
  • RFmxSpecAn_CfgIQPowerEdgeTrigger
  • RFmxSpecAn_CfgSoftwareEdgeTrigger
  • RFmxSpecAn_CfgDigitalEdgeTrigger
  • RFmxSpecAn_DisableTrigger
• RFmxSpecAn_SendSoftwareEdgeTrigger
• RFmxSpecAn_CfgFrequencyReference
• RFmxSpecAn_CfgRFAttenuation
• RFmxSpecAn_CfgMechanicalAttenuation
• ACP
• CCDF
  • RFmxSpecAn_CCDFCfgMeasurementInterval
  • RFmxSpecAn_CCDFCfgRBWFilter
  • RFmxSpecAn_CCDFCfgNumberOfRecords
  • RFmxSpecAn_CCDFCfgThreshold
• CHP
• Fcnt
  • RFmxSpecAn_FCntCfgMeasurementInterval
  • RFmxSpecAn_FCntCfgRBWFilter
  • RFmxSpecAn_FCntCfgThreshold
  • RFmxSpecAn_FCntCfgAveraging
• Harmonics
  • RFmxSpecAn_HarmCfgFundamentalRBW
  • RFmxSpecAn_HarmCfgFundamentalMeasurementInterval
  • RFmxSpecAn_HarmCfgNumberOfHarmonics
  • RFmxSpecAn_HarmCfgAutoHarmonics
  • RFmxSpecAn_HarmCfgHarmonic
  • RFmxSpecAn_HarmCfgAveraging
  • RFmxSpecAn_HarmCfgHarmonicArray
• OBW
  • RFmxSpecAn_OBWCfgSpan
  • RFmxSpecAn_OBWCfgBandwidthPercentage
  • RFmxSpecAn_OBWCfgPowerUnits
  • RFmxSpecAn_OBWCfgRBWFilter
  • RFmxSpecAn_OBWCfgSweepTime
  • RFmxSpecAn_OBWCfgAveraging
  • RFmxSpecAn_OBWCfgFFT
• SEM
• Spectrum
• Spur
• TXP
  • RFmxSpecAn_TXPCfgMeasurementInterval
  • RFmxSpecAn_TXPCfgRBWFilter
  • RFmxSpecAn_TXPCfgThreshold
  • RFmxSpecAn_TXPCfgAveraging
  • RFmxSpecAn_TXPCfgVBWFilter
• AMPM
• DFD
• IQ
  • RFmxSpecAn_IQCfgAcquisition
  • RFmxSpecAn_IQCfgBandwidth
• IM
• NF
• Phasenoise
  • RFmxSpecAn_PhaseNoiseCfgRangeDefinition
  • RFmxSpecAn_PhaseNoiseCfgAutoRange
  • RFmxSpecAn_PhaseNoiseCfgNumberOfRanges
  • RFmxSpecAn_PhaseNoiseCfgRangeArray
  • RFmxSpecAn_PhaseNoiseCfgAveragingMultiplier
  • RFmxSpecAn_PhaseNoiseCfgSmoothing
  • RFmxSpecAn_PhaseNoiseCfgSpotNoiseFrequencyList
  • RFmxSpecAn_PhaseNoiseCfgIntegratedNoise
  • RFmxSpecAn_PhaseNoiseCfgSpurRemoval
  • RFmxSpecAn_PhaseNoiseCfgCancellation
• PAVT

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

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

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

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

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

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