Read(string, double, out double, out double, out double, out int)
- Updated2025-10-13
- 1 minute(s) read
Configures hardware for acquisition, performs measurement on acquired data, and returns complementary cumulative distribution function (CCDF) measurement results.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int Read(string selectorString, double timeout, out double meanPower, out double meanPowerPercentile, out double peakPower, out int measuredSamplesCount)
Remarks
This method maps to the RFmxSpecAn_CCDFRead() function in C.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Pass an empty string. The signal name that is passed when creating the signal configuration is used. |
| 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. |
| meanPower | out double | Upon return, contains the average power, in dBm, of all the samples. If you set the RFmxSpecAnMXCcdfThresholdEnabled to True, samples above the threshold are measured. |
| meanPowerPercentile | out double | Upon return, contains the percentage of samples that have more power than the mean power. |
| peakPower | out double | Upon return, contains the peak power of the acquired signal, relative to the mean power. |
| measuredSamplesCount | out int | Upon return, contains the total number of samples measured. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.