Cog3DAlignPattern Class

Cognex VisionPro

Class that represents a 3DAlign pattern. You can use the methods of this class to train a new pattern and to search for instances of the trained pattern in a 3D runtime image. You can also search for pattern instances using the tool class: Cog3DAlignTool.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro3D Cog3DAlignPattern

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class Cog3DAlignPattern : CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

[SerializableAttribute]
public class Cog3DAlignPattern : CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

<SerializableAttribute>
Public Class Cog3DAlignPattern 
	Inherits CogSerializableChangedEventBase 
	Implements IDeserializationCallback, IDisposable

<SerializableAttribute>
Public Class Cog3DAlignPattern 
	Inherits CogSerializableChangedEventBase 
	Implements IDeserializationCallback, IDisposable

[SerializableAttribute]
public ref class Cog3DAlignPattern : public CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

[SerializableAttribute]
public ref class Cog3DAlignPattern : public CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

The Cog3DAlignPattern type exposes the following members.

Constructors

	Name	Description
	Cog3DAlignPattern	Constructs a default Cog3DAlignPattern object. You must train this object before you can use it to search for pattern instances.
	Cog3DAlignPattern(Cog3DAlignPattern)	Constructs a deep copy of the supplied Cog3DAlignPattern object.
	Cog3DAlignPattern(SerializationInfo, StreamingContext)	Serialization constructor for Cog3DAlignPattern 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	Releases all resources used by this Cog3DAlignPattern object.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Searchs the given inputVisionData for instances of this pattern. The search is performed using the supplied runParams within the given region.
	Finalize	Releases all unmanaged resources used by this Cog3DAlignPattern object. (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	Populates the provided SerializationInfo with the data needed to serialize the 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.)
	GetTrainedBoundingBox	Gets the bounding box of the trained points for this pattern.
	GetTrainedVisionData	Gets a range image representation of the trained points for this pattern.
	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.)
	OnDeserialization	Perform final deserialization setup.
	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.)
	Train	Trains this 3DAlign pattern. If the pattern is already trained then it is untrained and retrained.
	Untrain	Untrains this 3DAlign pattern.

Top

Fields

	Name	Description
	SfGetTrainedBoundingBox	This bit will be set in the EventArgs of a Changed event every time the value returned by GetTrainedBoundingBox may have changed.
	SfGetTrainedVisionData	This bit will be set in the EventArgs of a Changed event every time the value returned by GetTrainedVisionData may have changed.
	SfNextSf
	SfOrigin	This bit will be set in the EventArgs of a Changed event every time the value returned by Origin may have changed.
	SfSubsamplingCubeSize	This bit will be set in the EventArgs of a Changed event every time the value returned by SubsamplingCubeSize may have changed.
	SfSubsamplingCubeSizeAutoSelect	This bit will be set in the EventArgs of a Changed event every time the value returned by SubsamplingCubeSizeAutoSelect may have changed.
	SfSubsamplingCubeSizeFineFraction	This bit will be set in the EventArgs of a Changed event every time the value returned by SubsamplingCubeSizeFineFraction may have changed.
	SfTrainAlgorithm	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainAlgorithm may have changed.
	SfTrained	This bit will be set in the EventArgs of a Changed event every time the value returned by Trained may have changed.
	SfTrainedAlgorithm	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainedAlgorithm may have changed.
	SfTrainRegion	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainRegion may have changed.
	SfTrainTimeout	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainTimeout may have changed.
	SfTrainTimeoutEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainTimeoutEnabled may have changed.
	SfTrainVisionData	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainVisionData may have changed.

Top

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.)
	Origin	Gets or sets the origin for the pattern. This 3D rigid transform maps points from "Pattern Space" to the 3D selected space of the train image. In other words, it defines the origin of the pattern's coordinate space relative to the 3D selected space of the train image.
	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.)
	SubsamplingCubeSize	Gets or sets the size of the subsampling cube to use during training and runtime. This value is the length of one side of the cube. If SubsamplingCubeSizeAutoSelect is "true" this size value is recomputed automatically when the pattern is trained, overwriting the previous value.
	SubsamplingCubeSizeAutoSelect	Gets or sets whether to automatically recompute the size of the subsampling cube during pattern training. If "true", the size computed during training overwrites the existing SubsamplingCubeSize. Otherwise, it remains unchanged.
	SubsamplingCubeSizeFineFraction	Gets or sets the fraction for determining the fine subsampling cube size to use during training and runtime. This fraction must be greater than zero and less than or equal to one. The product of this fraction and SubsamplingCubeSize specifies the length of one side of the fine subsampling cube.
	TrainAlgorithm	Gets or sets the 3DAlign algorithm to train. The trained algorithm is used at runtime.
	Trained	Gets whether this pattern is currently trained.
	TrainedAlgorithm	Gets the 3DAlign algorithm that was trained.
	TrainRegion	Gets or sets the train region. Only the portion of the 3D train image that lies within this region is trained by 3DAlign. If the supplied region object is null, the entire 3D image is trained.
	TrainTimeout	Gets or sets the maximum execution time (in msec) allowed when a 3DAlign pattern is trained. This value only applies if TrainTimeoutEnabled is set to "true".
	TrainTimeoutEnabled	Gets or sets whether to enable the train timeout.
	TrainVisionData	Gets or sets the 3D image data used to train this 3DAlign pattern. Only the portions of the 3D data that lie within the TrainRegion are trained.

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.)

Top

Remarks

A 3DAlign pattern must be trained (using the Train method) before it can be used to search for pattern instances. The trained pattern holds information needed for fast searching at runtime.

The pattern object also holds parameters that control the training process. If you change any of these parameters on a trained pattern object, the pattern automatically untrains itself. This ensures that the trained pattern data is in sync with the parameters that created it.

The only properties that do not untrain the pattern when changed are:

Once your pattern is trained you can search for instances of the pattern in a runtime input image. You can do this in one of two ways:

You can call the Execute(ICogVisionData, ICog3DShape, Cog3DAlignRunParams) method of this class, or
You can call the Run method of a Cog3DAlignTool class that contains this pattern object.