Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoProxyDataAdapter Class Reference

ImageViz Proxy image data adapter for in memory data. More...

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

+ Inheritance diagram for SoProxyDataAdapter:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoProxyDataAdapter ()
 Default constructor.
 
- Public Member Functions inherited from SoImageDataAdapter
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.
 
SbImageDataAccessorgetDataAccessor ()
 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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 SoImageDataAdapter
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

SoSFImageDataAdapter image
 Defines the original image.
 
SoSFBox4i32 roi
 Defines a region of interest (ROI) in voxels on the original image.
 
SoMFInt32 channels
 Defines the list of channels selected on the image.
 
- Public Attributes inherited from SoImageDataAdapter
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
 

Friends

class SoProxyDataAdapterImpl
 

Additional Inherited Members

- Public Types inherited from SoImageDataAdapter
enum  Interpretation {
  VALUE ,
  LABEL ,
  BINARY
}
 Image Interpretation. More...
 

Detailed Description

ImageViz Proxy image data adapter for in memory data.

Defines a subset of the original image as an image. See SoImageDataAdapter for methods to access the data.

FILE FORMAT/DEFAULT

    ProxyDataAdapter {
    extent 0,0,0, 1,1,1
    orientation 0 0 0 1
    image NULL
    roi 0 0 0 0 0 0 0 0
    channels 1 0
    }

SEE ALSO

SoImageDataAdapter, SoFileDataAdapter, SoVolumeReaderAdapter

Definition at line 58 of file SoProxyDataAdapter.h.

Constructor & Destructor Documentation

◆ SoProxyDataAdapter()

SoProxyDataAdapter::SoProxyDataAdapter ( )

Default constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoProxyDataAdapter::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoProxyDataAdapter::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoImageDataAdapter.

Friends And Related Symbol Documentation

◆ SoProxyDataAdapterImpl

friend class SoProxyDataAdapterImpl
friend

Definition at line 100 of file SoProxyDataAdapter.h.

Member Data Documentation

◆ channels

SoMFInt32 SoProxyDataAdapter::channels

Defines the list of channels selected on the image.

Default value is the first channel (0) which usually corresponds to:

  • Intensity for a gray level image, or
  • Red channel for RGB or RGBA image.

Definition at line 91 of file SoProxyDataAdapter.h.

◆ image

SoSFImageDataAdapter SoProxyDataAdapter::image

Defines the original image.

Default value is NULL.

Definition at line 73 of file SoProxyDataAdapter.h.

◆ roi

SoSFBox4i32 SoProxyDataAdapter::roi

Defines a region of interest (ROI) in voxels on the original image.

Default value is an empty box. The box is defined by a 'min' corner and a 'max' corner. If the specified box is larger than the image, the box is clamped to the dimensions of the image.

Example for an 512x512 image and a {min=(256,256), max=(400,600)}-box, the resulting box will be {min=(256,256), max=(400,512)}-box.

Definition at line 83 of file SoProxyDataAdapter.h.


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