RFmxDemodMXADemodResults.FetchAMMeanModulationDepth Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
Fetches amplitude-modulated (AM) mean modulation depth for analog demodulation measurements.
Namespace: NationalInstruments.RFmx.DemodMX
Assembly: NationalInstruments.RFmx.DemodMX.Fx40 (in NationalInstruments.RFmx.DemodMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int FetchAMMeanModulationDepth( string selectorString, double timeout, out double meanModulationDepth, out double meanHalfPeakToPeak, out double meanRms, out double meanPositivePeak, out double meanNegativePeak )
Public Function FetchAMMeanModulationDepth ( selectorString As String, timeout As Double, <OutAttribute> ByRef meanModulationDepth As Double, <OutAttribute> ByRef meanHalfPeakToPeak As Double, <OutAttribute> ByRef meanRms As Double, <OutAttribute> ByRef meanPositivePeak As Double, <OutAttribute> ByRef meanNegativePeak As Double ) As Integer
Parameters
- selectorString String
- Specifies the result name. Example: "", "result::r1". You can use the BuildResultString(String) method to build the selectorString.
- timeout Double
- Specifies the time, in seconds, for which the method waits for the measurement to complete. A value of -1 specifies that the method waits until the measurement is complete.
- meanModulationDepth Double
- Upon return, contains the mean amplitude variation, in percentage, around the unmodulated carrier amplitude. If the carrier is suppressed, the amplitude variation of the modulating signal is returned.
- meanHalfPeakToPeak Double
- Upon return, contains the mean (peak-to-peak)/2 amplitude, in percentage, of the modulating signal.
- meanRms Double
- Upon return, contains the mean RMS amplitude of the modulating signal.
- meanPositivePeak Double
- Upon return, contains the mean positive peak amplitude, in percentage, of the modulating signal.
- meanNegativePeak Double
- Upon return, contains the mean negative peak amplitude, in percentage, of the modulating signal.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method maps to the RFmxDemod_ADemodFetchAMMeanModulationDepth() function in C.