CogCaliperScorerContrast Class

Cognex VisionPro

Scoring function which scores the contrast of a candidate edge.

Inheritance Hierarchy

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

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogCaliperScorerContrast type exposes the following members.

Constructors

	Name	Description
	CogCaliperScorerContrast	Constructs a new instance of this class.
	CogCaliperScorerContrast(IntPtr)	Constructs a new instance of this class using com pointer.
	CogCaliperScorerContrast(CogCaliperScorerContrast)	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.)
	GetXYParameters	Get the parameters used to map an edge candidate's contrast to a score. Contrast is the absolute difference in average pixel values across the edge, and has a range of 0 through 255. Score is a unitless value in the range of 0.0 (no edge found) through 1.0 (edge found).
	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.
	Scores	Whether this scorer applies for the given number of edges.
	SetXYParameters	Set the parameters used to map an edge candidate's contrast to a score. Contrast is the absolute difference in average pixel values across the edge, and has a range of 0 through 255. Score is a unitless value in the range of 0.0 (no edge found) through 1.0 (edge found).
	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
	SfEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by Enabled may have changed.
	SfGetXYParameters	This bit will be set in the EventArgs of a Changed event every time the value returned by GetXYParameters 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.
	Enabled	Whether this scorer will be used.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.

Top

Events

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

Top

Remarks

A scoring function that scores the contrast of a candidate edge. This is a one-sided scoring function object; you use SetXYParameters(Double, Double, Double, Double, Double) to set the individual values that define this function.

You use this scoring function to score edge candidates based on the contrast of the edge or edges in the candidate. To assign increasing scores as edge contrast increases, specify a function in which X0 is greater than X1 and X1 is greater than XC, as shown below:

To assign decreasing scores as edge contrast increases, specify a function in which XC is greater than X1 and X1 is greater than X0, as shown below:

The contrast of an edge is expressed in terms of the change in pixel values divided by the size of the edge in pixels; the largest possible contrast value is 255.