CogPatInspectRunParams Class

Cognex VisionPro

Provides access to PatInspect run-time parameters. The run-time parameters are used to indicate how the PatInspect inspection will be performed and what data will be generated as part of the PatInspect result.

Inheritance Hierarchy

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

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 CogPatInspectRunParams : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent

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

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

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

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

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

The CogPatInspectRunParams type exposes the following members.

Constructors

	Name	Description
	CogPatInspectRunParams	Constructs a new instance of this class.
	CogPatInspectRunParams(IntPtr)	Constructs a new instance of this class using com pointer.
	CogPatInspectRunParams(CogPatInspectRunParams)	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.)
	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.)
	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 )	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.)
	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.
	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
	SfComputeCorrelationScore	This bit will be set in the EventArgs of a Changed event every time the value returned by ComputeCorrelationScore may have changed.
	SfDifferenceImages	This bit will be set in the EventArgs of a Changed event every time the value returned by DifferenceImages may have changed.
	SfDifferenceImagesRaw	This bit will be set in the EventArgs of a Changed event every time the value returned by DifferenceImagesRaw may have changed.
	SfMatchImages	This bit will be set in the EventArgs of a Changed event every time the value returned by MatchImages may have changed.
	SfNeighborhoodHeight	This bit will be set in the EventArgs of a Changed event every time the value returned by NeighborhoodHeight may have changed.
	SfNeighborhoodWidth	This bit will be set in the EventArgs of a Changed event every time the value returned by NeighborhoodWidth may have changed.
	SfNormalizationMode	This bit will be set in the EventArgs of a Changed event every time the value returned by NormalizationMode may have changed.
	SfTailHigh	This bit will be set in the EventArgs of a Changed event every time the value returned by TailHigh may have changed.
	SfTailLow	This bit will be set in the EventArgs of a Changed event every time the value returned by TailLow 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.
	ComputeCorrelationScore	If true then the result object will contain a score indicating the correlation between the trained pattern image and the run-time match image.
	DifferenceImages	The difference images that will be created at run-time. Images indicate differences between the normalized input image and trained pattern image after thresholding is performed. Specified by ORing together the desired difference image constants.
	DifferenceImagesRaw	The raw difference images that will be created at run-time. Images indicate raw differences between the normalized input image and trained pattern image with no thresholding performed. Specified by ORing together the desired difference image constants.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	MatchImages	The match images that will be created at run-time. Specified by ORing together the desired match image constants.
	NeighborhoodHeight	The height in pixels of the neighborhood to be used when NormalizationMode is either LocalCorrection or LocalCorrectionEnhanced.
	NeighborhoodWidth	The width in pixels of the neighborhood to be used when NormalizationMode is either LocalCorrection or LocalCorrectionEnhanced.
	NormalizationMode	Normalization mode to be applied to the input image prior to performing the intensity difference operation.
	TailHigh	The percentage of pixels to discard on the high end of the grey scale spectrum prior to performing tail matching normalization. Only applicable if match tails is selected for the NormalizationMode.
	TailLow	The percentage of pixels to discard on the low end of the grey scale spectrum prior to performing tail matching normalization. Only applicable if match tails is selected for the NormalizationMode.

Top

Events

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

Top

Remarks

Provides access to PatInspect run-time parameters, which are used to indicate how the PatInspect inspection will be performed and what data will be generated as part of the PatInspect result.