RFmxPulseMXPulseResults.GetTimeSidelobePeakCorrelation Method
- Updated2024-07-17
- 1 minute(s) read
RFmxPulseMXPulseResultsGetTimeSidelobePeakCorrelation Method
Gets the peak correlation for all measured pulses. Peak correlation is the normalized peak power of the correlated output by both measured and reference pulse powers. This values ranges in between 0 to 1.
Namespace: NationalInstruments.RFmx.PulseMX
Assembly: NationalInstruments.RFmx.PulseMX.Fx40 (in NationalInstruments.RFmx.PulseMX.Fx40.dll) Version: 24.5.0.49283 (24.5.0.49283)
Syntax
public int GetTimeSidelobePeakCorrelation( string selectorString, ref double[] value )
Public Function GetTimeSidelobePeakCorrelation ( selectorString As String, ByRef value As Double() ) As Integer
Parameters
- selectorString
- Type: SystemString
Specifies the result name.
Example: ""
"result::r1"
You can use the BuildResultString(String) method to build the selectorString. - value
- Type: SystemDouble
Upon return, contains the peak correlation for all measured pulses. Peak correlation is the normalized peak power of the correlated output by both measured and reference pulse powers. This values ranges in between 0 to 1.
Return Value
Type: Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method gets the value of PulseResultsTimeSidelobePeakCorrelation attribute.