NI RFmx SpecAn TXP Configuration Functions

TXP Configuration Functions

• RFmxSpecAn_TXPCfgMeasurementInterval
• RFmxSpecAn_TXPCfgRBWFilter
• RFmxSpecAn_TXPCfgThreshold
• RFmxSpecAn_TXPCfgAveraging
• RFmxSpecAn_TXPCfgVBWFilter

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) function to build the selector string).
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) function to build the selector string).
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) function to build the selector string).
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) function to build the selector string).
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) function to build the selector string).
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