CogBeadInspectFindParams Class

Cognex VisionPro 9.7

This class holds the parameters used to find coarse paths in a training image.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.EdgeInspect CogBeadInspectFindParams

Namespace: Cognex.VisionPro.EdgeInspect
Assembly: Cognex.VisionPro.EdgeInspect (in Cognex.VisionPro.EdgeInspect.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogBeadInspectFindParams : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class CogBeadInspectFindParams : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class CogBeadInspectFindParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogBeadInspectFindParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

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

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

The CogBeadInspectFindParams type exposes the following members.

Constructors

	Name	Description
	CogBeadInspectFindParams	Constructs a default CogBeadInspectFindParams object.
	CogBeadInspectFindParams(CogBeadInspectFindParams)	Constructs a deep copy of the supplied CogBeadInspectFindParams object.
	CogBeadInspectFindParams(SerializationInfo, StreamingContext)	Serialization constructor for CogBeadInspectFindParams 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 CogBeadInspectFindParams 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 CogBeadInspectFindParams 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
	SfAutoCompute
	SfBeadWidth
	SfContrastThreshold
	SfDarkBead
	SfMaxNumResults
	SfMaxSkipCount
	SfMaxWidthDeviation
	SfNextSf
	SfStartCircle	This bit will be set in the EventArgs of a Changed event every time the value returned by StartCircle may have changed.

Top

Properties

	Name	Description
	AutoCompute	Gets or sets the flag to indicate whether the ContrastThreshold, the BeadWidth, and the DarkBead properties are computed automatically.
	BeadWidth	Gets or sets the width of the bead to search for.
	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.)
	ContrastThreshold	Gets or sets the contrast threshold used to detect the bead edges.
	DarkBead	Gets or sets the flag to indicate whether the bead is darker than the background.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	MaxNumResults	Gets or sets the maximum number of results to return. Each result represents a possible bead path that the algorithm found.
	MaxSkipCount	Gets or sets the maximum acceptable GAP length along the bead during the find. It is defined by how many jumps the algorithm can continue searching for a bead along its current direction. The count refers to the number of jumps. The size of each jump is based on the bead width.
	MaxWidthDeviation	Gets or sets the maximum allowable bead width change specified as a fraction of the bead width.
	StartCircle	Gets or Sets the start circle. The center of this circle is used as a starting location by the pattern's Find method.
	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.)

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

Instances of this class are held by the FindParams property of a CogBeadInspectPattern object. You can call the pattern's Find method to locate coarse paths in the TrainImage of that pattern. Calling Find will automatically use the contained instance of this class to control how the paths are found.

If any properties of this class are changed, the containing pattern will discard all coarse paths held by that pattern and the pattern's Found property will return false. This will also untrain the pattern if it was previously trained.

For more information on the definition of a coarse path in this context, please refer to the remarks section of the CogBeadInspectPattern class.