Gets the overshoot values computed for all measured pulses. The overshoot value is defined as the ratio of height of the local peak after a rising edge to the pulse amplitude. This value is expressed in units specified by SetMetricsAmplitudeDeviationUnit(string, RFmxPulseMXPulseMetricsAmplitudeDeviationUnit) method.

Syntax

Namespace: NationalInstruments.RFmx.PulseMX

public int GetOvershoot(string selectorString, ref double[] value)

Remarks

This method gets the value of PulseResultsOvershoot attribute.

Parameters

NameTypeDescription
selectorStringstring

Specifies the result name.
Example: ""
"result::r1"
You can use the BuildResultString(string) method to build the selectorString.

valueref double[]

Upon return, contains the overshoot values computed for all measured pulses. The overshoot value is defined as the ratio of height of the local peak after a rising edge to the pulse amplitude. This value is expressed in units specified by SetMetricsAmplitudeDeviationUnit(string, RFmxPulseMXPulseMetricsAmplitudeDeviationUnit) method.

Returns

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