Cog3DAlignRunParams ClassCognex VisionPro
Class that holds the 3DAlign run parameters. These parameters control how 3DAlign locates patterns in the runtime image.
Inheritance Hierarchy

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

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

[SerializableAttribute]
public class Cog3DAlignRunParams : CogSerializableChangedEventBase, 
	IDisposable

The Cog3DAlignRunParams type exposes the following members.

Constructors

  NameDescription
Public methodCog3DAlignRunParams 
Constructs a default Cog3DAlignRunParams object.
Public methodCog3DAlignRunParams(Cog3DAlignRunParams)
Constructs a deep copy of the supplied Cog3DAlignRunParams object.
Protected methodCog3DAlignRunParams(SerializationInfo, StreamingContext)
Serialization constructor for Cog3DAlignRunParams object.
Top
Methods

  NameDescription
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose 
Releases all resources used by this Cog3DAlignRunParams object.
Protected methodDispose(Boolean)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Releases all unmanaged resources used by this Cog3DAlignRunParams object.
(Overrides Object Finalize .)
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetObjectData
Populates the provided SerializationInfo with the data needed to serialize the object.
(Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodOnChanged(Int64)
This method should be called internally whenever the object's state may have changed.
(Inherited from CogSerializableChangedEventBase.)
Protected methodOnChanged(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.)
Public methodResumeAndRaiseChangedEvent
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.)
Public methodSuspendChangedEvent
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.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberSfAcceptThreshold
This bit will be set in the EventArgs of a Changed event every time the value returned by AcceptThreshold may have changed.
Public fieldStatic memberSfClutterMultiplier
This bit will be set in the EventArgs of a Changed event every time the value returned by ClutterMultiplier may have changed.
Public fieldStatic memberSfLocationConstraintMode
This bit will be set in the EventArgs of a Changed event every time the value returned by LocationConstraintMode may have changed.
Protected fieldStatic memberSfNextSf
Public fieldStatic memberSfNumberToFind
This bit will be set in the EventArgs of a Changed event every time the value returned by NumberToFind may have changed.
Public fieldStatic memberSfRunMode
This bit will be set in the EventArgs of a Changed event every time the value returned by RunMode may have changed.
Public fieldStatic memberSfSaveTrainedVisionDataInResults
This bit will be set in the EventArgs of a Changed event every time the value returned by SaveTrainedVisionDataInResults may have changed.
Public fieldStatic memberSfScoreMode
This bit will be set in the EventArgs of a Changed event every time the value returned by ScoreMode may have changed.
Public fieldStatic memberSfStartPose
This bit will be set in the EventArgs of a Changed event every time the value returned by StartPose may have changed.
Public fieldStatic memberSfTimeout
This bit will be set in the EventArgs of a Changed event every time the value returned by Timeout may have changed.
Public fieldStatic memberSfTimeoutEnabled
This bit will be set in the EventArgs of a Changed event every time the value returned by TimeoutEnabled may have changed.
Public fieldStatic memberSfXYZOverlap
This bit will be set in the EventArgs of a Changed event every time the value returned by XYZOverlap may have changed.
Public fieldStatic memberSfZoneAngleDecomposition
This bit will be set in the EventArgs of a Changed event every time the value returned by ZoneAngleDecomposition may have changed.
Top
Properties

  NameDescription
Public propertyAcceptThreshold
Gets or sets the acceptance threshold for the score of a result. Only instances of the pattern that receive scores greater than or equal to this threshold are reported as results. Valid range is from zero to one.
Public propertyChangedEventSuspended
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.)
Public propertyClutterMultiplier
Gets or sets the clutter multiplier. This value controls how much the score of your result will be reduced by the presence of extraneous data points at the result location. Extraneous data points are known as clutter. They appear in the runtime image at locations that should be empty.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyLocationConstraintMode
Gets or sets the location constraint mode. This mode specifies the range of positions that are allowed for your result.
Public propertyNumberToFind
Gets or sets the number of results to search for.
Public propertyRunMode
Gets or sets the run mode. This mode controls how the tool should search for matches in the runtime 3D data.
Public propertySaveTrainedVisionDataInResults
Gets or sets whether to save trained vision data in the results.
Public propertyScoreMode
Gets or sets the score mode. This mode controls how the tool should compute scores for candidate matches.
Public propertyStartPose
Gets or sets the start pose, which is the transformation that defines the starting model pose within the run-time 3D data.
Public propertyStateFlags
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.)
Public propertyTimeout
Gets or sets the maximum execution time (in msec) allowed when a 3DAlign tool is run. This value only applies if TimeoutEnabled is set to "true".
Public propertyTimeoutEnabled
Gets or sets whether to enable the runtime timeout.
Public propertyXYZOverlap
Gets or sets the volume overlap threshold.
Public propertyZoneAngleDecomposition
Gets or sets the decomposition mode for the angle zones. This mode controls how you specify the range of 3D rotations that are allowed in your results. It defines the meanings of the three angle zones returned by the ZoneAngleFirst, ZoneAngleSecond and ZoneAngleThird properties.
Public propertyZoneAngleFirst
Gets the Cog3DAlignZoneAngle object that holds the first Euler angle zone. The properties of this object -- combined with those of ZoneAngleSecond and ZoneAngleThird -- let you specify the range of 3D rotations that are allowed in your results.
Public propertyZoneAngleSecond
Gets the Cog3DAlignZoneAngle object that holds the second Euler angle zone. The properties of this object -- combined with those of ZoneAngleFirst and ZoneAngleThird -- let you specify the range of 3D rotations that are allowed in your results.
Public propertyZoneAngleThird
Gets the Cog3DAlignZoneAngle object that holds the third Euler angle zone. The properties of this object -- combined with those of ZoneAngleFirst and ZoneAngleSecond -- let you specify the range of 3D rotations that are allowed in your results.
Top
Events

  NameDescription
Public eventChanged
This event is raised when one or more parts of the object's state may have changed.
(Inherited from CogSerializableChangedEventBase.)
Top
Remarks

At runtime 3DAlign finds instances of your trained pattern in the input image. You can control how these instances are located using the properties of the Cog3DAlignRunParams class:

This class must be provided as an argument to the Execute(ICogVisionData, ICog3DShape, Cog3DAlignRunParams) method of the Cog3DAlignPattern class. The Execute() method is called automatically every time you call the Run  method of the Cog3DAlignTool class, causing the tool to search the InputVisionData for instances of the pattern.

See Also