Read(string, double, out double, out double, out double)
- Updated2025-10-13
- 1 minute(s) read
Configures hardware for acquisition, performs measurement on acquired data, and returns the frequency count (Fcnt) measurement results.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int Read(string selectorString, double timeout, out double averageRelativeFrequency, out double averageAbsoluteFrequency, out double meanPhase)
Remarks
This method maps to the RFmxSpecAn_FCntRead() 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. A value of -1 specifies that the method waits until the measurement is complete. |
| averageRelativeFrequency | out double | Upon return, contains the signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the Fcnt Threshold Enabled to True. |
| averageAbsoluteFrequency | out double | Upon return, contains the RF signal frequency. |
| meanPhase | out double | Upon return, contains the net phase of the vector sum of the I/Q samples used for frequency measurement. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.