FetchTotalHarmonicDistortion(string, double, out double, out double, out double)
- Updated2025-10-13
- 1 minute(s) read
Fetches the total harmonics distortion (THD), measured as a percentage of the power in the fundamental signal.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int FetchTotalHarmonicDistortion(string selectorString, double timeout, out double totalHarmonicDistortion, out double averageFundamentalPower, out double fundamentalFrequency)
Remarks
This method maps to the RFmxSpecAn_HarmFetchTHD() function in C.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Specifies the result name. Example: "", "result::r1". You can use the BuildResultString(string) method to build the selector string. |
| timeout | double | Specifies the timeout, in seconds, 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. |
| totalHarmonicDistortion | out double | Upon return, contains the THD, measured as a percentage of the power in the fundamental signal. THD calculation involves only the harmonics that are enabled. |
| averageFundamentalPower | out double | Upon return, contains the average power, in dBm, measured at the fundamental frequency. |
| fundamentalFrequency | out double | Upon return, contains the frequency, in hertz (Hz), used as the fundamental frequency. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.