Cog3DRangeImageCrossSectionProfile Class

Cognex VisionPro 9.7

The Cross Section profile class.

Inheritance Hierarchy

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

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class Cog3DRangeImageCrossSectionProfile : CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

[SerializableAttribute]
public class Cog3DRangeImageCrossSectionProfile : CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

<SerializableAttribute>
Public Class Cog3DRangeImageCrossSectionProfile 
	Inherits CogSerializableChangedEventBase 
	Implements IDeserializationCallback, IDisposable

<SerializableAttribute>
Public Class Cog3DRangeImageCrossSectionProfile 
	Inherits CogSerializableChangedEventBase 
	Implements IDeserializationCallback, IDisposable

[SerializableAttribute]
public ref class Cog3DRangeImageCrossSectionProfile : public CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

[SerializableAttribute]
public ref class Cog3DRangeImageCrossSectionProfile : public CogSerializableChangedEventBase, 
	IDeserializationCallback, IDisposable

The Cog3DRangeImageCrossSectionProfile type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	BuildProfileGraphics	Creates the profile graphics for the current and the last run records.
	BuildProfileSharpnessGraphics	Creates the profile sharpness graphics used as a visual aid with the extract corner operator.
	BuildProfileSharpnessGraphicsV2
	Copy	Shallow copy of the profile.
	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 Cog3DRangeImageCrossSectionProfile.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Finalize this Cog3DRangeImageCrossSectionProfile. (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.)
	GetBoundingBoxInProfileDefaultSpace	Gets the bounding rectangle of the profile in ProfileDefaultSpace Returns null if the ProfileRoot is null.
	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.)
	GetProfileData	Gets the profile height data in pixels. Returns null if the ProfileRoot is null.
	GetProfileDataInProfileSelectedSpaceName	Returns the profile data in the specified space. Each point in the profile is mapped from pels to the specified space, packaged as a Cog3DVect2 object, and added to the Cog3DVect2Collection. Returns null if the ProfileRoot is null, or if the profile has zero points.
	GetProfileDataInRangeImageSelectedSpaceName3D	Returns the profile data in the specified 3D space that can be found in the CoogrdinateSpaceTree3D of the range image. Each point in the profile is mapped back to the specified 3D space, packaged as a Cog3DVect3 object, and added to the Cog3DVect3Collection. Returns null if the ProfileRoot is null, or if the profile has zero points.
	GetProfileDefaultSpace	Returns the first space in the ProfileSpaceTree. The value is the ProfileDefaultSpaceName specified by the tool that creates the profile.
	GetProfileSSNParent	Returns the parent space name of the ProfileSelectedSpaceName. Returns null if the ProfileSpaceTree is null.
	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.)
	GetUniqueSpaceName	Returns a unique space name within the ProfileSpaceTree. The name will have Fixture as a base and the next available index such as Fixture1 or Fixture2.
	GetWeights	Gets the weights for each height value in the profile data. The weight will indicate the number of pixels contributing to the height value in the corresponding profile datum. The weight value is between 0 and 1. A value of 0 indicates that all pixels contributing to the height are missing. Returns null if the ProfileRoot is null.
	ImageUsedForProfileDisplay	Cognex Internal use only.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MapCircleToRangeImage	Maps a profile circle to a line segment in the range image SelectedSpaceName.
	MapCircleToRangeImage3D	Maps a profile circle to a circle in the range image SelectedSpaceName3D.
	MapLineSegmentToRangeImage	Maps a profile line segment to a line segment in the range image SelectedSpaceName.
	MapLineSegmentToRangeImage3D	Maps a profile line segment to a line segment in the range image SelectedSpaceName3D.
	MapPointToRangeImage	Maps a profile point to a point in the range image SelectedSpaceName.
	MapPointToRangeImage3D	Maps a profile point to a point in the range image SelectedSpaceName3D.
	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.)
	OnDeserialization
	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
	SfCoordinateSpaceTree	This bit will be set in the EventArgs of a Changed event every time the value returned by CoordinateSpaceTree may have changed.
	SfCoordinateSpaceTree3D	This bit will be set in the EventArgs of a Changed event every time the value returned by CoordinateSpaceTree3D may have changed.
	SfCuttingPlane	This bit will be set in the EventArgs of a Changed event every time the value returned by CuttingPlane may have changed.
	SfNextSf	NextSf state flag.
	SfPixelFromRootTransform	This bit will be set in the EventArgs of a Changed event every time the value returned by PixelFromRootTransform may have changed.
	SfPixelFromRootTransform3D	This bit will be set in the EventArgs of a Changed event every time the value returned by PixelFromRootTransform3D may have changed.
	SfProfileRoot	This bit will be set in the EventArgs of a Changed event every time the value returned by ProfileRoot may have changed.
	SfProfileSelectedSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by ProfileSelectedSpaceName may have changed.
	SfProfileSpaceTree	This bit will be set in the EventArgs of a Changed event every time the value returned by ProfileSpaceTree may have changed.
	SfProjectionHeight	This bit will be set in the EventArgs of a Changed event every time the value returned by ProjectionHeight may have changed.
	SfSelectedSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedSpaceName may have changed.
	SfSelectedSpaceName3D	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedSpaceName3D 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.)
	CoordinateSpaceTree	Gets or sets the CoordinateSpaceTree.
	CoordinateSpaceTree3D	Gets or sets the CoordinateSpaceTree3D.
	CuttingPlane	Returns the cutting plane. The cutting plane lies parallel to the image z-axis of the range image at the centerline of the region.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	PixelFromRootTransform	Gets the PixelFromRootTransform. The transform is computed from PixelFromRootTransform3D. Returns null if PixelFromRootTransform3D is null.
	PixelFromRootTransform3D	Gets or sets the PixelFromRootTransform3D.
	ProfileRoot	Gets the ProfileRoot. The ProfileRoot object contains the profile height data and the weights.
	ProfileSelectedSpaceName	Gets or sets the ProfileSelectedSpaceName
	ProfileSpaceTree	Gets or sets the ProfileSpaceTree.
	ProjectionHeight	Gets the ProjectionHeight.
	SelectedSpaceName	Gets or sets the SelectedSpaceName.
	SelectedSpaceName3D	Gets or sets the SelectedSpaceName3D.
	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 profile is the new image-like container of the 1-D height data. It holds the one-dimensional height data and the one-dimensional weight data produced by projection. The profile resembles a 1-D range image, but it is not a true image. It does not support the ICogImage interface. And the data it holds is a "sideways" view of the original image.

Similar to the image, the profile also has a profile selected space name. All positional measurements from the operators will be reported in the profile selected space name.

To map points from the profile data back to the range image and to perform the mapping in the 2D and 3D user defined spaces, the profile holds on to:

The 3D coordinate space tree of the range image
The 2D coordinate space tree of the range image
A 3D below ground transform linking the profile data to the range image pixels
A 2D below ground transform linking the profile data to the range image pixels

There is no default constructor for the profile. It must be created by running the tool.