Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
SoLDMDataTransform Class Referenceabstract

Large Data Management LDM data transform object. More...

#include <LDM/nodes/SoLDMDataTransform.h>

+ Inheritance diagram for SoLDMDataTransform:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
virtual void transformFunction (SoDataSet *ds, const SbVec3i32 &bufferDimension, SoBufferObject *bufferToTransform, const SbBox3i32 &dataBox, int resolutionLevel)=0
 Data transform function.
 
virtual bool affect (const SbBox3i32 &region) const
 Returns true if the transformation affects the specified region.
 
virtual void getAffectedRegion (std::vector< SbBox3i32 > &regions) const
 Returns a list of IJK bounding boxes affected by this transformation.
 
- 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 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.
 

Detailed Description

Large Data Management LDM data transform object.

This object defines a transform function to be applied to each LDM tile after it is loaded (returned from the volume reader) but before it is stored in system memory (LDM data cache). This allows you to modify the original data (for example, scaling or filtering) before it is displayed. It can also be used to create multiple data sets in memory from a single data set on disk.

Derive a new class from this one and implement the transformFunction method. Create an instance of the new class and set in the dataTransform field of the SoDataSet node.

Notes:

  • Applies to all volume data.
    A data transform can be applied to any type of volume data, not just data loaded from a .ldm format file. Internally all volume data sets are managed by LDM as tiles.
  • SoVolumeTransform
    The SoVolumeTransform node also allows a transform function to be applied to each LDM tile, but the transform is applied immediately before the tile is loaded onto the graphics board. SoVolumeTransform does allow the Data Access API to be used in the transform function.
  • SoDataCompositor
    The SoDataCompositor node allows a transform function to be applied in the special case where multiple volumes should be combined into a single volume.

SEE ALSO

SoDataSet, SoVolumeData, SoVolumeTransform

Definition at line 78 of file SoLDMDataTransform.h.

Member Function Documentation

◆ affect()

virtual bool SoLDMDataTransform::affect ( const SbBox3i32 region) const
virtual

Returns true if the transformation affects the specified region.

Region is expressed in ijk space. Typically, the region represents a tile and this method is used to know if a tile is affected by this transformation.

◆ getAffectedRegion()

virtual void SoLDMDataTransform::getAffectedRegion ( std::vector< SbBox3i32 > &  regions) const
virtual

Returns a list of IJK bounding boxes affected by this transformation.

For example, if this transform only affects the diagonal of the dataset, it would be over-estimated to return the bounding box of the whole dataset. In this case, this method should return a list of smaller bounding boxes located along the dataset diagonal.

◆ getClassTypeId()

static SoType SoLDMDataTransform::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoLDMDataTransform::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ transformFunction()

virtual void SoLDMDataTransform::transformFunction ( SoDataSet ds,
const SbVec3i32 bufferDimension,
SoBufferObject bufferToTransform,
const SbBox3i32 dataBox,
int  resolutionLevel 
)
pure virtual

Data transform function.


This function allows a tile of data to be transformed after it is loaded, but before it is stored in main memory. It is not currently possible to access other tiles of data (for example using the data access API) from this function. Note that the function will be called from LDM data loader threads, so multiple threads may be executing in this function at the same time (on different tiles). Inputs are:

  • The associated data set object the function is calling for. This allows retrieving information such as data type (ds->getDataType()).
  • The dimensions of the tile to transform. This defines the size of the buffer and is the same for every tile in a dataset. However tiles on the "outside" of the dataset may be partial tiles and contain less than the full number of actual data values.
  • A buffer containing the tile data to transform. The data should be modified "in place" in this buffer.
  • The position and extent of the tile in data space (voxel coordinates). For lower resolution tiles (level > 0) the extent of the tile will be larger than the dimensions of the tile (number of values in the tile).
  • The tile resolution level. Level 0 is full resolution data.

NOTES

    : This method must be thread safe, and must not make any OpenInventor database modification or notification.


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