CogCalibNPointToNPoint Class

Cognex VisionPro 9.5

The CogCalibNPointToNPoint object defines a calibrated coordinate space using N pairs of points and allows users to attach this space to an image.

Inheritance Hierarchy

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

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogCalibNPointToNPoint type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	AddPointPair	Adds a new point to the end of each point set. NumPoints will be increased by one.
	Calibrate	Computes the calibrated space using the current point sets. If successful, sets the Calibrated property to True, updates the computed transforms, and updates the ComputedRMSError property.
	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.)
	DeletePointPair	Deletes the point at the given index from each point set. Points with higher indices are shifted to the next lower index, and NumPoints is decreased by one.
	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 input image, using the given RunParams, and returns a shallow copy of the image as an output.
	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 point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetRawCalibratedPointX	The X coordinate of the raw calibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetRawCalibratedPointY	The Y coordinate of the raw calibrated 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 point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetUncalibratedPointX	The X coordinate of the uncalibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	GetUncalibratedPointY	The Y coordinate of the uncalibrated 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.)
	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.
	SetRawCalibratedPoint	Sets the X and Y coordinates of the raw calibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	SetRawCalibratedPointX	The X coordinate of the raw calibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	SetRawCalibratedPointY	The Y coordinate of the raw calibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	SetUncalibratedPoint	Sets the X and Y coordinates of the uncalibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	SetUncalibratedPointX	The X coordinate of the uncalibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	SetUncalibratedPointY	The Y coordinate of the uncalibrated point with the given index. Valid indices range from 0 to NumPoints-1 inclusive.
	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 calibrated space. This method also sets the Calibrated property to False, sets the computed transforms to Nothing, and sets the ComputedRMSError property to zero.

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.
	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.
	SfDOFsToCompute	This bit will be set in the EventArgs of a Changed event every time the value returned by DOFsToCompute 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.
	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.
	SfNumPoints	This bit will be set in the EventArgs of a Changed event every time the value returned by NumPoints 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.

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.
	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. Only linear computations are supported in this release.
	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.
	DOFsToCompute	This enumeration specifies which degrees of freedom will be allowed when computing the best-fit transformation between the uncalibrated points and the raw calibrated points.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	NumPoints	The number of points in each point set. This is the number of raw calibrated points, and also the number of uncalibrated points.
	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

This interface defines a calibrated coordinate space using N pairs of points and allows you to attach this space to an image.