CogOCVPatternPosition ClassCognex VisionPro 9.8
Default interface provides access to the properties for setting the run-time expected position of a pattern and the uncertainty of the expected position. Character positions in a pattern are specified with respect to the expected position of the pattern.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.OC CogOCVPatternPosition

Namespace: Cognex.VisionPro.OC
Assembly: Cognex.VisionPro.OC (in Cognex.VisionPro.OC.dll) Version: 75.1.0.0
Syntax

[SerializableAttribute]
public class CogOCVPatternPosition : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent

The CogOCVPatternPosition type exposes the following members.

Constructors

  NameDescription
Public methodCogOCVPatternPosition 
Constructs a new instance of this class.
Public methodCogOCVPatternPosition(IntPtr)
Constructs a new instance of this class using com pointer.
Public methodCogOCVPatternPosition(CogOCVPatternPosition)
Constructs a new instance of this class as a deep copy of the given instance.
Top
Methods

  NameDescription
Protected methodClone
Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject
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.)
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
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.)
Public methodResumeAndRaiseChangedEvent
Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also 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.
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.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberSfExpectedPose
This bit will be set in the EventArgs of a Changed event every time the value returned by ExpectedPose may have changed.
Public fieldStatic memberSfRotationUncertainty
This bit will be set in the EventArgs of a Changed event every time the value returned by RotationUncertainty may have changed.
Public fieldStatic memberSfScalingUncertainty
This bit will be set in the EventArgs of a Changed event every time the value returned by ScalingUncertainty may have changed.
Public fieldStatic memberSfSelectedSpaceName
This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedSpaceName may have changed.
Public fieldStatic memberSfTranslationUncertainty
This bit will be set in the EventArgs of a Changed event every time the value returned by TranslationUncertainty may have changed.
Top
Properties

  NameDescription
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.
Public propertyExpectedPose
The run-time expected position of a pattern. Character positions in a pattern are specified with respect to the expected position of the pattern.
Public propertyHasChanged
If true, the serializable state of this object has changed since the last time it was serialized.
Public propertyRotationUncertainty
Rotation uncertainty specifies the +/- range (in radians) that the pattern may vary from its expected rotation. Uncertainty value must be greater than or equal to zero.
Public propertyScalingUncertainty
Scaling uncertainty specifies the +/- range that the pattern may vary from its expected scaling factor. Uncertainty value must be greater than or equal to zero.
Public propertySelectedSpaceName
Specifies which space of the input image's coordinate space tree is used to define the expected position of the pattern.
Public propertyTranslationUncertainty
Translation uncertainty specifies the +/- range that the pattern may vary from its expected x,y position. Uncertainty value must be greater than or equal to zero.
Top
Events

  NameDescription
Public eventChanged
Occurs when one or more parts of the object's state may have changed.
Top
Remarks

Interface that lets you specify the expected run-time position of the overall pattern. The pattern position is the pose of the pattern origin in the specified space of the input image, where the pattern origin is implicitly defined by the translation, rotation, and scale of the individual CogOCVCharacterPositions in the pattern.

See Also