Object that describes a range image. A range image describes three
dimensional surfaces. A CogImage16Range contains three dimensional
height data, a "visible pixel mask" to identify which pixels are
valid, three dimensional transform information, and two dimensional
transform information.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro CogImage16Range
Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.CorePlus (in Cognex.VisionPro.CorePlus.dll) Version: 69.0.0.0
Syntax
The CogImage16Range type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogImage16Range |
Construct a new instance of this class.
|
| CogImage16Range(Bitmap) |
Construct a new instance of this class using the supplied
bitmap to specify pixel data. Note that this produces
an image with an assumed identity mapping from "Sensor3D"
space to root space.
|
| CogImage16Range(CogImage16Range) |
Construct a new instance of this class as a shallow copy of the
given instance.
|
| CogImage16Range(ICog3DTransform) |
Construct a new instance of this class using the supplied
RootFromSensor3D transform.
|
 | CogImage16Range(SerializationInfo, StreamingContext) |
Serialization constructor for CogImage16Range object.
|
| CogImage16Range(Int32, Int32, ICog3DTransform) |
Construct a new instance of this class using the supplied
RootFromSensor3D transform and allocating storage for
the specified image size.
|
| CogImage16Range(CogImage16Grey, CogImage8Grey, ICog3DTransform) |
Construct a new instance of this class using the supplied
pixel data, mask data, and RootFromSensor3D transform.
|
| CogImage16Range(CogImage16Grey, Int32, ICog3DTransform) |
Construct a new instance of this class using the supplied
pixel data, missing pixel value, and RootFromSensor3D transform.
Mask data is automatically computed by identifying any pixel
in the PixelData argument whose value matches the
MissingPixelValue as not visible while all other pixels are
set to visible. If no missing pixels are found then the
mask root is set to null.
|
Methods
| Name | Description | |
|---|---|---|
| Allocate |
Initialize the image with (undefined) pixel and mask
data of the given width and height. This method may not be
called more than once.
|
| Clone |
Return a deep copy of this CogImage16Range.
|
| Copy |
Create a copy of this image. Pixel and mask data
are copied.
|
| Copy(CogImageCopyModeConstants) |
Create a copy of this image. Pixel and mask data
may be shared between images by specifying CopyMode to be
CogImageCopyModeConstants.SharePixels.
|
| CopyBase |
Create a copy of this image. Pixel and mask data
may be shared between images by specifying CopyMode to be
CogImageCopyModeConstants.SharePixels.
|
| 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 CogImage16Range.
|
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Finalize |
Finalize this CogImage16Range.
(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.) |
| GetInternalData |
For Cognex internal use only.
|
| GetIsImageZAlignedSpace |
Determine if the specified 3D space's Z axis is aligned with (parallel
to) the image Z axis within 0.0000001 degrees. Return true
if it is, return false otherwise.
|
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetMaskData |
Returns a CogImage8Grey that represents the mask
data of this image. This data is commonly referred
to as the "visible pixel mask" and is provided
as an indication of which pixel values were
visible to the camera during acquisition. Any
range image pixel that was not visible has an undefined
pixel value. The visible pixel mask represents
a visible pixel at a given row and column
with an 8 bit grey value of 255,
and a non-visible pixel with an 8 bit grey value
of zero. The CogImage8Root and the two
dimensional coordinate space tree of this
CogImage8Grey visible pixel mask representation
are shared with this range image. Note that
the value returned by this method may be null,
in which case all pixel values are considered
visible.
|
| GetObjectData |
Populates the provided SerializationInfo with the data
needed to serialize the object.
(Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).) |
| GetPixel |
Gets the mask (visible) and pixel value at the specified
pixel space coordinates.
|
| GetPixelData |
Returns a CogImage16Grey that represents the range or
height data of this image. The root and two dimensional coordinate
space tree are shared with this range image.
|
| 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.) |
| GetRoot |
Returns the range image root object that contains
the underlying pixel and mask roots.
|
| GetTransform |
Returns a transform that maps two dimensional points
from the 'From' space to the 'To' space.
The special string "." is accepted as an alias
for the SelectedSpaceName of this image.
|
| GetTransform3D |
Returns a transform that maps three dimensional points
from the 'From' space to the 'To' space.
The special string "." is accepted as an alias
for the SelectedSpaceName3D of this image.
|
| 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.) |
| MapPoint2DFrom3D |
Maps the supplied three dimensional point into the
specified two dimensional space. This is accomplished
by first mapping the input three dimensional point to
root space. The X and Y coodinates of this root space
point are then mapped to the specified two dimensional
space to produce the output two dimensional point.
|
| MapPoint3DFrom2D |
Maps the supplied two dimensional point into the
specified three dimensional space. This is
accomplished by first mapping the input two
dimensional point to pixel space. If the
range image's visible pixel mask indicates
that this pixel was not visible, then the
Visible output argument is set to false and
no further processing is performed. Otherwise,
the pixel value is read. This range
image pixel value is incremented by 0.5
to place it at a "middle" height within
the subject voxel. The resulting pixel space
coordinate triple is mapped into the
requested three dimensional space.
|
| MapPoints2DFrom3D |
Maps the supplied collection of three dimensional
points into the specified two dimensional space.
This is accomplished by first mapping an input three
dimensional point to root space. The X and Y coodinates
of this root space point are then mapped to the specified
two dimensional space to produce that output two
dimensional point.
|
| MapPoints3DFrom2D |
Maps the supplied collection of two dimensional
points into the specified three dimensional
space. This is accomplished by first mapping
an input two dimensional point into pixel
space. If the range image's visible pixel
mask indicates that this pixel was not visible,
then the corresponding element in the output
Visible array is set to false and the corresponding
element in the output DstPoints3D collection
is set to a default (0,0,0) value. Otherwise,
the pixel value is read. This range image
pixel value is incremented by 0.5 to place it
at a "middle" height within the subject voxel.
The resulting pixel space coordinate triple is
mapped into the requested three dimensional
space.
|
| 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.) |
| ScaleImage |
Creates a scaled version of this image. The dimensions
of the returned image (in pixels) are specified by the DesiredWidth
and DesiredHeight arguments. The scaling is performed using bilinear
interpolation.
|
| SetInternalData |
For Cognex internal use only.
|
| SetPixel |
Set the pixel and mask values at a given pixel space
location. Note that setting VisibleValue to false
on a CogImage16Range whose root currently has a null
mask root will cause an appropriately sized and populated
mask root to be created. The opposite is not true:
setting the sole non-visible mask value to visible
will not cause the mask root to be set to null.
|
| SetRoot |
Sets the range image root.
|
| 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.) |
| ToBitmap |
Creates a 24-bit RGB Windows bitmap from this image.
|
| ToString | (Inherited from Object.) |
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.
|
 | SfNextSf | |
| 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.
|
| 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.
|
Properties
| Name | Description | |
|---|---|---|
 | Allocated |
Whether there is pixel data associated with this 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.
(Inherited from CogSerializableChangedEventBase.) |
| CoordinateSpaceTree |
Get or set the tree of all named two dimensional
coordinate spaces for this image. The tree provides advanced
functions for managing two dimensional coordinate spaces.
|
| CoordinateSpaceTree3D |
Get or set the tree of all named three dimensional
coordinate spaces for this image. The tree provides advanced
functions for managing three dimensional coordinate spaces.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| Height |
The number of rows of pixels in this image.
|
| PixelFromRootTransform |
Gets a copy of the transform that maps from
pixel space ("#") to two dimensional root space
("@"). Due to the unique nature of the CogImage16Range,
setting PixelFromRootTransform is not allowed. Attempts to set
PixelFromRootTransform will cause an InvalidOperationException
to be thrown.
|
| PixelFromRootTransform3D |
Get or set the transform that maps from
three dimensional root space to pixel space.
|
| SelectedSpaceName |
Get or set the name of the two dimensional coordinate
space to be used by tools that process this image.
|
| SelectedSpaceName3D |
Gets or sets the name of the three dimensional
coordinate space to be used by tools which process this 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.) |
| Width |
The number of columns of pixels in this image.
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also