Interface GainResults

Result object for bode measurement.

Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Results

Assembly: OmicronLab.VectorNetworkAnalysis.AutomationInterface.dll (3.25.2208.0)

Syntax

[Guid("FB4779FB-540E-4BE1-8051-0CE4A4FC0529")]
[InterfaceType(ComInterfaceType.InterfaceIsDual)]
[ComVisible(true)]
public interface GainResults

Properties

Count

Gets the count of results, depending of the number of points.

Declaration

int Count { get; }

Property Value

Type	Description
System.Int32

MeasurementFrequencies

Gets the measurement frequencies and returns as an array.

Declaration

double[] MeasurementFrequencies { get; }

Property Value

Type	Description
System.Double[]

OverloadLevel

Gets the overload level values from Channel 1 and Channel 2.

Declaration

OverloadResult OverloadLevel { get; }

Property Value

Type	Description
OverloadResult

Vrms

Gets the root mean square voltage values of Channel 1 and Channel 2.

Declaration

Vrms Vrms { get; }

Property Value

Type	Description
Vrms	The Vrms.

Methods

CalculateFResQValues(Boolean, Boolean, FResQFormats)

Calculates the resonance frequency and q factor values.

Declaration

FResQResult CalculateFResQValues(bool searchForPeak, bool yLog, FResQFormats format)

Parameters

Type	Name	Description
System.Boolean	searchForPeak	if set to true the algorithm is searching for a peak (as opposed to a dip).
System.Boolean	yLog	if set to true the y axis is interpolated in logarithmic scale.
FResQFormats	format	The format that should be used for the resonance frequency calculation (Real, Magnitude, Phase).

Returns

Type	Description
FResQResult

Remarks

NOTE that log and Phase format can NOT be combined, because that would likely result in a log of a negative value! The interpolation is automatically done in linear scale for the Phase format.

CalculateStabilityMargins(Double)

Calculates the stability margins.

Declaration

StabilityMarginResult CalculateStabilityMargins(double instabilityPointReal)

Parameters

Type	Name	Description
System.Double	instabilityPointReal	The instability point as a real number (usually +1 or -1).

Returns

Type	Description
StabilityMarginResult

ComplexAt(Int32)

Gets the complex result value At the index of the array.

Declaration

Complex ComplexAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
Complex	The complex values At.

ComplexValues()

Gets the complex result values in an array.

Declaration

Complex[] ComplexValues()

Returns

Type	Description
Complex[]	The complex values.

GroupDelayTg()

Calculates the group delay Tg values and returns as an array.

Declaration

double[] GroupDelayTg()

Returns

Type	Description
System.Double[]	The Group delay Tg values.

GroupDelayTgAt(Int32)

Calculates the group delay Tg At the index of the array.

Declaration

double GroupDelayTgAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
System.Double	The Tg At.

Imaginary()

Calculates the imaginary part of the complex values and returns as an array.

Declaration

double[] Imaginary()

Returns

Type	Description
System.Double[]

ImaginaryAt(Int32)

Calculates the imaginary part of the complex value at the index of the array.

Declaration

double ImaginaryAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
System.Double

Magnitude(MagnitudeUnit)

Calculates the magnitude values with the specified unit and returns as an array.

Declaration

double[] Magnitude(MagnitudeUnit unit)

Parameters

Type	Name	Description
MagnitudeUnit	unit	The magnitude unit.

Returns

Type	Description
System.Double[]

MagnitudeAt(Int32, MagnitudeUnit)

Calculates the magnitude with the specified unit At the index of the array.

Declaration

double MagnitudeAt(int index, MagnitudeUnit unit)

Parameters

Type	Name	Description
System.Int32	index	The index.
MagnitudeUnit	unit	The magnitude unit.

Returns

Type	Description
System.Double

MeasurementFrequencyAt(Int32)

Gets the measurement frequency At the index of the array.

Declaration

double MeasurementFrequencyAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
System.Double	The measurement frequency At.

Phase(AngleUnit)

Calculates the phases values with the specified unit and returns as an array.

Declaration

double[] Phase(AngleUnit unit)

Parameters

Type	Name	Description
AngleUnit	unit	The angle unit.

Returns

Type	Description
System.Double[]

PhaseAt(Int32, AngleUnit)

Calculates the phase with the specified unit At the index of the array.

Declaration

double PhaseAt(int index, AngleUnit unit)

Parameters

Type	Name	Description
System.Int32	index	The index.
AngleUnit	unit	The phase unit.

Returns

Type	Description
System.Double

QTg()

Gets the Q factor of the group delay Tg values and returns as an array.

Declaration

double[] QTg()

Returns

Type	Description
System.Double[]	The QTg.

QTgAt(Int32)

Calculates the Q factor of the group delay Tg value At the index of the array.

Declaration

double QTgAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
System.Double	The QTg At.

Real()

Calculates the real part of the complex values and returns as an array.

Declaration

double[] Real()

Returns

Type	Description
System.Double[]

RealAt(Int32)

Calculates the real part of the complex value At the index of the array.

Declaration

double RealAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
System.Double

UnwrappedPhase(AngleUnit)

Calculate the unwrapped the phase values and returns as an array.

Declaration

double[] UnwrappedPhase(AngleUnit unit)

Parameters

Type	Name	Description
AngleUnit	unit	The angle unit.

Returns

Type	Description
System.Double[]

UnwrappedPhaseAt(Int32, AngleUnit)

Calculates the unwrapped phase with the specified unit At the index of the array.

Declaration

double UnwrappedPhaseAt(int index, AngleUnit unit)

Parameters

Type	Name	Description
System.Int32	index	The index.
AngleUnit	unit	The phase unit.

Returns

Type	Description
System.Double