CogCalibCheckerboard Class

Cognex VisionPro 9.7

The CogCalibCheckerboard object defines a calibrated coordinate space using an image of a checkerboard calibration plate. It allows you to attach the calibrated space to an image, and may also perform a nonlinear warping of that image.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.CalibFix CogCalibCheckerboard

Namespace: Cognex.VisionPro.CalibFix
Assembly: Cognex.VisionPro.CalibFix (in Cognex.VisionPro.CalibFix.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogCalibCheckerboard : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	IDeserializationCallback, ICogChangedEvent

[SerializableAttribute]
public class CogCalibCheckerboard : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	IDeserializationCallback, ICogChangedEvent

<SerializableAttribute>
Public Class CogCalibCheckerboard 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, IDeserializationCallback, ICogChangedEvent

<SerializableAttribute>
Public Class CogCalibCheckerboard 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, IDeserializationCallback, ICogChangedEvent

[SerializableAttribute]
public ref class CogCalibCheckerboard : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	IDeserializationCallback, ICogChangedEvent

[SerializableAttribute]
public ref class CogCalibCheckerboard : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	IDeserializationCallback, ICogChangedEvent

The CogCalibCheckerboard type exposes the following members.

Constructors

	Name	Description
	CogCalibCheckerboard	Constructs a new instance of this class.
	CogCalibCheckerboard(IntPtr)	Constructs a new instance of this class using com pointer.
	CogCalibCheckerboard(CogCalibCheckerboard)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	Calibrate	Computes the mapping to calibrated space using the current CalibrationImage and related parameters. If successful, sets the Calibrated property to True, updates the computed transforms, and makes this object ready to run via the Execute method.
	Clone	Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Dispose
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Attaches the calibrated space to the coordinate tree of the output image, using the given RunParams. Depending upon the ComputationMode the output image is either a shallow copy of the input image or a new image that is a nonlinear warping of the input.
	Finalize	(Overrides Object Finalize .)
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComputedUncalibratedFromCalibratedTransform	If Calibrated is True, this method returns the 2-D, minimum squared error, transformation that maps points from the (adjusted) calibrated space into uncalibrated space. Otherwise, it returns Nothing.
	GetComputedUncalibratedFromRawCalibratedTransform	Returns the 2-D, minimum squared error, transformation that maps points from the raw calibrated space into uncalibrated space, if it has been computed. Otherwise, returns Nothing. The transform is computed by calling Calibrate.
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInfoStrings	Returns diagnostic text string(s) from the last call to Calibrate. The collection will be empty if there are no messages, or if the Calibrated property is False.
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	(Overrides CogObjectBase GetProperties( Attribute ).)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetRawCalibratedPoint	Gets the X and Y coordinates of the raw calibrated vertex point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetRawCalibratedPointX	The X coordinate of the raw calibrated vertex point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetRawCalibratedPointY	The Y coordinate of the raw calibrated vertex point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUncalibratedPoint	Gets the X and Y coordinates of the uncalibrated vertex point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetUncalibratedPointX	The X coordinate of the uncalibrated vertex point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetUncalibratedPointY	The Y coordinate of the uncalibrated vertex point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnDeserialization
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also raises the Changed event if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent.
	SetExternal	For Cognex Internal Use Only.
	SuspendChangedEvent	Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	Uncalibrate	Eliminates the current mapping to calibrated space. This method also sets the Calibrated property to False, sets the computed transforms to Nothing, and renders the object unable to run via the Execute method.

Top

Fields

	Name	Description
	SfCalibrated	This bit will be set in the EventArgs of a Changed event every time the value returned by Calibrated may have changed.
	SfCalibratedOriginSpace	This bit will be set in the EventArgs of a Changed event every time the value returned by CalibratedOriginSpace may have changed.
	SfCalibratedOriginX	This bit will be set in the EventArgs of a Changed event every time the value returned by CalibratedOriginX may have changed.
	SfCalibratedOriginY	This bit will be set in the EventArgs of a Changed event every time the value returned by CalibratedOriginY may have changed.
	SfCalibratedXAxisRotation	This bit will be set in the EventArgs of a Changed event every time the value returned by CalibratedXAxisRotation may have changed.
	SfCalibratedXAxisRotationSpace	This bit will be set in the EventArgs of a Changed event every time the value returned by CalibratedXAxisRotationSpace may have changed.
	SfCalibrationImage	This bit will be set in the EventArgs of a Changed event every time the value returned by CalibrationImage may have changed.
	SfComputationMode	This bit will be set in the EventArgs of a Changed event every time the value returned by ComputationMode may have changed.
	SfComputedRMSError	This bit will be set in the EventArgs of a Changed event every time the value returned by ComputedRMSError may have changed.
	SfDataMatrixTimeout	This bit will be set in the EventArgs of a Changed event every time the value returned by DataMatrixTimeout may have changed.
	SfDataMatrixTimeoutEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by DataMatrixTimeoutEnabled may have changed.
	SfDOFsToCompute	This bit will be set in the EventArgs of a Changed event every time the value returned by DOFsToCompute may have changed.
	SfExternalEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by ExternalEnabled may have changed.
	SfFeatureFinder	This bit will be set in the EventArgs of a Changed event every time the value returned by FeatureFinder may have changed.
	SfFiducialMark	This bit will be set in the EventArgs of a Changed event every time the value returned by FiducialMark may have changed.
	SfGetComputedUncalibratedFromCalibratedTransform	This bit will be set in the EventArgs of a Changed event every time the value returned by GetComputedUncalibratedFromCalibratedTransform may have changed.
	SfGetComputedUncalibratedFromRawCalibratedTransform	This bit will be set in the EventArgs of a Changed event every time the value returned by GetComputedUncalibratedFromRawCalibratedTransform may have changed.
	SfGetInfoStrings	This bit will be set in the EventArgs of a Changed event every time the value returned by GetInfoStrings may have changed.
	SfGetOutputImageRootFromCalibratedTransform	This bit will be set in the EventArgs of a Changed event every time the value returned by GetOutputImageRootFromCalibratedTransform may have changed.
	SfGetRawCalibratedPointX	This bit will be set in the EventArgs of a Changed event every time the value returned by GetRawCalibratedPointX may have changed.
	SfGetRawCalibratedPointY	This bit will be set in the EventArgs of a Changed event every time the value returned by GetRawCalibratedPointY may have changed.
	SfGetUncalibratedPointX	This bit will be set in the EventArgs of a Changed event every time the value returned by GetUncalibratedPointX may have changed.
	SfGetUncalibratedPointY	This bit will be set in the EventArgs of a Changed event every time the value returned by GetUncalibratedPointY may have changed.
	SfLinescanDistanceToTarget	This bit will be set in the EventArgs of a Changed event every time the value returned by LinescanDistanceToTarget may have changed.
	SfLinescanDistanceToTargetEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by LinescanDistanceToTargetEnabled may have changed.
	SfNumPoints	This bit will be set in the EventArgs of a Changed event every time the value returned by NumPoints may have changed.
	SfOutputImageMask	This bit will be set in the EventArgs of a Changed event every time the value returned by OutputImageMask may have changed.
	SfPhysicalTileSizeX	This bit will be set in the EventArgs of a Changed event every time the value returned by PhysicalTileSizeX may have changed.
	SfPhysicalTileSizeY	This bit will be set in the EventArgs of a Changed event every time the value returned by PhysicalTileSizeY may have changed.
	SfSwapCalibratedHandedness	This bit will be set in the EventArgs of a Changed event every time the value returned by SwapCalibratedHandedness may have changed.
	SfUndistortedCalibrationImage	This bit will be set in the EventArgs of a Changed event every time the value returned by UndistortedCalibrationImage may have changed.
	SfUndistortedCalibrationImageMask	This bit will be set in the EventArgs of a Changed event every time the value returned by UndistortedCalibrationImageMask may have changed.
	SfWarpDestinationRectangle	This bit will be set in the EventArgs of a Changed event every time the value returned by WarpDestinationRectangle may have changed.
	SfWarpMaxErrorInPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by WarpMaxErrorInPixels may have changed.
	SfWarpRotation	This bit will be set in the EventArgs of a Changed event every time the value returned by WarpRotation may have changed.
	SfWarpScaling	This bit will be set in the EventArgs of a Changed event every time the value returned by WarpScaling may have changed.

Top

Properties

	Name	Description
	Calibrated	True if all of the computed outputs of this object are meaningful, and were computed using the current object properties. This can only happen if the Calibrate method is called and none of the object properties are changed afterwards.
	CalibratedOriginSpace	Specifies whether the CalibratedOriginX and CalibratedOriginY properties are expressed in uncalibrated space, or in raw calibrated space.
	CalibratedOriginX	The desired X position of the calibrated space origin, expressed in the coordinate space specified by CalibratedOriginSpace. Calibrated space will be adjusted so that its origin appears at this X position when calibrated.
	CalibratedOriginY	The desired Y position of the calibrated space origin, expressed in the coordinate space specified by CalibratedOriginSpace. Calibrated space will be adjusted so that its origin appears at this Y position when calibrated.
	CalibratedXAxisRotation	The desired x-axis rotation of calibrated space, expressed in the coordinate space specified by CalibratedXAxisRotationSpace. Calibrated space will be adjusted so that its x-axis appears at this angle (in radians) when calibrated.
	CalibratedXAxisRotationSpace	Specifies whether the CalibratedXAxisRotation property is expressed in uncalibrated space, or in raw calibrated space.
	CalibrationImage	The image of the checkerboard calibration plate. Each tile on the plate must be at least 15 pixels high and wide. During calibration the vertex points (where four tiles meet) will be used to compute the calibration transform.
	ChangedEventSuspended	If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
	ComputationMode	This enumeration specifies how the best-fit transformation between the uncalibrated points and the raw calibrated points will be computed. You can choose a linear computation or a nonlinear one (with runtime image warping).
	ComputedRMSError	Returns the root mean squared error between the uncalibrated points and the mapped raw calibrated points, expressed in uncalibrated space. It is valid if the computed uncalibrated from raw calibrated transform exists. Otherwise, zero is returned.
	DataMatrixTimeout	The maximum time in milliseconds to search for a single DataMatrix fiducial.
	DataMatrixTimeoutEnabled	If True, use the DataMatrixTimeout value when calibrating if FiducialMark is either DataMatrix or DataMatrixWithGridPitch.
	DOFsToCompute	This enumeration specifies which degrees of freedom will be allowed when computing the best-fit linear transformation between the uncalibrated points and the raw calibrated points. It is used only when the ComputationMode is linear.
	ExternalEnabled	For Cognex Internal Use Only.
	FeatureFinder	An enumeration that specifies the algorithm used to find features on the calibration plate.
	FiducialMark	An enumeration that specifies what style of fiducial mark is present on the calibration plate.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	LinescanDistanceToTarget	The distance in client coordinates from the linescan camera to the calibration target.
	LinescanDistanceToTargetEnabled	If True, use the LinescanDistanceToTarget value when calibrating if ComputationMode is LinescanWarp or Linescan2DWarp.
	NumPoints	The number of vertex points in each point set. This is the number of raw calibrated points, and also the number of uncalibrated points.
	OwnedWarpParams	Gets the nonlinear warping parameters and results. These items are owned by this calibration object, but are conveniently grouped together inside the returned interface.
	PhysicalTileSizeX	The physical grid spacing in the X direction of raw calibrated space.
	PhysicalTileSizeY	The physical grid spacing in the Y direction of raw calibrated space.
	SwapCalibratedHandedness	Specifies the handedness of the calibrated space. When SwapCalibratedHandedness is false, the calibrated space will have the same handedness as the raw (unadjusted) calibrated space. Otherwise, it will have the opposite handedness.

Top

Events

	Name	Description
	Changed	Occurs when one or more parts of the object's state may have changed.

Top

Remarks

The primary interface of the CogCalibCheckerboard object. Lets you define a calibrated coordinate space using an image of a checkerboard calibration plate. It allows you to attach the calibrated space to an image, and may also perform a nonlinear warping of that image.