CogOCVCharacterPosition Class

Cognex VisionPro

Default interface of this class provides access to the character position parameters. User can specify which character models to verify, their expected position and positional uncertainties, as well as their accept and confidence thresholds.

Inheritance Hierarchy

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

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

Syntax

C++

Copy to Clipboard Print

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

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

<SerializableAttribute>
Public Class CogOCVCharacterPosition 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent

<SerializableAttribute>
Public Class CogOCVCharacterPosition 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent

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

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

The CogOCVCharacterPosition type exposes the following members.

Constructors

	Name	Description
	CogOCVCharacterPosition	Constructs a new instance of this class.
	CogOCVCharacterPosition(IntPtr)	Constructs a new instance of this class using com pointer.
	CogOCVCharacterPosition(CogOCVCharacterPosition)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	AddFontModel	Add a new font model to the end of the list of model candidates to be verified at this character position. FontModelCount will increment by one.
	Clone	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
	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.)
	DeleteFontModel	Delete the font model specified by Index from the list of model candidates to be verified at this character position. FontModelCount will decrement by one.
	Dispose
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (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.)
	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.)
	GetFontModel	Get the name and instance of the font model specified by the index.
	GetFontModelInstance	The Instance of the font model candidate specified via Index. OCV verifies the highest scoring candidate. Models are specified using both FontModelName & FontModelInstance. Index must be greater than or equal to zero and less than FontModelCount.
	GetFontModelName	The Name of the font model candidate specified via Index. OCV verifies the highest scoring candidate. Models are specified using both FontModelName & FontModelInstance. Index must be greater than or equal to zero and less than FontModelCount.
	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
	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 )	(Overrides CogObjectBase GetProperties( Attribute ).)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetScalingRotationTranslation	Wide getter for character position. The character position is the position of a font model's origin with respect to the expected position of the pattern which the user supplies at run-time.
	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.)
	ResumeAndRaiseChangedEvent	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.
	SetFontModel	Set font model specified by the index to the new values.
	SetFontModelInstance	The Instance of the font model candidate specified via Index. OCV verifies the highest scoring candidate. Models are specified using both FontModelName & FontModelInstance. Index must be greater than or equal to zero and less than FontModelCount.
	SetFontModelName	The Name of the font model candidate specified via Index. OCV verifies the highest scoring candidate. Models are specified using both FontModelName & FontModelInstance. Index must be greater than or equal to zero and less than FontModelCount.
	SetScalingRotationTranslation	Wide setter for character position. The character position is the position of a font model's origin with respect to the expected position of the pattern which the user supplies at run-time.
	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.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfFontModelCount	This bit will be set in the EventArgs of a Changed event every time the value returned by FontModelCount may have changed.
	SfGetFontModelInstance	This bit will be set in the EventArgs of a Changed event every time the value returned by GetFontModelInstance may have changed.
	SfGetFontModelName	This bit will be set in the EventArgs of a Changed event every time the value returned by GetFontModelName may have changed.
	SfRotation	This bit will be set in the EventArgs of a Changed event every time the value returned by Rotation may have changed.
	SfRotationUncertainty	This bit will be set in the EventArgs of a Changed event every time the value returned by RotationUncertainty may have changed.
	SfRunTimeAcceptThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by RunTimeAcceptThreshold may have changed.
	SfRunTimeConfidenceThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by RunTimeConfidenceThreshold may have changed.
	SfScaling	This bit will be set in the EventArgs of a Changed event every time the value returned by Scaling may have changed.
	SfScalingUncertainty	This bit will be set in the EventArgs of a Changed event every time the value returned by ScalingUncertainty may have changed.
	SfTranslationUncertainty	This bit will be set in the EventArgs of a Changed event every time the value returned by TranslationUncertainty may have changed.
	SfTranslationX	This bit will be set in the EventArgs of a Changed event every time the value returned by TranslationX may have changed.
	SfTranslationY	This bit will be set in the EventArgs of a Changed event every time the value returned by TranslationY may have changed.
	SfUsePatternCharacterUncertainties	This bit will be set in the EventArgs of a Changed event every time the value returned by UsePatternCharacterUncertainties may have changed.
	SfUsePatternRunTimeCharacterThresholds	This bit will be set in the EventArgs of a Changed event every time the value returned by UsePatternRunTimeCharacterThresholds may have changed.

Top

Properties

	Name	Description
	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.
	FontModelCount	Number of model candidates for this position. OCV verifies the highest scoring candidate. Models are specified using FontModelName & FontModelInstance. Increasing count adds models with an empty name and instance of zero. Decreasing removes candidates.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	Rotation	The expected rotation, in radians, of this character position. The character position is the position of a font model's origin with respect to the expected position of the pattern which the user supplies at run-time.
	RotationUncertainty	Rotation uncertainty specifies the expected +/- range, in radians, of the image-to-image variation of a character's rotation. This is an unsigned value.
	RunTimeAcceptThreshold	The accept threshold specifies the matching score below which a character will fail verification.
	RunTimeConfidenceThreshold	The confidence score is the amount that a character's matching score must exceed the highest scoring confusing character in order to pass verification.
	Scaling	The expected scaling factor of this character position. The character position is the position of a font model's origin with respect to the expected position of the pattern which the user supplies at run-time.
	ScalingUncertainty	Scaling uncertainty specifies the expected +/- range of the of the image-to-image variation of a character's scaling factor. This is an unsigned value.
	TranslationUncertainty	Translation uncertainty specifies the expected +/- range of the image-to-image variation of a character's x,y position. This is an unsigned value.
	TranslationX	The expected X coordinate of this character position. This is the position of a font model's origin with respect to the expected position of the pattern which the user supplies at run-time.
	TranslationY	The expected Y coordinate of this character position. This is the position of a font model's origin with respect to the expected position of the pattern which the user supplies at run-time.
	UsePatternCharacterUncertainties	If true then this character position will use the common uncertainty settings in the pattern. Otherwise, this position will use the uncertainty settings specified by its own properties.
	UsePatternRunTimeCharacterThresholds	If set, the thresholds for the location will come from pattern's character location settings when the run-time parameter is built.

Top

Events

	Name	Description
	Changed	Occurs when one or more parts of the object's state may have changed.

Top

Remarks

Interface that provides access to the character position parameters. This interface lets you specify which character models to verify, their expected positions and positional uncertainties, as well as their accept and confidence thresholds.