Cog3DRangeImageCrossSectionProfileParams Class

Cognex VisionPro

The Cross Section profile params class. It is a lightweight class with two properties: a region specified in the range image 2D selected space name and the ProfileDefaultSpaceName. The execute method creates the profile. The region specifies how the slice is aligned with the part in the range image. The region in this tool is very similar to the region used in the caliper tool. The region is limited to an affine rectangle like the region in the caliper tool.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro3D Cog3DRangeImageCrossSectionProfileParams

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class Cog3DRangeImageCrossSectionProfileParams : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class Cog3DRangeImageCrossSectionProfileParams : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class Cog3DRangeImageCrossSectionProfileParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class Cog3DRangeImageCrossSectionProfileParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

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

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

The Cog3DRangeImageCrossSectionProfileParams type exposes the following members.

Constructors

	Name	Description
	Cog3DRangeImageCrossSectionProfileParams	Construct a default Cog3DRangeImageCrossSectionProfileParams object.
	Cog3DRangeImageCrossSectionProfileParams(Cog3DRangeImageCrossSectionProfileParams)	Construct a deep copy of the supplied Cog3DRangeImageCrossSectionProfileParams object.
	Cog3DRangeImageCrossSectionProfileParams(SerializationInfo, StreamingContext)	Serialization constructor for Cog3DRangeImageCrossSectionProfileParams 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	Destruct this Cog3DRangeImageCrossSectionProfileParams.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Creates the profile.
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	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	Implements the GetObjectData method of the ISerializable interface. (Inherited from CogSerializableObjectBase.)
	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
	SfNextSf	NextSf state flag.
	SfProfileDefaultSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by ProfileDefaultSpaceName may have changed.
	SfRegion	This bit will be set in the EventArgs of a Changed event every time the value returned by Region 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. (Inherited from CogSerializableChangedEventBase.)
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	ProfileDefaultSpaceName	Gets or sets the ProfileDefaultSpaceName.
	Region	Gets or sets the 2D region in the range 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.)

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

The origin of the default profile space is defined by the rectangle that specifies the cutting plane: The profile default space x-axis begins at the start point of the cutting plane rectangle (start of the region). The end point of the cutting plane rectangle identifies the positive direction of the x-axis (end of the region). The start point of the profile is always associated with midpoint of the region affine rectangle between CornerOrigin and CornerY. The profile default space y-axis begins where image z is equal to 0 in the range image. The default y axis is directed out of the range image, straight toward the viewer, through the “start” point.