Interface MultiModeCalibration
Calibration settings for impedance measurement.
Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Calibration
Assembly: OmicronLab.VectorNetworkAnalysis.AutomationInterface.dll (3.50.2911.0)
Syntax
[Guid("A2918908-27BA-4659-9062-ED12918A0130")]
[InterfaceType(ComInterfaceType.InterfaceIsDual)]
[ComVisible(true)]
public interface MultiModeCalibration
Properties
CalibrationValues
Gets or sets the calibration values.
Declaration
CorrectionValues CalibrationValues { get; set; }
Property Value
Type | Description |
---|---|
CorrectionValues |
FullRange
Gets the full range calibration settings.
Declaration
MultiModeFullRange FullRange { get; }
Property Value
Type | Description |
---|---|
MultiModeFullRange | The full range calibration settings. |
Load
Gets or sets the resistance value in Ω used for the load calibration.
Declaration
double Load { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The load resistor. |
Remarks
In Ω.
ShortDelayTime
Gets or sets the delay time of the short circuit used for Calibration.
Declaration
double ShortDelayTime { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The short delay time. |
Remarks
In picoseconds.
UserRange
Gets the user range calibration settings.
Declaration
MultiModeUserRange UserRange { get; }
Property Value
Type | Description |
---|---|
MultiModeUserRange | The user range calibration settings. |
Methods
LoadCalibration(String)
Obsolete: Please use 'LoadCalibration' from 'UserRange' and 'FullRange'. Changed because this allows more flexible calibration loading.
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.", false)]
bool LoadCalibration(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | The user specified file path. The file extension '.mcalx' is required. |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.
LoadCalibrationAsync(String)
Obsolete: Please use 'LoadCalibration' from 'UserRange' and 'FullRange'. Changed because this allows more flexible calibration loading!
Loads the calibration data from the user specified path asynchronous.
Declaration
[ComVisible(false)]
[Obsolete("Please use 'LoadCalibrationAsync' from 'UserRange' and 'FullRange'. Changed because this allows more flexible calibration loading.", false)]
Task<bool> LoadCalibrationAsync(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | The user specified file path. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> |
LoadCalibrationFromStream(Stream)
Obsolete: Please use 'LoadCalibration' from 'UserRange' and 'FullRange'. Changed because this allows more flexible calibration loading.
Loads the calibration as IO stream.
Declaration
[Obsolete("Please use 'LoadCalibrationFromStream' from 'UserRange' and 'FullRange'. Changed because this allows more flexible calibration loading.", false)]
bool LoadCalibrationFromStream(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
Stream | stream | The IO stream. |
Returns
Type | Description |
---|---|
System.Boolean |
LoadCalibrationFromStreamAsync(Stream)
Obsolete: Please use 'LoadCalibration' from 'UserRange' and 'FullRange'. Changed because this allows more flexible calibration loading!
Loads the calibration as IO stream asynchronous.
Declaration
[ComVisible(false)]
[Obsolete("Please use 'LoadCalibrationFromStreamAsync' from 'UserRange' and 'FullRange'. Changed because this allows more flexible calibration loading.", false)]
Task<bool> LoadCalibrationFromStreamAsync(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
Stream | stream | The IO stream. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> |
SaveCalibration(String)
Saves the calibration data to the user specified path.
Declaration
bool SaveCalibration(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | The user specified file path. The file extension '.mcalx' is required. |
Returns
Type | Description |
---|---|
System.Boolean |
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 IO stream.
Declaration
bool SaveCalibrationAsStream(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
Stream | stream | The IO stream. |
Returns
Type | Description |
---|---|
System.Boolean |
SaveCalibrationAsStreamAsync(Stream)
Saves the calibration as IO stream asynchronous.
Declaration
[ComVisible(false)]
Task<bool> SaveCalibrationAsStreamAsync(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
Stream | stream | The IO stream. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> |
SaveCalibrationAsync(String)
Saves the calibration data to the user specified path asynchronous.
Declaration
[ComVisible(false)]
Task<bool> SaveCalibrationAsync(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | The user specified file path. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> |