CogPMAlignResult Class

Cognex VisionPro 9.5

Class which holds a single PMAlign result. Each result corresponds to a found instance of the pattern.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.PMAlign CogPMAlignResult

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogPMAlignResult : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable

[SerializableAttribute]
public class CogPMAlignResult : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable

<SerializableAttribute>
Public Class CogPMAlignResult 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable

<SerializableAttribute>
Public Class CogPMAlignResult 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable

[SerializableAttribute]
public ref class CogPMAlignResult : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable

[SerializableAttribute]
public ref class CogPMAlignResult : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable

The CogPMAlignResult type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	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.)
	CreateResultGraphics	Creates a composite result graphic containing child graphics specified by the GraphicOptions which is a bitwise combination of CogPMAlignResultGraphicConstants.
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInfoIDs
	GetInfoStrings	Gets run-time diagnostic message text string(s) for this individual PMAlign result. If there are no messages then the collection will be empty. The corresponding message ID(s) can be obtained from the GetInfoIDs method.
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData
	GetPose	Transform from "Pattern Space" to the selected space of the run-time input image. This transform can be used to find any point relative to the pattern in the selected space of the run-time input image.
	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.)
	GetRunImageFromTrainImagePerspectiveTransformElements	Cognex Internal Use Only.
	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.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	Accepted	True if the result's Score was >= the ICogPMAlignRunParams::AcceptThreshold.
	Clutter	Clutter score is the number of extraneous features present in this result divided by the number of features in the trained pattern. The value ranges from 0.0 to infinity. Only available for PatMax, -1 is always returned for PatQuick.
	Contrast	Contrast measurement of this result which is the average of the pixel gradient measurements across all feature boundaries.
	Coverage	Coverage score is the fraction (0.0 to 1.0) of features in the trained pattern that are found in this result. Only available for PatMax, -1 is always returned for PatQuick.
	FineStage	True if this result is from the fine stage of processing, and false if this result is from the coarse stage of processing.
	FitError	Quality measure that indicates the degree to which the found pattern features conform to the trained pattern, without regard to missing features. Zero is a perfect fit. Infinity is a poor fit. Only available for PatMax, -1 returned for PatQuick.
	ID	A unique ID used to identify this PMAlign result. This ID also corresponds to the index of this result in the CogPMAlignResults to which this result belongs.
	MaxCoarseAcceptThreshold	Gets the maximum coarse accept threshold that would allow this result to be found.
	ModelID	The pattern unique ID.
	ModelName	The pattern name. The pattern name is only available for multi-model.
	OutsideRegionAreaProportion	The proportion of pattern area that is outside the search region.
	OutsideRegionFeatureProportion	The proportion of pattern features that is outside the search region.
	Score	Score for this result. The score is between 0.0 and 1.0 with higher values indicating a closer match between the trained pattern and the pattern in the search image.
	UnwarpedInputImage	Gets run-time input image unwarped by the flex deformation found for this result. Returns Nothing (NULL) if PatFlex was not run or SaveDeformationInfo was not set to cogPMAlignFlexDeformationInfoTransformAndUnwarpData on last run.

Top

Remarks

A CogPMAlignResult interface provides access to information about the results of a PMAlign pattern location operation.