Class that holds the 3DPatMax run parameters. These parameters
control how 3DPatMax locates patterns in the runtime vision data.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DPatMaxRunParams
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 75.1.0.0
Syntax
The Cog3DPatMaxRunParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| Cog3DPatMaxRunParams |
Constructs a default Cog3DPatMaxRunParams object.
| |
| Cog3DPatMaxRunParams(Cog3DPatMaxRunParams) |
Constructs a deep copy of the supplied Cog3DPatMaxRunParams object.
| |
| Cog3DPatMaxRunParams(SerializationInfo, StreamingContext) |
Serialization constructor for Cog3DPatMaxRunParams object.
|
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 Cog3DPatMaxRunParams object.
| |
| Dispose(Boolean) | ||
| Equals | (Inherited from Object.) | |
| Finalize |
Releases all unmanaged resources used by this
Cog3DPatMaxRunParams 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.) | |
| 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.) | |
| 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 | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
| SfAcceptThreshold |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
AcceptThreshold
may have changed.
| |
| SfClutterMultiplier |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
ClutterMultiplier
may have changed.
| |
| SfLocationConstraintMode |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
LocationConstraintMode
may have changed.
| |
| SfNextSf | ||
| SfNumberToFind |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
NumberToFind
may have changed.
| |
| SfRunMode |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
RunMode
may have changed.
| |
| SfSaveTrainedVisionDataInResults |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
SaveTrainedVisionDataInResults
may have changed.
| |
| SfScoreMode |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
ScoreMode
may have changed.
| |
| SfStartPose |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
StartPose
may have changed.
| |
| SfTimeout |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
Timeout
may have changed.
| |
| SfTimeoutEnabled |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
TimeoutEnabled
may have changed.
| |
| SfXYZOverlap |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
XYZOverlap
may have changed.
| |
| SfZoneAngleDecomposition |
This bit will be set in the EventArgs of a Changed event every time the
value returned by
ZoneAngleDecomposition
may have changed.
|
Properties
| Name | Description | |
|---|---|---|
| AcceptThreshold |
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.
| |
| 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.) | |
| ClutterMultiplier |
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.
| |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) | |
| LocationConstraintMode |
Gets or sets the location constraint mode. This mode specifies the
range of positions that are allowed for your result.
| |
| NumberToFind |
Gets or sets the number of results to search for.
| |
| RunMode |
Gets or sets the run mode. This mode controls how the tool
should search for matches in the runtime 3D data.
| |
| SaveTrainedVisionDataInResults |
Gets or sets whether to save trained vision data in the results.
| |
| ScoreMode |
Gets or sets the score mode. This mode controls how the tool
should compute scores for candidate matches.
| |
| StartPose |
Gets or sets the start pose, which is the transformation that defines
the starting model pose within the run-time 3D data.
| |
| 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.) | |
| Timeout |
Gets or sets the maximum execution time (in msec) allowed when a
3DPatMax tool is run. This value only applies if
TimeoutEnabled
is set to "true".
| |
| TimeoutEnabled |
Gets or sets whether to enable the runtime timeout.
| |
| XYZOverlap |
Gets or sets the volume overlap threshold.
| |
| ZoneAngleDecomposition |
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.
| |
| ZoneAngleFirst |
Gets the Cog3DPatMaxZoneAngle 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.
| |
| ZoneAngleSecond |
Gets the Cog3DPatMaxZoneAngle 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.
| |
| ZoneAngleThird |
Gets the Cog3DPatMaxZoneAngle 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.
|
Events
| Name | Description | |
|---|---|---|
| Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
Remarks
- You can control the score of your found results using the ScoreMode, AcceptThreshold and ClutterMultiplier properties.
- You can control the execution time of the process using the Timeout and TimeoutEnabled properties.
- You can control the range of allowed result positions using the LocationConstraintMode.
- You can control the range of allowed result rotations using the ZoneAngleDecomposition, ZoneAngleFirst, ZoneAngleSecond and ZoneAngleThird properties.
- You can control how the tool should search for matches using the RunMode.
- All of the properties above may affect the number of results that are found. You can also control the number of returned results using the NumberToFind property.
This class must be provided as an argument to the Execute(ICogVisionData, ICog3DShape, Cog3DPatMaxRunParams) method of the Cog3DPatMaxPattern class. The Execute() method is called automatically every time you call the Run method of the Cog3DPatMaxTool class, causing the tool to search the InputVisionData for instances of the pattern.
See Also