CogPatInspectResult Class

Cognex VisionPro

The result of a single PatInspect inspection. A result basically consists of various flavors of both a match image and a difference image. The result images that will be available depend on the run-time property settings of the pattern.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.PatInspect CogPatInspectResult

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogPatInspectResult type exposes the following members.

Constructors

	Name	Description
	CogPatInspectResult	Constructs a new instance of this class.
	CogPatInspectResult(IntPtr)	Constructs a new instance of this class using com pointer.
	CogPatInspectResult(CogPatInspectResult)	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.)
	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.)
	GetDifferenceImage	Image that provides thresholded differences between the trained pattern image and the normalized match image. Returns Nothing if the bit that corresponds to WhichImage was not set in the run-time DifferenceImages property.
	GetDifferenceImageRaw	Image that provides unthresholded (raw) differences between the trained pattern image and the normalized match image. Returns Nothing if the bit that corresponds to WhichImage was not set in the run-time DifferenceImagesRaw property.
	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.)
	GetMatchImage	Image containing the region of the input image that matches the pattern. Match region is simply based on the Pose provided at run-time. Returns Nothing if the bit that corresponds to WhichImage was not set in the run-time MatchImages property.
	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.)
	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
	Clipped	Returns true if the match image was clipped because part of the region fell outside of the input image. The ClippedMask property will indicate which pixels of the match image were clipped.
	ClippedMask	Indicates which pixels of the MatchImage were clipped. If clipping occurred for a pixel in the MatchImage then the corresponding ClippedMask pixel will be set to 0, otherwise, it will be set to 255. This property returns Nothing if Clipped is false.
	CorrelationScore	Returns a score indicating the correlation between the trained pattern image and the run-time match image. This value will be in the range of zero for low correlation to one for high correlation.

Top

Remarks

The result of a single PatInspect analysis. A result basically consists of various match images and difference images, depending on the configured run-time parameters.