CogCNLSearchRunParams Class

Cognex VisionPro

Class which holds CNLSearch run parameters. The run parameters are used to control how CNLSearch locates matching patterns in the run-time image.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.CNLSearch CogCNLSearchRunParams

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogCNLSearchRunParams type exposes the following members.

Constructors

	Name	Description
	CogCNLSearchRunParams	Constructs a new instance of this class.
	CogCNLSearchRunParams(IntPtr)	Constructs a new instance of this class using com pointer.
	CogCNLSearchRunParams(CogCNLSearchRunParams)	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
	SfAcceptThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by AcceptThreshold may have changed.
	SfAccuracy	This bit will be set in the EventArgs of a Changed event every time the value returned by Accuracy may have changed.
	SfAlgorithm	This bit will be set in the EventArgs of a Changed event every time the value returned by Algorithm may have changed.
	SfConfusionThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by ConfusionThreshold may have changed.
	SfEdgeThresholdHigh	This bit will be set in the EventArgs of a Changed event every time the value returned by EdgeThresholdHigh may have changed.
	SfEdgeThresholdLow	This bit will be set in the EventArgs of a Changed event every time the value returned by EdgeThresholdLow may have changed.
	SfEdgeThresholdsUsePattern	This bit will be set in the EventArgs of a Changed event every time the value returned by EdgeThresholdsUsePattern may have changed.
	SfMaxResults	This bit will be set in the EventArgs of a Changed event every time the value returned by MaxResults may have changed.
	SfPartialMatchLimitDown	This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchLimitDown may have changed.
	SfPartialMatchLimitLeft	This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchLimitLeft may have changed.
	SfPartialMatchLimitRight	This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchLimitRight may have changed.
	SfPartialMatchLimitsUsePattern	This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchLimitsUsePattern may have changed.
	SfPartialMatchLimitUp	This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchLimitUp may have changed.
	SfPartialMatchReduceScore	This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchReduceScore may have changed.
	SfSearchPointEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchPointEnabled may have changed.
	SfSearchPointX	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchPointX may have changed.
	SfSearchPointY	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchPointY may have changed.
	SfSearchRegionMode	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchRegionMode may have changed.
	SfXYOverlap	This bit will be set in the EventArgs of a Changed event every time the value returned by XYOverlap may have changed.

Top

Properties

	Name	Description
	AcceptThreshold	Acceptance threshold on the score of a result. Only instances of the pattern that receive scores greater than or equal to this threshold are accepted. Valid range is from 0 to 1.
	Accuracy	The accuracy that should be used to perform a CNLSearch inspection. The accuracy specified must be among those for which the CNLSearch pattern object is trained.
	Algorithm	The algorithm that should be used to perform a CNLSearch inspection. The algorithm specified must be among those for which the CNLSearch pattern object is trained.
	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.
	ConfusionThreshold	Confusion threshold is a hint regarding how confusing the search image is likely to be. A high value slows the search but ensures that wrong features are not found. A low value speeds up the search for non-confusing scenes. Must be >= AcceptThreshold.
	EdgeThresholdHigh	All edges with strengths above the high threshold are included in the run-time edge map. Only applies to NonLinear CNLPAS.
	EdgeThresholdLow	Edges with strengths below the low threshold are excluded from the run-time edge map. Edges with strengths between low & high (inclusive) are included if 8-connected to an edge already belonging to the edge map. Only applies to NonLinear CNLPAS.
	EdgeThresholdsUsePattern	If true, the edge thresholds of ICogCNLSearchPattern will be used to generate a run-time edge map. If false, the edge thresholds in this run parameters interface will be used. Edge thresholds only apply to the NonLinear CNLPAS algorithm.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	MaxResults	CNLSearch will return up to the maximum number of results specified by this property.
	PartialMatchLimitDown	Limit-down specifies how many rows of pixels at the bottom of the pattern may lie outside of the search region and still be found. Ignored if PartialMatchLimitsUsePattern is true. Partial match results are not supported by the CNLPAS algorithms.
	PartialMatchLimitLeft	Limit-left specifies how many columns of pixels on the left side of the pattern may lie outside of the search region and still be found. Ignored if PartialMatchLimitsUsePattern is true. Partial match results are not supported by the CNLPAS algorithms.
	PartialMatchLimitRight	Limit-right specifies how many columns of pixels on the right side of the pattern may lie outside of the search region and still be found. Ignored if PartialMatchLimitsUsePattern is true. Partial match results are not supported by the CNLPAS algorithms.
	PartialMatchLimitsUsePattern	If true, the partial match limits of ICogCNLSearchPattern will be used at run-time. If false, the partial match limits in this run parameters interface will be used. Partial match limits only apply to the Linear Search algorithm.
	PartialMatchLimitUp	Limit-up specifies how many rows of pixels at the top of the pattern may lie outside of the search region and still be found. Ignored if PartialMatchLimitsUsePattern is true. Partial match results are not supported by the CNLPAS algorithms.
	PartialMatchReduceScore	If true, a matched pattern that lies partially outside of the image will receive a reduced score. In this case, the Score will be equal to (AreaScore * AreaCoverageScore). Otherwise, the Score is simply the AreaScore.
	SearchPointEnabled	If SearchPointEnabled is true then CNLSearch will search for a single instance of the pattern starting at the point specified by SearchPointX & Y. In this case, the SearchRegion is ignored. Search point is only supported by the Linear search algorithm.
	SearchPointX	CNLSearch will search for a single instance of this pattern starting at the point specified by SearchPointX & Y when SearchPointEnabled is true. This point corresponds to the pattern's origin and is specified in the selected space of the InputImage.
	SearchPointY	CNLSearch will search for a single instance of this pattern starting at the point specified by SearchPointX & Y when SearchPointEnabled is true. This point corresponds to the pattern's origin and is specified in the selected space of the InputImage.
	SearchRegionMode	Mode which specifies how the search region is to be applied to the input image of a CNLSearch inspection.
	XYOverlap	The maximum allowed percentage (0 to 1,inclusive) of overlap between two pattern instances. If the overlapping area of the two pattern instances is greater than the specified percentage, then the pattern instance with the lower score is discarded.

Top

Events

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

Top

Remarks

Interface which provides access to the CNLSearch run parameters. The run parameters are used to control how CNLSearch locates matching patterns in the run-time image.