CogBeadInspectTrainResult Class

Cognex VisionPro 9.7

Class that holds a BeadInspect train result. An instance of this class is created by every successful call to the Train method.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.EdgeInspect CogBeadInspectTrainResult

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 CogBeadInspectTrainResult : CogSerializableObjectBase, 
	IDisposable

[SerializableAttribute]
public class CogBeadInspectTrainResult : CogSerializableObjectBase, 
	IDisposable

<SerializableAttribute>
Public Class CogBeadInspectTrainResult 
	Inherits CogSerializableObjectBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogBeadInspectTrainResult 
	Inherits CogSerializableObjectBase 
	Implements IDisposable

[SerializableAttribute]
public ref class CogBeadInspectTrainResult : public CogSerializableObjectBase, 
	IDisposable

[SerializableAttribute]
public ref class CogBeadInspectTrainResult : public CogSerializableObjectBase, 
	IDisposable

The CogBeadInspectTrainResult type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	AddCalipersWithinRegionToList	Identifies all trained calipers whose center lies within the given region. The index of each such caliper is used to set the corresponding boolean entry of listToUpdate to the given Boolean value. List entries for all other indices are unchanged.
	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.)
	CreateTrainResultGraphics	Creates and returns a collection of graphics that depict the trained calipers. The graphics can be augmented with information from the mask, right fill, or left fill lists of the given runParams. The desired graphics are specified by the given graphicOptions.
	Dispose	Releases all resources used by this CogBeadInspectTrainResult 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 CogBeadInspectTrainResult 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.)
	GetCaliperCenterLengthsRotationSkew	Fills the geometric output arguments for the given caliper index. The numerical output arguments define the affine rectangle of the caliper at the given index along the trained path.
	GetCaliperPointMarker	Returns a CogPointMarker that describes the center of the caliper at the given index.
	GetCaliperRectangleAffine	Returns a CogRectangleAffine that describes the caliper at the given index.
	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.)
	GetSuggestedRunParams	Returns CogBeadInspectRunParams that are customized for use with this train result. These "suggested" RunParams might be a useful starting point for runtime defect inspection.
	GetTrainedPath	Returns a CogGeneralContour that represents the trained path.
	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.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	NumTrainedCalipers	Gets the total number of calipers that lie along the trained bead path.

Top

Remarks

The train result holds a smoothed path that represents the center line of the trained bead. A sequence of CogCaliperTools is laid out along this path and these calipers are used at runtime to inspect for defects in the bead. The number of calipers trained, and their positions along the path, are part of the train result.

The train result also provides a "suggested" set of CogBeadInspectRunParams. These RunParams are tuned for the trained path, and might be a useful starting point for runtime defect inspection.

For more information on the definition of a bead or path, please refer to the CogBeadInspectPattern remarks.