niWLANA_SetAmplitudeCorrectionEnabled

NI WLAN Analysis Toolkit 18.0 Help

Edition Date: October 2018

Part Number: 373724K-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niWLANA_SetAmplitudeCorrectionEnabled (niWLANAnalysisSession session, char channelString[], int32 value);

Purpose

Sets the NIWLANA_AMPLITUDE_CORRECTION_ENABLED attribute.

Parameters

Input
Name Type Description
session niWLANAnalysisSession Specifies the niWLAN analysis session refnum.
channelString char[] Set this parameter to "" (empty string) or NULL.
value int32 Specifies whether to enable amplitude correction based on the correction table. The default value is NIWLANA_VAL_AMPLITUDE_CORRECTION_ENABLED_FALSE.
NIWLANA_VAL_AMPLITUDE_CORRECTION_ENABLED_FALSE(0)

Disables amplitude correction.

NIWLANA_VAL_AMPLITUDE_CORRECTION_ENABLED_TRUE (1)

Enables amplitude correction.

If spectrum measurements are enabled, linear interpolation is used to get the per frequency bin correction values for computing power spectra.

If I/Q measurements are enabled, amplitude correction corresponding to the center frequency is interpolated and written to the NIRFSA_ATTR_EXTERNAL_GAIN attribute. You must set the amplitude correction tables using the niWLANA_SetAmplitudeCorrectionTable function. Select the amplitude correction table for each analyzer using the niWLANA_SelectAmplitudeCorrectionTable 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 niWLAN 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 niWLANA_GetErrorString function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful