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

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

Inheritance diagram for SoImageDataAdapter:

Public Types
enum	Interpretation { VALUE , LABEL , BINARY }
	Image Interpretation. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual Interpretation	getInterpretation () const
	Returns the current interpretation of the image.

virtual void	setInterpretation (const Interpretation &interpretation)
	Sets the interpretation of the image.

virtual SbImageDataType	getImageDataType ()
	Returns the data type of the image.

virtual SbVec4i32	getSize () const
	Returns a vector representing the dimensions of the image data.

virtual SbBox3f	getExtent () const
	Returns the extent of the image in 3D.

SbVec3f	getVoxelSize () const
	Returns the size of a voxel in 3D.

void	setVoxelSize (const SbVec3f &voxelSize)
	Sets the voxel size in 3D.

SbVec3f	getOrigin () const
	Returns the image origin in 3D.

void	setOrigin (const SbVec3f &origin)
	Sets the image origin in 3D.

void	setDirection (const SbVec3f &rowDirection, const SbVec3f &columnsDirection)
	Set the direction cosines of rows and columns.

SbVec3f	getRowDirection () const
	Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (1,0,0).

SbVec3f	getColumnDirection () const
	Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,1,0).

SbVec3f	getPlaneDirection () const
	Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,0,1).

SbMatrix	getIndexToPhysicalTransformation () const
	Returns the transformation that maps a position in the image coordinate system to a position in the physical coordinate system.

SbImageDataAccessor &	getDataAccessor ()
	Returns an SbImageDataAccessor.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	interpretation
	Image Interpretation Default is VALUE.

SoSFBox3f	extent
	The extent and orientation fields define the position, size and orientation of the image in 3D (typicallly the physical space).

SoSFRotation	orientation

Detailed Description

Abstract base class for all ImageViz image data adapter classes.

See for example:

SoFileDataAdapter to use data in a file.
SoMemoryDataAdapter to use data already in memory.
SoProxyDataAdapter to use a subset of data already in an SoImageDataAdapter.
SoVolumeReaderAdapter to use data from an SoVolumeReader.

NOTE: SoImageDataAdapter provides access to the image data but does not guarantee that all the data is loaded in memory. Only SoMemoryDataAdapter is guaranteed to do that. As a result, only an SoMemoryDataAdapter (or an SoProxyDataAdapter that is attached to an SoMemoryDataAdapter) is completely safe to use as input for ImageViz filter engines. Many engines will work with data partially in memory, but some, for example SoImageRegistrationTransform, will only work if the image is completely in memory. See the documentation for the specific engines you are using. Conveniently, the utility method SoImageDataAdapterHelper::getAppropriateAdapter() returns an SoMemoryDataAdapter object if there is enough memory to load all the data.

Member Enumeration Documentation

◆ Interpretation

enum SoImageDataAdapter::Interpretation

Image Interpretation.

This enumeration defines the way the data values in the image should be interpreted. Some engines require their input image to have a specific interpretation type and give an error if the interpretation type is incorrect. Engines automatically set the appropriate interpretation type in their output image(s). The application is responsible for setting the appropriate interpretation type in images created by the application, for example if a mask image is loaded from disk.

Enumerator

VALUE

Image is a grayscale or color image.

A �VALUE� type image with exactly 3 or 4 channels is assumed to be a color image (RGB or RGBA). In all other cases, each channel is independently treated as a grayscale image.

LABEL

Image is a collection of objects defined by id (label) values.

In other words, the value of each voxel is a label id. If the image has multiple channels, e.g. a color image, only the first channel is used. Using a raw (unsegmented) grayscale image as input may give unexpected results, e.g. a large number of very small objects.

BINARY

Image is a mask.

In other words, the value of each voxel is a boolean. If a grayscale image is used as input, 0 is false and all other values are true. If the image has multiple channels, e.g. a color image, only the first channel is used.

Definition at line 92 of file SoImageDataAdapter.h.

Member Function Documentation

◆ getClassTypeId()

static SoType SoImageDataAdapter::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getColumnDirection()

SbVec3f SoImageDataAdapter::getColumnDirection ( ) const

Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,1,0).

The vector is normalized.

◆ getDataAccessor()

SbImageDataAccessor & SoImageDataAdapter::getDataAccessor ( )

Returns an SbImageDataAccessor.

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

◆ getExtent()

virtual SbBox3f SoImageDataAdapter::getExtent ( ) const

virtual

Returns the extent of the image in 3D.

Convenience method to get the value of the extent field.

◆ getImageDataType()

virtual SbImageDataType SoImageDataAdapter::getImageDataType ( )

virtual

Returns the data type of the image.

◆ getIndexToPhysicalTransformation()

SbMatrix SoImageDataAdapter::getIndexToPhysicalTransformation ( ) const

Returns the transformation that maps a position in the image coordinate system to a position in the physical coordinate system.

◆ getInterpretation()

virtual Interpretation SoImageDataAdapter::getInterpretation ( ) const

virtual

Returns the current interpretation of the image.

Convenience method to get the value of the interpretation field. Use enum Interpretation.

◆ getOrigin()

SbVec3f SoImageDataAdapter::getOrigin ( ) const

Returns the image origin in 3D.

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

◆ getPlaneDirection()

SbVec3f SoImageDataAdapter::getPlaneDirection ( ) const

Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,0,1).

The vector is normalized.

◆ getRowDirection()

SbVec3f SoImageDataAdapter::getRowDirection ( ) const

Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (1,0,0).

The vector is normalized.

◆ getSize()

virtual SbVec4i32 SoImageDataAdapter::getSize ( ) const

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 1.

◆ getTypeId()

virtual SoType SoImageDataAdapter::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Reimplemented in SoFileDataAdapter, SoMemoryDataAdapter, SoProxyDataAdapter, and SoVolumeReaderAdapter.

◆ getVoxelSize()

SbVec3f SoImageDataAdapter::getVoxelSize ( ) const

Returns the size of a voxel in 3D.

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

◆ setDirection()

void SoImageDataAdapter::setDirection	(	const SbVec3f &	rowDirection,
		const SbVec3f &	columnsDirection
	)

Set the direction cosines of rows and columns.

The row direction is a vector that points from the origin to the point (1,0,0). The column direction is a vector that points from the origin to the point (0,1,0).

In the DICOM standard, this information corresponds to the tag "Image Orientation (Patient) (0020,0037)"

◆ setInterpretation()

virtual void SoImageDataAdapter::setInterpretation ( const Interpretation & interpretation )

virtual

Sets the interpretation of the image.

Convenience method to set the value of the interpretation field. Use enum Interpretation.

◆ setOrigin()

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.

◆ setVoxelSize()

void SoImageDataAdapter::setVoxelSize ( const SbVec3f & voxelSize )

Sets the voxel size in 3D.

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

Member Data Documentation

◆ extent

SoSFBox3f SoImageDataAdapter::extent

The extent and orientation fields define the position, size and orientation of the image in 3D (typicallly the physical space).

The extent field defines an axis aligned box in 3D. It has a 'min' corner, which is the image origin, and a 'max' corner. The orientation field defines a rotation around the image origin.

If the image is loaded from a file format that specifies a physical extent and/or orientation (for example DICOM), then these fields are initialized with the information specifies in the image file. If no extent is specified, then the extent field is set to (0, 0, 0, sizeX, sizeY, sizeZ). If no rotation is specified, then the orientation field is set to identity. The application can set either or both of these fields as needed.

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

Definition at line 146 of file SoImageDataAdapter.h.

◆ interpretation

SoSFEnum SoImageDataAdapter::interpretation

Image Interpretation Default is VALUE.

This field defines the way the data values in the image should be interpreted. Some engines require their input image to have a specific interpretation type and give an error if the interpretation type is incorrect. Engines automatically set the appropriate interpretation type in their output image(s). The application is responsible for setting the appropriate interpretation type in images created by the application, for example if a mask image is loaded from disk. Use enum Interpretation.

Definition at line 128 of file SoImageDataAdapter.h.

◆ orientation

SoSFRotation SoImageDataAdapter::orientation

See also: SoImageDataAdapter::extent

Definition at line 151 of file SoImageDataAdapter.h.

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

ImageViz/Nodes/Images/SoImageDataAdapter.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

SEE ALSO

Member Enumeration Documentation

◆ Interpretation

Member Function Documentation

◆ getClassTypeId()

◆ getColumnDirection()

◆ getDataAccessor()

◆ getExtent()

◆ getImageDataType()

◆ getIndexToPhysicalTransformation()

◆ getInterpretation()

◆ getOrigin()

◆ getPlaneDirection()

◆ getRowDirection()

◆ getSize()

◆ getTypeId()

◆ getVoxelSize()

◆ setDirection()

◆ setInterpretation()

◆ setOrigin()

◆ setVoxelSize()

Member Data Documentation

◆ extent

◆ interpretation

◆ orientation