The runtime parameters needed for checkerboard calibration. They include the name of the calibrated space, an enum that specifies the selected space of the calibrated image, and settings for the unfilled pixels that may occur in nonlinear warping.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.CalibFix CogCalibCheckerboardRunParams
Namespace: Cognex.VisionPro.CalibFix
Assembly: Cognex.VisionPro.CalibFix (in Cognex.VisionPro.CalibFix.dll) Version: 69.0.0.0
Syntax
The CogCalibCheckerboardRunParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogCalibCheckerboardRunParams | Constructs a new instance of this class. |
| CogCalibCheckerboardRunParams(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogCalibCheckerboardRunParams(CogCalibCheckerboardRunParams) | Constructs a new instance of this class as a deep copy of the given instance. |
Methods
| Name | Description | |
|---|---|---|
 | 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 | (Inherited from Object.) |
| 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.) |
| 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 | |
| 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.) |
| 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. |
| 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 | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfCalibratedSpaceName | This bit will be set in the EventArgs of a Changed event every time the value returned by CalibratedSpaceName may have changed. |
| SfSpaceToOutput | This bit will be set in the EventArgs of a Changed event every time the value returned by SpaceToOutput may have changed. |
| SfUnfilledPelPlane0Value | This bit will be set in the EventArgs of a Changed event every time the value returned by UnfilledPelPlane0Value may have changed. |
| SfUnfilledPelPlane1Value | This bit will be set in the EventArgs of a Changed event every time the value returned by UnfilledPelPlane1Value may have changed. |
| SfUnfilledPelPlane2Value | This bit will be set in the EventArgs of a Changed event every time the value returned by UnfilledPelPlane2Value may have changed. |
| SfUnfilledPelValue | This bit will be set in the EventArgs of a Changed event every time the value returned by UnfilledPelValue may have changed. |
| SfUnfilledPelValueEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by UnfilledPelValueEnabled may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | CalibratedSpaceName | Name of the calibrated coordinate space that will be attached to the coordinate space tree of the output image. This must be a valid non-qualified name. |
| 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. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| SpaceToOutput | Specifies whether the selected space of the output image will be a fully-qualified copy of the calibrated space name, or a fully-qualified copy of the uncalibrated space name. |
| UnfilledPelPlane0Value | If UnfilledPelValueEnabled is True and the InputImage is a color image, the Plane 0 component of unfilled output pels will be set to this value. Otherwise, this value is ignored. Unfilled pels can only occur in an image produced by nonlinear warping. |
| UnfilledPelPlane1Value | If UnfilledPelValueEnabled is True and the InputImage is a color image, the Plane 1 component of unfilled output pels will be set to this value. Otherwise, this value is ignored. Unfilled pels can only occur in an image produced by nonlinear warping. |
| UnfilledPelPlane2Value | If UnfilledPelValueEnabled is True and the InputImage is a color image, the Plane 2 component of unfilled output pels will be set to this value. Otherwise, this value is ignored. Unfilled pels can only occur in an image produced by nonlinear warping. |
| UnfilledPelValue | If UnfilledPelValueEnabled is True and the InputImage is a monochrome image, unfilled pels in the output image will be set to this value. Otherwise, this value is ignored. Unfilled pels can only occur in an image produced by nonlinear warping. |
| UnfilledPelValueEnabled | If True, unfilled pels in the output image will be initialized using UnfilledPelValue, or UnfilledPelPlane{0, 1 and 2}Value. Otherwise, unfilled pels will be uninitialized. Unfilled pels can only occur in an image produced by nonlinear warping. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
The runtime parameters needed for checkerboard calibration. They include the name of the calibrated space, an enumeration that specifies the selected space of the calibrated image, and settings for the unfilled pixels that may occur in nonlinear warping.
See Also