Configures the resolution bandwidth (RBW) filter.

Syntax

int32 __stdcall RFmxSpecAn_OBWCfgRBWFilter(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 rbwAuto, float64 rbw, int32 rbwFilterType)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function.

selectorString[in]char

This parameter specifies a Selector String comprising of the signal name. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string).
Example:
""
"signal::sig1"
You can use the RFmxSpecAn_BuildSignalString function to build the selector string.

rbwAuto[in]int32

This parameter specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the Spectral Measurements Concepts topic for more details on RBW and sweep time. The default value is True.

Name

Value

Description

RFMXSPECAN_VAL_OBW_RBW_AUTO_FALSE

0 (0x0)

The measurement uses the RBW that you specify in the RFMXSPECAN_ATTR_OBW_RBW_FILTER_BANDWIDTH attribute.

RFMXSPECAN_VAL_OBW_RBW_AUTO_TRUE

1 (0x1)

The measurement computes the RBW.

rbw[in]float64

This parameter specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBW Auto parameter to False. This value is expressed in Hz. The default value is 10 kHz.

rbwFilterType[in]int32

This parameter specifies the response of the digital RBW filter. The default value is Gaussian.

Name

Value

Description

RFMXSPECAN_VAL_OBW_RBW_FILTER_TYPE_FFT_BASED

0 (0x0)

No RBW filtering is performed.

RFMXSPECAN_VAL_OBW_RBW_FILTER_TYPE_GAUSSIAN

1 (0x1)

The RBW filter has a Gaussian response.

RFMXSPECAN_VAL_OBW_RBW_FILTER_TYPE_FLAT

2 (0x2)

The RBW filter has a flat response.

Returns

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

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

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors