[Guid("5239F012-BF74-4FE9-AF14-71E3D7A2140B")]
[ClassInterface(ClassInterfaceType.None)]
[ComVisible(true)]
public sealed class Calibration : VnaCalibrationManager, INotifyPropertyChanged, IOnPropertyChanged, IDisposable, GainCalibration, ImpedanceCalibration, MultiModeCalibration, GainUserRange, GainFullRange, ImpedanceFullRange, ImpedanceUserRange, MultiModeFullRange, MultiModeUserRange

Constructors

Calibration(IMeasurementSuite<DeviceConfigurationBase, MeasurementTask>)

Initializes a new instance of the Calibration class.

Declaration

public Calibration(IMeasurementSuite<DeviceConfigurationBase, MeasurementTask> suite)

Parameters

Type	Name	Description
IMeasurementSuite<DeviceConfigurationBase, MeasurementTask>	suite	The measurement suite.

Properties

CalibrationValues

Gets or sets the calibration values.

Declaration

public CorrectionValues CalibrationValues { get; set; }

Property Value

Type	Description
CorrectionValues

FullRange

Gets the full range calibration settings.

Declaration

public ImpedanceFullRange FullRange { get; }

Property Value

Type	Description
ImpedanceFullRange	The full range calibration settings.

GainFullRange

Gets the full range calibration settings.

Declaration

public GainFullRange GainFullRange { get; }

Property Value

Type	Description
GainFullRange	The full range calibration settings.

GainUserRange

Gets the user range calibration settings.

Declaration

public GainUserRange GainUserRange { get; }

Property Value

Type	Description
GainUserRange	The user range calibration settings.

ImpedanceFullRange

Gets the full range calibration settings.

Declaration

public ImpedanceFullRange ImpedanceFullRange { get; }

Property Value

Type	Description
ImpedanceFullRange	The full range calibration settings.

ImpedanceUserRange

Gets the user range calibration settings.

Declaration

public ImpedanceUserRange ImpedanceUserRange { get; }

Property Value

Type	Description
ImpedanceUserRange	The user range calibration settings.

IsCalibrationExtrapolated

Gets a value indicating whether this calibration is extrapolated.

Declaration

public bool IsCalibrationExtrapolated { get; }

Property Value

Type	Description
bool

Load

Gets or sets the resistance value in Ω used for the load calibration.

Declaration

public double Load { get; set; }

Property Value

Type	Description
double	The load.

Remarks

In Ω.

ShortDelayTime

Gets or sets the short delay time.

Declaration

public double ShortDelayTime { get; set; }

Property Value

Type	Description
double	The short delay time.

Remarks

In picoseconds.

UserRange

Gets the user range calibration settings.

Declaration

public ImpedanceUserRange UserRange { get; }

Property Value

Type	Description
ImpedanceUserRange	The user range calibration settings.

Methods

GetCalibrationActiveState(CalibrationMode)

Gets the active state of the calibration depending on the calibration mode.

Declaration

public bool GetCalibrationActiveState(CalibrationMode calibrationMode)

Parameters

Type	Name	Description
CalibrationMode	calibrationMode	The calibration mode.

Returns

Type	Description
bool

GetCalibrationAvailableState(CalibrationMode)

Gets the availability of the calibration depending on the calibration mode.

Declaration

public bool GetCalibrationAvailableState(CalibrationMode calibrationMode)

Parameters

Type	Name	Description
CalibrationMode	calibrationMode	The calibration mode.

Returns

Type	Description
bool

GetCalibrationEnableState(CalibrationMode)

Gets the enabled state of the calibration depending on the calibration mode.

Declaration

public bool GetCalibrationEnableState(CalibrationMode calibrationMode)

Parameters

Type	Name	Description
CalibrationMode	calibrationMode	The calibration mode.

Returns

Type	Description
bool

GetMultiModeCalibrationType(CalibrationMode)

Gets the calibration multi mode toggle between Thru or Open/Short/Load.

Declaration

public CalibrationMultiModeToggle GetMultiModeCalibrationType(CalibrationMode mode)

Parameters

Type	Name	Description
CalibrationMode	mode	The mode.

Returns

Type	Description
CalibrationMultiModeToggle

LoadCalibration(CalibrationMode, string, Action<(CalibrationLoadingState State, string PathInformation)>)

Loads the calibration mode related calibration data from the user specified path.

Declaration

public bool LoadCalibration(CalibrationMode mode, string path, Action<(CalibrationLoadingState State, string PathInformation)> calibrationLoadingFailedHandler = null)

Parameters

Type	Name	Description
CalibrationMode	mode	The calibration mode.
string	path	The user specified file path. The file extension '.mcalx' is required.
Action<(CalibrationLoadingState State, string PathInformation)>	calibrationLoadingFailedHandler	The handler which will be used when an error occures during calibration file loading and the default error handling is not enough.

Returns

Type	Description
bool

Remarks

The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

LoadCalibration(string)

Loads the calibration data from the user specified path.

Declaration

[Obsolete("Please use 'LoadCalibration' from 'UserRange' and 'FullRange'.Changed because this allows more flexible calibration loading!)")]
public bool LoadCalibration(string path)

Parameters

Type	Name	Description
string	path	The user specified file path. The file extension '.mcalx' is required.

Returns

Type	Description
bool

Remarks

The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

LoadCalibrationFromStream(Stream)

Loads the calibration as stream.

Declaration

public bool LoadCalibrationFromStream(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The stream.

Returns

Type	Description
bool

LoadCalibrationFromStreamAsync(Stream)

Loads the calibration as stream asynchronous.

Declaration

public Task<bool> LoadCalibrationFromStreamAsync(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The stream.

Returns

Type	Description
Task<bool>

PrepareCalibrations(IMeasurementSuite)

Prepares the calibrations for the related suite to be in well defined state during calibration process.

Declaration

protected override void PrepareCalibrations(IMeasurementSuite suite)

Parameters

Type	Name	Description
IMeasurementSuite	suite	The suite.

Overrides

OmicronLab.BaseMidLayer.Calibration.VnaCalibrationManager.PrepareCalibrations(OmicronLab.BaseMidLayer.Interfaces.IMeasurementSuite)

SaveCalibration(string)

Saves the calibration data to the user specified path.

Declaration

public bool SaveCalibration(string path)

Parameters

Type	Name	Description
string	path	The user specified file path. The file extension '.mcalx' is required.

Returns

Type	Description
bool

Remarks

The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

SaveCalibrationAsStream(Stream)

Saves the calibration as stream.

Declaration

public bool SaveCalibrationAsStream(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The stream.

Returns

Type	Description
bool

SaveCalibrationAsStreamAsync(Stream)

Saves the calibration as stream asynchronous.

Declaration

public Task<bool> SaveCalibrationAsStreamAsync(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The stream.

Returns

Type	Description
Task<bool>

SaveCalibrationAsync(string)

Saves the calibration data to the specified path asynchronous.

Declaration

public Task<bool> SaveCalibrationAsync(string path)

Parameters

Type	Name	Description
string	path	The file path.

Returns

Type	Description
Task<bool>

SetCalibrationEnableState(CalibrationMode, bool)

Sets the enabled state of the related calibration mode.

Declaration

public void SetCalibrationEnableState(CalibrationMode calibrationMode, bool isEnabled)

Parameters

Type	Name	Description
CalibrationMode	calibrationMode	The calibration mode.
bool	isEnabled	if set to `true` the enabled state will be set; the disabled state otherwise.

SetMultiModeCalibrationType(CalibrationMultiModeToggle, CalibrationMode)

Sets the calibration multi mode toggle between Thru or Open/Short/Load.

Declaration

public CalibrationMultiModeToggle SetMultiModeCalibrationType(CalibrationMultiModeToggle type, CalibrationMode mode)

Parameters

Type	Name	Description
CalibrationMultiModeToggle	type	The type.
CalibrationMode	mode	The mode.

Returns

Type	Description
CalibrationMultiModeToggle

Remarks

Returns the actual set value. Will be changed in case of missing calibration.

Stop()

Stops the calibration if it is running.

Declaration

public override bool Stop()

Returns

Type	Description
bool	`true` if the test was stopped successful or was not running at all; otherwise, `false`.

Overrides

OmicronLab.BaseMidLayer.Calibration.VnaCalibrationManager.Stop()

Remarks

Depending on the OmicronLab.BaseMidLayer.Enumerations.SourceMode the source will be switched accordingly.

Events

FullRangeIsActiveChanged

Is active changed.

Declaration

public event FullRangeIsActiveChanged_Delegate FullRangeIsActiveChanged

Event Type

Type	Description
FullRangeIsActiveChanged_Delegate

FullRangeIsAvailableChanged

Is available changed.

Declaration

public event FullRangeIsAvailableChanged_Delegate FullRangeIsAvailableChanged

Event Type

Type	Description
FullRangeIsAvailableChanged_Delegate

UserRangeIsActiveChanged

Is active changed.

Declaration

public event UserRangeIsActiveChanged_Delegate UserRangeIsActiveChanged

Event Type

Type	Description
UserRangeIsActiveChanged_Delegate

UserRangeIsAvailableChanged

Is available changed.

Declaration

public event UserRangeIsAvailableChanged_Delegate UserRangeIsAvailableChanged

Event Type

Type	Description
UserRangeIsAvailableChanged_Delegate

Implements

INotifyPropertyChanged

OmicronLab.BaseCommon.Interfaces.IOnPropertyChanged

IDisposable

GainCalibration

ImpedanceCalibration

MultiModeCalibration

GainUserRange

GainFullRange

ImpedanceFullRange

ImpedanceUserRange

MultiModeFullRange

MultiModeUserRange