Cog3DLensDistortionCorrector Class

Cognex VisionPro

This class provides lens distortion correction based on a camera calibration. At training-time, this class trains an image corrector using the lens distortion data in a camera calibration, and produces a new camera calibration to be used with corrected images. At run-time, via the Execute() method, this class converts an acquired (raw) image into a corrected image where the lens distortion has been removed.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro3D Cog3DLensDistortionCorrector

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class Cog3DLensDistortionCorrector : CogSerializableObjectBase, 
	IDisposable

[SerializableAttribute]
public class Cog3DLensDistortionCorrector : CogSerializableObjectBase, 
	IDisposable

<SerializableAttribute>
Public Class Cog3DLensDistortionCorrector 
	Inherits CogSerializableObjectBase 
	Implements IDisposable

<SerializableAttribute>
Public Class Cog3DLensDistortionCorrector 
	Inherits CogSerializableObjectBase 
	Implements IDisposable

[SerializableAttribute]
public ref class Cog3DLensDistortionCorrector : public CogSerializableObjectBase, 
	IDisposable

[SerializableAttribute]
public ref class Cog3DLensDistortionCorrector : public CogSerializableObjectBase, 
	IDisposable

The Cog3DLensDistortionCorrector type exposes the following members.

Constructors

	Name	Description
	Cog3DLensDistortionCorrector	Construct this default Cog3DLensDistortionCorrector. Note that IsTrained is false.
	Cog3DLensDistortionCorrector(Cog3DLensDistortionCorrector)
	Cog3DLensDistortionCorrector(SerializationInfo, StreamingContext)

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
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Perform image correction (lens distortion removal) on the specified image. Use Raw2DFromPhys3DUsingCorrectImage as the camera calibration for the returned, corrected image.
	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	(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.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	Train	Train the image corrector using the specified camera calibration.
	Untrain	Discard the trained data. Note that IsTrained will return false until Train() is called again.

Top

Properties

	Name	Description
	IsTrained	Gets whether this image corrector is trained.
	Raw2DFromPhys3DUsingCorrectedImage	Gets the camera calibration produced at training-time. This is the camera calibration which should be used with the corrected images.

Top

Remarks

The new camera calibration produced at training-time (Raw2DFromPhys3DUsingCorrectedImage) has a distortion model of Cog3DCameraCalibrationDistortionModelConstants.eNoDistortion, and has extrinsic parameters (Raw2DFromPhys3DUsingCorrectedImage.Camera3DFromPhys3D) that are the same as the original camera calibration (specified at training-time) extrinsic parameters.

2D features in the corrected image mapped to 3D rays in Phys3D space using Raw2DFromPhys3DUsingCorrectedImage, correspond to exactly the same 3D rays as corresponding 2D features in the uncorrected image mapped using the original camera calibration specified at training-time.