CogOCVMaxSearchParams ClassCognex VisionPro 9.7
This class encapsulates all of the parameters used to run the arrangement and/or character searches.
Inheritance Hierarchy

System Object
  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: 73.0.0.0
Syntax

[SerializableAttribute]
public class CogOCVMaxSearchParams : CogSerializableChangedEventBase, 
	IDisposable

The CogOCVMaxSearchParams type exposes the following members.

Constructors

  NameDescription
Public methodCogOCVMaxSearchParams 
Public methodCogOCVMaxSearchParams(CogOCVMaxSearchParams)
Protected methodCogOCVMaxSearchParams(SerializationInfo, StreamingContext)
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 
Protected methodDispose(Boolean)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize (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.)
Public methodGetDOFRotation
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.
Public methodGetDOFScale
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.
Public methodGetDOFScaleX
Get a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleX degree of freedom (DOF). Use the selector argument to specify which attribute.
Public methodGetDOFScaleY
Get a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleY degree of freedom (DOF). Use the selector argument to specify which attribute.
Public methodGetDOFShear
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.
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 (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 methodSetDOFRotation
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.
Public methodSetDOFScale
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.
Public methodSetDOFScaleX
Set a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleX degree of freedom (DOF). Use the selector argument to specify which attribute.
Public methodSetDOFScaleY
Set a particular attribute (LowerLimit, Nominal, UpperLimit, or Overlap) of the ScaleY degree of freedom (DOF). Use the selector argument to specify which attribute.
Public methodSetDOFShear
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.
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 memberSfContrastThreshold
This bit will be set in the EventArgs of a Changed event every time the value returned by ContrastThreshold may have changed.
Public fieldStatic memberSfDeformationRate
This bit will be set in the EventArgs of a Changed event every time the value returned by DeformationRate may have changed.
Public fieldStatic memberSfDOFEnable
This bit will be set in the EventArgs of a Changed event every time the value returned by DOFEnable may have changed.
Public fieldStatic memberSfGetDOFRotation
This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFRotation may have changed.
Public fieldStatic memberSfGetDOFScale
This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFScale may have changed.
Public fieldStatic memberSfGetDOFScaleX
This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFScaleX may have changed.
Public fieldStatic memberSfGetDOFScaleY
This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFScaleY may have changed.
Public fieldStatic memberSfGetDOFShear
This bit will be set in the EventArgs of a Changed event every time the value returned by GetDOFShear may have changed.
Protected fieldStatic memberSfNextSf
Public fieldStatic memberSfRefinement
This bit will be set in the EventArgs of a Changed event every time the value returned by Refinement may have changed.
Public fieldStatic memberSfUncertaintyX
This bit will be set in the EventArgs of a Changed event every time the value returned by UncertaintyX may have changed.
Public fieldStatic memberSfUncertaintyY
This bit will be set in the EventArgs of a Changed event every time the value returned by UncertaintyY may have changed.
Public fieldStatic memberSfXYOverlap
This bit will be set in the EventArgs of a Changed event every time the value returned by XYOverlap may have changed.
Top
Properties

  NameDescription
Public propertyAcceptThreshold
This threshold is used to locate character shapes in the runtime image.
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 propertyContrastThreshold
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.
Public propertyDeformationRate
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.
Public propertyDOFEnable
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.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyRefinement
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.
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 propertyUncertaintyX
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.
Public propertyUncertaintyY
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.
Public propertyXYOverlap
This is the amount of XY overlap above which two results are considered to be the same.
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
See Also