This class encapsulates all of the parameters used to run the arrangement and/or character searches.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.OCVMax CogOCVMaxSearchParams
Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 65.1.0.0
Syntax
The CogOCVMaxSearchParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| CogOCVMaxSearchParams | ||
| CogOCVMaxSearchParams(CogOCVMaxSearchParams) | ||
| CogOCVMaxSearchParams(SerializationInfo, StreamingContext) |
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 | (Inherited from Object.) | |
| 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.) | |
| GetDOFRotation | Get a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the Rotation degree of freedom (DOF). Use the selector argument to specify which attribute. The units of all Rotation attributes are radians. | |
| GetDOFScale | Get a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the (uniform) Scale degree of freedom (DOF). Use the selector argument to specify which attribute. | |
| GetDOFScaleX | Get a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleX degree of freedom (DOF). Use the selector argument to specify which attribute. | |
| GetDOFScaleY | Get a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleY degree of freedom (DOF). Use the selector argument to specify which attribute. | |
| GetDOFShear | Get a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the Shear degree of freedom (DOF). Use the selector argument to specify which attribute. The units of all Shear attributes are radians. | |
| 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.) | |
| 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.) | |
| SetDOFRotation | Set a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the Rotation degree of freedom (DOF). Use the selector argument to specify which attribute. The units of all Rotation attributes are radians. | |
| SetDOFScale | Set a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the (uniform) Scale degree of freedom (DOF). Use the selector argument to specify which attribute. | |
| SetDOFScaleX | Set a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleX degree of freedom (DOF). Use the selector argument to specify which attribute. | |
| SetDOFScaleY | Set a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleY degree of freedom (DOF). Use the selector argument to specify which attribute. | |
| SetDOFShear | Set a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the Shear degree of freedom (DOF). Use the selector argument to specify which attribute. The units of all Shear attributes are radians. | |
| 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. | |
| SfContrastThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by ContrastThreshold may have changed. | |
| SfDeformationRate | This bit will be set in the EventArgs of a Changed event every time the value returned by DeformationRate may have changed. | |
| SfDOFEnable | This bit will be set in the EventArgs of a Changed event every time the value returned by DOFEnable may have changed. | |
| SfGetDOFRotation | This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFRotation may have changed. | |
| SfGetDOFScale | This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFScale may have changed. | |
| SfGetDOFScaleX | This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFScaleX may have changed. | |
| SfGetDOFScaleY | This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFScaleY may have changed. | |
| SfGetDOFShear | This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFShear may have changed. | |
| SfNextSf | ||
| SfRefinement | This bit will be set in the EventArgs of a Changed event every time the value returned by Refinement may have changed. | |
| SfUncertaintyX | This bit will be set in the EventArgs of a Changed event every time the value returned by UncertaintyX may have changed. | |
| SfUncertaintyY | This bit will be set in the EventArgs of a Changed event every time the value returned by UncertaintyY may have changed. | |
| SfXYOverlap | This bit will be set in the EventArgs of a Changed event every time the value returned by XYOverlap may have changed. |
Properties
| Name | Description | |
|---|---|---|
| AcceptThreshold | This threshold is used to locate character shapes in the runtime image. | |
| 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.) | |
| ContrastThreshold | The ContrastThreshold applies to individual characters, and in theory if the threshold is higher than the grey level contrast of a character in the run-time image, the character will not be found. When CogOCVMaxPattern.CharacterRegistration is set to Standard, the measure of contrast is exactly that used by CogPMAlignPattern. When CogOCVMaxPattern.CharacterRegistration is set to Correlation, the measure of contrast is an approximation of that used by CogPMAlignPattern: it is approximately the average edge contrast of the character. | |
| DeformationRate | The maximum deformation rate to be accommodated in flexible alignment of characters. Note that larger values may increase running time, and will make it easier for the tool to become confused between characters with similar appearance. For example, a U could be flexed into a V, or a 5 into an S, when allowing a sufficiently high deformation rate. Set this to the smallest value that works for your application's particular deformation. A value of 0 still allows some deformation. | |
| DOFEnable | The degrees of freedom (DOFs) to be searched. There are five degrees of freedom: Rotation, (uniform) Scale, ScaleX, ScaleY, and Shear. Any combination of these (including None) may be searched. If a particular DOF is enabled, the search will be performed between that DOF's LowerLimit and UpperLimit values, otherwise the search will be performed with that DOF's Nominal value. | |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) | |
| Refinement | The amount of refinement done on the transform that represents the deformation for a particular character. If None is selected, there may be small amounts of error in the deformation. If Coarse is selected, the transform will be refined to the limit of accuracy of the coarse grain limit used. If Stretch is selected, the transform will also be refined to resolve high-level inaccuracies (extreme warping of a character) that can occur in some applications. If Fine is selected, the transform will additionally be refined to the limit of accuracy of the fine grain limit used, which is probably more than is necessary for OCV in most cases, unless the character size in the image is very small. Less refinement means the tool runs faster. | |
| 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.) | |
| UncertaintyX | This is the uncertainty of the starting pose in the X dimension, in selected space coordinates. This value is used by both CogOCVMaxRunParams::KeySearchParams and CogOCVMaxRunParams::StartPoseSearchParams. This value is ignored in CogOCVMaxRunParams::ImageSearchParams. | |
| UncertaintyY | This is the uncertainty of the starting pose in the Y dimension, in selected space coordinates. This value is used by both CogOCVMaxRunParams::KeySearchParams and CogOCVMaxRunParams::StartPoseSearchParams. This value is ignored in CogOCVMaxRunParams::ImageSearchParams. | |
| XYOverlap | This is the amount of XY overlap above which two results are considered to be the same. |
Events
| Name | Description | |
|---|---|---|
| Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also