CogFindCircle Class

Cognex VisionPro 9.7

Class which contains the run parameters of a circle finder.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Caliper CogFindCircle

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogFindCircle type exposes the following members.

Constructors

	Name	Description
	CogFindCircle	Constructs a new instance of this class.
	CogFindCircle(IntPtr)	Constructs a new instance of this class using com pointer.
	CogFindCircle(CogFindCircle)	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.)
	Execute	Finds a Circle in the provided image by fitting the highest scoring edge points found by a suite of calipers defined by the run parameters.
	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
	SfCaliperProjectionLength	This bit will be set in the EventArgs of a Changed event every time the value returned by CaliperProjectionLength may have changed.
	SfCaliperRunParams	This bit will be set in the EventArgs of a Changed event every time the value returned by CaliperRunParams may have changed.
	SfCaliperSearchDirection	This bit will be set in the EventArgs of a Changed event every time the value returned by CaliperSearchDirection may have changed.
	SfCaliperSearchLength	This bit will be set in the EventArgs of a Changed event every time the value returned by CaliperSearchLength may have changed.
	SfDecrementNumToIgnore	This bit will be set in the EventArgs of a Changed event every time the value returned by DecrementNumToIgnore may have changed.
	SfExpectedCircularArc	This bit will be set in the EventArgs of a Changed event every time the value returned by ExpectedCircularArc may have changed.
	SfNumCalipers	This bit will be set in the EventArgs of a Changed event every time the value returned by NumCalipers may have changed.
	SfNumToIgnore	This bit will be set in the EventArgs of a Changed event every time the value returned by NumToIgnore may have changed.
	SfRadiusConstraint	This bit will be set in the EventArgs of a Changed event every time the value returned by RadiusConstraint may have changed.
	SfRadiusConstraintEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by RadiusConstraintEnabled may have changed.

Top

Properties

	Name	Description
	CaliperProjectionLength	The length of each caliper region along the caliper projection direction. Specified in units of the selected space of the input image.
	CaliperRunParams	Parameters used to run the calipers.
	CaliperSearchDirection	Indicates whether each caliper should search inward towards the center of the Circle, or outward away from the center of the Circle.
	CaliperSearchLength	The length of each caliper region along the caliper search direction. Specified in units of the selected space of the input image.
	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.
	DecrementNumToIgnore	If DecrementNumToIgnore is true then the number of points ignored is actually (NumToIgnore - Number of calipers that found no edge).
	ExpectedCircularArc	The expected CircularArc which is used to position the calipers for finding the Circle.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	NumCalipers	Number of calipers used to find the Circle. NumCalipers - NumToIgnore must be greater than or equal to the minimum number of points required to find the shape. For example, minimum points for a line = 2, circle = 3, & ellipse = 5.
	NumToIgnore	The number of points that will be ignored in the fitting operation. If DecrementNumToIgnore is true then the number of points ignored is actually (NumToIgnore - Number of calipers that found no edge).
	RadiusConstraint	The value that the radius of the circle will be constrained to if radius is constrained.
	RadiusConstraintEnabled	Whether radius will be constrained for the fit.

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 both the circle finder run parameters and an execute method for performing a circle finder inspection.