FetchSpectralFlatness(string, double, out double, out int)
- Updated2025-04-08
- 1 minute(s) read
Fetches the spectral flatness margin results.
Use "segment(n)/chain(k)/stream(l)" as the selector string to read results from this method.
Syntax
Namespace: NationalInstruments.RFmx.WlanMX
public int FetchSpectralFlatness(string selectorString, double timeout, out double spectralFlatnessMargin, out int spectralFlatnessMarginSubcarrierIndex)
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Specifies a selector string comprising of the result name, segment number, chain number, and stream number. Example: |
| timeout | double | Specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. |
| spectralFlatnessMargin | out double | Upon return, contains the spectral flatness margin, which is the minimum of the upper and lower spectral flatness margins. The upper spectral flatness margin is the minimum difference between the upper mask and the spectral flatness across subcarriers. The lower spectral flatness margin is the minimum difference between the spectral flatness and the lower mask across subcarriers. When you set the SetAveragingEnabled(string, RFmxWlanMXOfdmModAccAveragingEnabled) method to True , the spectral flatness is computed using the mean of the channel frequency response magnitude computed for each averaging count. This value is expressed in dB. |
| spectralFlatnessMarginSubcarrierIndex | out int | Upon return, contains the subcarrier index corresponding to the spectralFlatnessMargin parameter. |
Returns
Returns the status code of this method. The status code either indicates success or describes a warning condition.