NI WLAN Analysis Toolkit

niWLANA_GetOFDMDemodCarrierFrequencyOffsetCCDFTrace

  • Updated2023-02-21
  • 1 minute(s) read

int32 __stdcall niWLANA_GetOFDMDemodCarrierFrequencyOffsetCCDFTrace( niWLANAnalysisSession session, char channelString[], double *minBin, double *binSize, double CCDF[], int CCDFArraySize, int *actualCCDFArraySize);

Purpose

Returns the Complementary Cumulative Distribution Function (CCDF) trace of the absolute carrier frequency offsets measured on the 802.11ax Trigger-Based PPDUs over the number of averages. You can query this trace when you set the NIWLANA_OFDM_DEMOD_TRACE_SETTINGS_CARRIER_FREQUENCY_OFFSET_CCDF_TRACE_ENABLED and NIWLANA_OFDM_DEMOD_CARRIER_FREQUENCY_OFFSET_ESTIMATION_ENABLED attributes to NIWLANA_VAL_TRUE.

Parameters

Input
Name Type Description
session niWLANAnalysisSession Specifies the niWLAN analysis session refnum.
channelString char[] Specifies the active channel string.
CCDFArraySize int Specifies the size of the CCDF array.
Output
Name Type Description
minBin double* Indicates the bin centered at the minimum absolute carrier frequency offset value.
binSize double* Indicates the size of each bin.
CCDF double[] Indicates an array of CCDF values of the absolute carrier frequency offsets.
actualCCDFArraySize int* Returns the number of elements in the CCDF array. If the CCDF array is not large enough to hold all the samples, the function returns an error and this parameter returns the minimum expected size of the CCDF array.

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

Log in to get a better experience