CogAcqFieldCalibration.FieldCalibrationFile Property

CogAcqFieldCalibration FieldCalibrationFile Property

Cognex VisionPro 9.5

Gets or sets the path to the file containing the field calibration data.

Namespace: Cognex.VisionPro.Implementation.Internal
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 69.0.0.0

Syntax

public virtual string FieldCalibrationFile { get; set; }

public virtual string FieldCalibrationFile { get; set; }

Public Overridable Property FieldCalibrationFile As String 
	Get 
	Set

Public Overridable Property FieldCalibrationFile As String 
	Get 
	Set

public:
virtual property String^ FieldCalibrationFile {
	String^ get ();
	void set (String^ value);
}

public:
virtual property String^ FieldCalibrationFile {
	String^ get ();
	void set (String^ value);
}

Type: String
The path to the field calibration data file.

Remarks

The default value is an empty string.

The file is read every time the setter is called, even if the file name is the same. The file is read even if the UseFieldCalibration is false.

Acquisition will fail if field calibration is enabled and either the file cannot be read, or the sensor is not found in the field calibration file.

If the file can not be read when the path is set, an exception is thrown, but the path will be set.