Configures averaging for the IM measurement.

Syntax

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

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.

averagingEnabled[in]int32

This parameter specifies whether to enable averaging for the measurement. The default value is False.

Name

Value

Description

RFMXSPECAN_VAL_IM_AVERAGING_ENABLED_FALSE

0 (0x0)

The measurement is performed on a single acquisition.

RFMXSPECAN_VAL_IM_AVERAGING_ENABLED_TRUE

1 (0x1)

The IM measurement uses the RFMXSPECAN_ATTR_IM_AVERAGING_COUNT attribute as the number of acquisitions over which the IM measurement is averaged.

averagingCount[in]int32

This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

averagingType[in]int32

This parameter 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. The default value is RMS.

Name

Value

Description

RFMXSPECAN_VAL_IM_AVERAGING_TYPE_RMS

0 (0x0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

RFMXSPECAN_VAL_IM_AVERAGING_TYPE_LOG

1 (0x1)

The power spectrum is averaged in a logarithmic scale.

RFMXSPECAN_VAL_IM_AVERAGING_TYPE_SCALAR

2 (0x2)

The square root of the power spectrum is averaged.

RFMXSPECAN_VAL_IM_AVERAGING_TYPE_MAXIMUM

3 (0x3)

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

RFMXSPECAN_VAL_IM_AVERAGING_TYPE_MINIMUM

4 (0x4)

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

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