RFmx Pulse DotNET

Table of Contents

RFmxPulseMXPulseResults.GetTimeSidelobeCompressionRatio Method

  • Updated2024-07-17
  • 1 minute(s) read
RFmxPulseMXPulseResults.GetTimeSidelobeCompressionRatio Method

RFmxPulseMXPulseResultsGetTimeSidelobeCompressionRatio Method

Gets the compression ratio for all measured pulses. Compression ratio is the ratio of the mainlobe width to the pulse width. This value is expressed as a percentage.

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 GetTimeSidelobeCompressionRatio(
	string selectorString,
	ref double[] value
)
Public Function GetTimeSidelobeCompressionRatio ( 
	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 compression ratio for all measured pulses. Compression ratio is the ratio of the mainlobe width to the pulse width. This value is expressed as a percentage.

Return Value

Type: Int32
Returns the status code of this method. The status code either indicates success or describes a warning condition.

Remarks

This method gets the value of PulseResultsTimeSidelobeCompressionRatio attribute.

See Also

Log in to get a better experience