Configures averaging for the AMPM measurement.

Syntax

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

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_AMPM_AVERAGING_ENABLED_FALSE

0 (0x0)

The measurement is performed on a single acquisition.

RFMXSPECAN_VAL_AMPM_AVERAGING_ENABLED_TRUE

1 (0x1)

The AMPM measurement uses the RFMXSPECAN_ATTR_AMPM_AVERAGING_COUNT attribute as the number of acquisitions over which the signal for the AMPM 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.

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