CogCalibFeatureExtractorCheckerboard Class

Cognex VisionPro 9.22

This class defines a checkerboard calibration feature extractor. This extractor extracts the calibration features from an image or image collections of a checkerboard calibration plate. Note that the checkerboard calibration plate must follow the Cognex specifications.

This feature extractor operates with a checkerboard style calibration plate consisting of a grid of alternating light and dark checkers.

For each image of a checkerboard, the extractor locates the vertices of checkers in the image and generates a correspondence of vertex locations in image with vertex locations on the physical calibration plate coordinate system (Plate2D, see the remarks section of CogCalibFeatureExtractorCheckerboardLabelModeConstants).

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.CalibFix CogCalibFeatureExtractorBase
            Cognex.VisionPro.CalibFix CogCalibFeatureExtractorCheckerboard

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogCalibFeatureExtractorCheckerboard : CogCalibFeatureExtractorBase, 
	IDisposable

[SerializableAttribute]
public class CogCalibFeatureExtractorCheckerboard : CogCalibFeatureExtractorBase, 
	IDisposable

<SerializableAttribute>
Public Class CogCalibFeatureExtractorCheckerboard 
	Inherits CogCalibFeatureExtractorBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogCalibFeatureExtractorCheckerboard 
	Inherits CogCalibFeatureExtractorBase 
	Implements IDisposable

[SerializableAttribute]
public ref class CogCalibFeatureExtractorCheckerboard : public CogCalibFeatureExtractorBase, 
	IDisposable

[SerializableAttribute]
public ref class CogCalibFeatureExtractorCheckerboard : public CogCalibFeatureExtractorBase, 
	IDisposable

The CogCalibFeatureExtractorCheckerboard type exposes the following members.

Constructors

	Name	Description
	CogCalibFeatureExtractorCheckerboard	Construct this CogCalibFeatureExtractorCheckerboard using the default parameters: PhysGridPitchX and PhysGridPitchY are (1,1); OriginX and OriginY are (0,0); LabelMode is None; PrecisionThreshold is HUGE_VAL (the largest representable value of type double); NeedBothCheckers is true; UniformLighting is false; CheckerAngleMin is -Math.PI (in radians, i.e. negative 180 degrees); CheckerAngleMax is Math.PI (in radians, i.e. positive 180 degrees); Algorithm is Exhaustive; CheckersCoverFOV is false;
	CogCalibFeatureExtractorCheckerboard(CogCalibFeatureExtractorCheckerboard)	Copy constructs a CogCalibFeatureExtractorCheckerboard object. This is a deep copy.
	CogCalibFeatureExtractorCheckerboard(Double, Double)	Construct this CogCalibFeatureExtractorCheckerboard using the specified grid pitch.
	CogCalibFeatureExtractorCheckerboard(SerializationInfo, StreamingContext)	Serialization construct a CogCalibFeatureExtractorCheckerboard object.

Top

Methods

	Name	Description
	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	Destruct this CogCalibFeatureExtractorCheckerboard.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute(CogImageCollectionMCamerasNPoses)	Extract features from a set of calibration images, acquired from one or multiple cameras over different calibration poses. The images are indexed by pose first, then by camera (see CogImageCollectionMCamerasNPoses for more details). The feature extraction is done by calling the Execute(ICogImage ) method for each calibration image. The Execute(ICogImage ) method will be invoked on multiple threads if IsThreadSafe is true and CogVisionToolMultiThreading.Enable is true. (Inherited from CogCalibFeatureExtractorBase.)
	Execute(ICogImage)	Extracts features from a checkerboard calibration plate image (the checkerboard calibration plate must follow the Cognex specifications). Note that in the resulting feature correspondences, the image positions (ImageX and ImageY are in the root space ("@") of the input image, and the physical positions (PhysicalX and PhysicalY are in Plate2D space (see the remarks section of CogCalibFeatureExtractorCheckerboardLabelModeConstants). (Overrides CogCalibFeatureExtractorBase Execute(ICogImage).)
	Finalize	Finalize this CogCalibFeatureExtractorCheckerboard. (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.)
	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.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData	Serializer for CogCalibFeatureExtractorCheckerboard object. (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
	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 )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.)
	OnChanged(Int64)	This method should be called internally whenever the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	OnChanged(CogChangedEventArgs)	This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class. (Inherited from CogSerializableChangedEventBase.)
	OnFeaturesExtracted	Method to support feature extraction progress event. (Inherited from CogCalibFeatureExtractorBase.)
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called, and 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. (Inherited from CogSerializableChangedEventBase.)
	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. (Inherited from CogSerializableChangedEventBase.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfAlgorithm	This bit will be set in the EventArgs of a Changed event every time the value returned by Algorithm may have been changed.
	SfCheckerAngleMax	This bit will be set in the EventArgs of a Changed event every time the value returned by CheckerAngleMax may have been changed.
	SfCheckerAngleMin	This bit will be set in the EventArgs of a Changed event every time the value returned by CheckerAngleMin may have been changed.
	SfCheckersCoverFOV	This bit will be set in the EventArgs of a Changed event every time the value returned by CheckersCoverFOV may have been changed.
	SfDataMatrixTimeoutSeconds	This bit will be set in the EventArgs of a Changed event every time the value returned by DataMatrixTimeoutSeconds may have been changed.
	SfLabelMode	This bit will be set in the EventArgs of a Changed event every time the value returned by LabelMode may have been changed.
	SfNeedBothCheckers	This bit will be set in the EventArgs of a Changed event every time the value returned by NeedBothCheckers may have been changed.
	SfNextSf
	SfOriginX	This bit will be set in the EventArgs of a Changed event every time the value returned by OriginX may have been changed.
	SfOriginY	This bit will be set in the EventArgs of a Changed event every time the value returned by OriginY may have been changed.
	SfPhysGridPitchX	This bit will be set in the EventArgs of a Changed event every time the value returned by PhysGridPitchX may have been changed.
	SfPhysGridPitchY	This bit will be set in the EventArgs of a Changed event every time the value returned by PhysGridPitchY may have been changed.
	SfPrecisionThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by PrecisionThreshold may have been changed.
	SfUniformLighting	This bit will be set in the EventArgs of a Changed event every time the value returned by UniformLighting may have been changed.

Top

Properties

	Name	Description
	Algorithm	Gets/sets the feature extraction algorithm.
	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. (Inherited from CogSerializableChangedEventBase.)
	CheckerAngleMax	Gets/sets the maximum angle of checker orientations. Note that if the new value is smaller than CheckerAngleMin, then CheckerAngleMin will be changed to the new CheckerAngleMax.
	CheckerAngleMin	Gets/sets the minimum angle of checker orientations. Note that if the new value is larger than CheckerAngleMax, then CheckerAngleMax will be changed to the new CheckerAngleMin.
	CheckersCoverFOV	Gets/sets whether the checkers entirely cover the field of view.
	DataMatrixTimeoutSeconds	The maximum number of seconds to search for a single DataMatrix fiducial.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	IsThreadSafe	Gets whether the implementation of Execute(ICogImage) is thread-safe. Thread-safety is required to allow multithreading within implementations of Execute(CogImageCollectionMCamerasNPoses) method. (Overrides CogCalibFeatureExtractorBase IsThreadSafe.)
	LabelMode	Gets/sets the label mode of the vertices on the checkerboard calibration plate.
	NeedBothCheckers	Gets/sets the flag to indicate whether the tool should find only vertices shared by two interior light checkers.
	OriginX	Gets/sets the the x value of the designated origin to be used for labeling of returned feature points. The vertex closest to point (OriginX, OriginY) will be used as the origin for point correspondence when LabelMode is UseOrigin.
	OriginY	Gets/sets the the y value of the designated origin to be used for labeling of returned feature points. The vertex closest to point (OriginX, OriginY) will be used as the origin for point correspondence when LabelMode is UseOrigin.
	PhysGridPitchX	Gets/sets the physical units of grid pitch along the x-axis of the calibration plate coordinate system (Plate2D, see the remarks section of CogCalibFeatureExtractorCheckerboardLabelModeConstants). It is the distance between any two adjacent checker vertices whenever the line joining them is parallel to the x axis of Plate2D.
	PhysGridPitchY	Gets/sets the physical units of grid pitch along the y-axis of the see the remarks section of CogCalibFeatureExtractorCheckerboardLabelModeConstants). It is the distance between any two adjacent
	PrecisionThreshold	Gets/sets the threshold for discarding vertices with excessive positional uncertainty. This is specified in pixels.
	StateFlags	Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... } (Inherited from CogSerializableChangedEventBase.)
	UniformLighting	Gets/sets the flag to indicate whether the checkerboard is uniformly illuminated in the run-time images.

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	FeaturesExtracted	Feature extraction progress event. The user can create a CogCalibFeaturesExtractedEventHandler and add to this event. (Inherited from CogCalibFeatureExtractorBase.)

Top