ReadPaprFromFile(string, int, out double)
- Updated2025-10-13
- 1 minute(s) read
Returns the peak to average power ratio (PAPR) stored in the file. This method uses the waveformIndex as the key to read the waveform property.
Syntax
Namespace: NationalInstruments.ModularInstruments.NIRfsgPlayback
public static int ReadPaprFromFile(string filePath, int waveformIndex, out double papr)
Parameters
| Name | Type | Description |
|---|---|---|
| filePath | string | Specifies the absolute path to the TDMS file from which the playback library reads the waveform. |
| waveformIndex | int | Specifies the waveform number in the file for which you want to read the PAPR. |
| papr | out double | Returns the PAPR stored in the file for the waveform number you specified in the waveformIndex parameter. This value is expressed in dB. |
Returns
Returns the status code of this method. The status code either indicates success or describes a warning condition.