CogPMRedLineRunParams Class

Cognex VisionPro 9.24

Class that holds the PMRedLine run parameters. These parameters control how PMRedLine locates patterns in the runtime image.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.PMRedLine CogPMRedLineRunParams

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.dll) Version: 91.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogPMRedLineRunParams : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class CogPMRedLineRunParams : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class CogPMRedLineRunParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogPMRedLineRunParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

[SerializableAttribute]
public ref class CogPMRedLineRunParams : public CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public ref class CogPMRedLineRunParams : public CogSerializableChangedEventBase, 
	IDisposable

The CogPMRedLineRunParams type exposes the following members.

Constructors

	Name	Description
	CogPMRedLineRunParams	Constructs a default CogPMRedLineRunParams object.
	CogPMRedLineRunParams(CogPMRedLineRunParams)	Constructs a deep copy of the supplied CogPMRedLineRunParams object.
	CogPMRedLineRunParams(SerializationInfo, StreamingContext)	Serialization constructor for CogPMRedLineRunParams object.

Top

Methods

	Name	Description
	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	Releases all resources used by this CogPMRedLineRunParams object.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Releases all unmanaged resources used by this CogPMRedLineRunParams object. (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	Populates the provided SerializationInfo with the data needed to serialize the object. (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
	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.)
	OnChanged(Int64)	This method should be called internally whenever the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	OnChanged(CogChangedEventArgs)	This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class. (Inherited from CogSerializableChangedEventBase.)
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called, and 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. (Inherited from CogSerializableChangedEventBase.)
	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. (Inherited from CogSerializableChangedEventBase.)
	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.
	SfAccuracyMode	This bit will be set in the EventArgs of a Changed event every time the value returned by AccuracyMode may have changed.
	SfCoarseAcceptThresholdFraction	This bit will be set in the EventArgs of a Changed event every time the value returned by CoarseAcceptThresholdFraction may have changed.
	SfCoarseAcceptThresholdFractionEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by CoarseAcceptThresholdFractionEnabled may have changed.
	SfContrastFractionThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by ContrastFractionThreshold may have changed.
	SfIgnorePolarity	This bit will be set in the EventArgs of a Changed event every time the value returned by IgnorePolarity may have changed.
	SfNextSf
	SfNumberToFind	This bit will be set in the EventArgs of a Changed event every time the value returned by NumberToFind may have changed.
	SfReturnAllResults	This bit will be set in the EventArgs of a Changed event every time the value returned by ReturnAllResults may have changed.
	SfScoreUsingClutter	This bit will be set in the EventArgs of a Changed event every time the value returned by ScoreUsingClutter may have changed.
	SfSearchImageMask	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchImageMask may have changed.
	SfSearchImageMaskOffsetX	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchImageMaskOffsetX may have changed.
	SfSearchImageMaskOffsetY	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchImageMaskOffsetY 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.
	SfTimeout	This bit will be set in the EventArgs of a Changed event every time the value returned by Timeout may have changed.
	SfTimeoutEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by TimeoutEnabled 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	Gets or sets the acceptance threshold for 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 zero to one.
	AccuracyMode	Gets or sets the desired level of accuracy for result poses. PMRedLine may run faster if your application can tolerate lower accuracy.
	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. (Inherited from CogSerializableChangedEventBase.)
	CoarseAcceptThresholdFraction	Gets or sets the fraction of the accept threshold that should be used to evaluate candidate scores during the coarse phase of PMRedLine.
	CoarseAcceptThresholdFractionEnabled	Gets or sets whether to enable the coarse accept threshold fraction.
	ContrastFractionThreshold	Gets or sets the threshold for the contrast fraction of a result. Only instances of the pattern that have a contrast fraction greater than or equal to this threshold are accepted. Valid range is from zero to one.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	IgnorePolarity	Gets or sets whether to ignore the polarity of edge features when searching for patterns. If "true", the polarity of the pattern features is ignored. If "false", only patterns whose polarity matches the trained pattern will be found.
	NumberToFind	Gets or sets the number of results to search for.
	ReturnAllResults	Gets or sets whether PMRedLine should return only the results that you asked for or whether it should also return results that are similar to the ones you asked for.
	ScoreUsingClutter	Gets or sets whether PMRedLine should reduce the score of results that contain extraneous features at the found image location. Extraneous features are known as clutter. They appear in the runtime image at locations which should be empty.
	SearchImageMask	Gets or sets the mask to be used when running CogPMRedLine. The mask allows you to identify areas of the runtime input image as "Care" or "Don't Care".
	SearchImageMaskOffsetX	Gets or sets the X offset (in pixels) for the search image mask.
	SearchImageMaskOffsetY	Gets or sets the Y offset (in pixels) for the search image mask.
	SearchRegionMode	Gets or sets the search region mode. This mode specifies how the search region is applied to the input image.
	StateFlags	Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... } (Inherited from CogSerializableChangedEventBase.)
	Timeout	Gets or sets the maximum execution time (in msec) allowed when a PMRedLine tool is run. This value only applies if TimeoutEnabled is set to "true".
	TimeoutEnabled	Gets or sets whether to enable the runtime timeout.
	XYOverlap	Gets or sets the area overlap threshold.
	ZoneAngle	Gets the zone configuration for the angle degree of freedom.
	ZoneScale	Gets the zone configuration for the scale degree of freedom.

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)

Top

Remarks

This class must be provided as an argument to the Execute(ICogImage, ICogRegion, CogPMRedLineRunParams) method of the CogPMRedLinePattern class. The Execute() method is called automatically every time you call the Run method of the CogPMRedLineTool class, causing the tool to search the InputImage for instances of the pattern.