SoImageDataAdapter Class Reference
[Images]

ImageViz Abstract base class for all ImageViz image data adapter classes. More...

#include <ImageViz/Nodes/Images/SoImageDataAdapter.h>

Inheritance diagram for SoImageDataAdapter:
SoFieldContainer SoBase SoRefCounter SoTypedObject SoFileDataAdapter SoMemoryDataAdapter SoVolumeReaderAdapter

List of all members.

Public Member Functions

virtual SoType getTypeId () const
virtual SbImageDataType getImageDataType ()
virtual SbVec4i32 getSize ()
virtual SbBox3f getExtent ()
SbVec3f getVoxelSize () const
void setVoxelSize (const SbVec3f &voxelSize)
SbVec3f getOrigin () const
void setOrigin (const SbVec3f &origin)
SbImageDataAccessorgetDataAccessor ()

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFBox3f extent

Detailed Description

ImageViz Abstract base class for all ImageViz image data adapter classes.

See for example:

SEE ALSO

ImageViz Overview
SoFieldContainer

See related examples:

InteractiveThresholding, MarkerPicking, OverlayDisplay, DenoisingImage2D, DenoisingImage3D, ExtractingROI


Member Function Documentation

static SoType SoImageDataAdapter::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoFieldContainer.

Reimplemented in SoFileDataAdapter, SoMemoryDataAdapter, and SoVolumeReaderAdapter.

SbImageDataAccessor& SoImageDataAdapter::getDataAccessor (  ) 

Returns an SbImageDataAccessor.

The SbImageDataAccessor can be used to access data contained inside this SoImageDataAdapter.

virtual SbBox3f SoImageDataAdapter::getExtent (  )  [virtual]

Returns the extent of the image in 3D.

Convenience method to get the value of the extent field.

virtual SbImageDataType SoImageDataAdapter::getImageDataType (  )  [virtual]

Returns the data type of the image.

SbVec3f SoImageDataAdapter::getOrigin (  )  const

Returns the image origin in 3D.

The image origin is the "min" corner of the image extent.

virtual SbVec4i32 SoImageDataAdapter::getSize (  )  [virtual]

Returns a vector representing the dimensions of the image data.

Indices 0, 1 and 2 refer to width, height and depth of image. Index 3 refers to timestep. For a 2D image index 2 is zero.

virtual SoType SoImageDataAdapter::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Reimplemented in SoFileDataAdapter, SoMemoryDataAdapter, and SoVolumeReaderAdapter.

SbVec3f SoImageDataAdapter::getVoxelSize (  )  const

Returns the size of a voxel in 3D.

The voxel size is extent divided by image dimensions (see getSize()).

void SoImageDataAdapter::setOrigin ( const SbVec3f origin  ) 

Sets the image origin in 3D.

Modifies the "min" corner of the image extent. The width and height of the extent are unchanged and therefore the voxel size is unchanged.

void SoImageDataAdapter::setVoxelSize ( const SbVec3f voxelSize  ) 

Sets the voxel size in 3D.

The extent field is updated to be voxel size times image dimensions (see getSize()).


Member Data Documentation

The real size (extent) of the image in 3D.

If the image comes from a file format that contains valid information, the field is initialized with that information. Else it is initialized to (0, 0, 0, sizeX, sizeY, sizeZ). This corresponds to image origin at (0, 0, 0) and voxel size = (1, 1, 1).

The voxel size is extent divided by image dimensions (see getSize()). Even if information is available in file, this field can be manually modified after image creation.


The documentation for this class was generated from the following file:

Open Inventor by FEI reference manual, generated on 21 Sep 2015
Copyright © FEI S.A.S. All rights reserved.
http://www.vsg3d.com