niWLANA_GetOFDMDemodSpectralFlatnessMargin
- Updated2023-02-21
- 1 minute(s) read
int32 __stdcall niWLANA_GetOFDMDemodSpectralFlatnessMargin (niWLANAnalysisSession session, char channelString[], float64 *spectralFlatnessMargin);
Purpose
Returns the minimum iterations of spectral flatness margin. Spectral flatness margin is the minimum margin of the upper and lower spectral flatness margins. This value is expressed in dB.
To understand which active channel strings are required to configure this function, refer to the NIWLANA_RESULT_OFDM_DEMOD_SPECTRAL_FLATNESS_MARGIN_AVERAGE attribute.
Refer to the Spectral Flatness Margin help topic for a graphical representation of the spectral flatness margin.
Parameters
| Input | ||
| Name | Type | Description |
| session | niWLANAnalysisSession | Specifies the niWLAN analysis session refnum. |
| channelString | char[] | Specifies the WLAN channel for which you want to fetch the measurement. |
| Output | ||
| Name | Type | Description |
| spectralFlatnessMargin | float64* | Returns the minimum value of the difference between the magnitude of the channel frequency response relative to the mean magnitude of a certain number of subcarriers around the DC subcarrier and the spectral flatness mask. This value is expressed in dB. |
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:
|
||||||||