This class is the abstract base class for 2D calibration feature extractors.
Clients that are using a checkerboard calibration plate following Cognex specification can use the CogCalibFeatureExtractorCheckerboard class to perform calibration feature extraction. These clients do not need to be concerned with this base class.
Clients that are using a special calibration object must implement their own calibration feature extractor class capable of extracting calibration features from images of the special calibration object. One way to implement such a custom calibration feature extractor class, is to derive the custom calibration feature extraction class from this base class.
This abstract base class provides an implementation of the Execute(CogImageCollectionMCamerasNPoses) method. This implementation calls the derived class' Execute(ICogImage) and will make the calls on multiple threads if the derived class IsThreadSafe is true and CogVisionToolMultiThreading.Enable is true. The provided implementation supports feature extraction progress events as well - the FeaturesExtracted event is fired as soon as feature extraction is completed on each calibration image.
Derived classes must: implement an override of the Execute(ICogImage) method as well as implement the IsThreadSafe property which specifies whether the override of Execute(ICogImage) is thread-safe or not.
Inheritance Hierarchy
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: 91.0.0.0
Syntax
The CogCalibFeatureExtractorBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogCalibFeatureExtractorBase |
Default constructor.
|
| CogCalibFeatureExtractorBase(SerializationInfo, StreamingContext) |
Serialization construct a CogCalibFeatureExtractorBase object.
|
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.) |
| 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.
|
| Execute(ICogImage) |
Extract features from a calibration image.
|
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| 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 |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| 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.
|
 | PelRectFromImage | |
| 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.) |
Fields
| Name | Description | |
|---|---|---|
 | SfNextSf |
Properties
| Name | Description | |
|---|---|---|
 | 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.) |
| 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.
|
| 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.) |
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.
|
See Also