SoDataRange Class Reference

Range of data values to be mapped to the color map. More...

#include <LDM/nodes/SoDataRange.h>

Inheritance diagram for SoDataRange:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoDataRange ()
	Constructor.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
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 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 SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
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
SoSFInt32	dataRangeId
	This field allows the use of multiple data ranges for the same shape.
SoSFDouble	min
	Minimum data value of the data range.
SoSFDouble	max
	Maximum data value of the data range.
SoSFBool	mapOnFullColorRange
	Specifies how to map data values that are outside of the data range.

Detailed Description

Range of data values to be mapped to the color map.

This node allows you to specify the range of scalar data values in a data set (SoDataSet or SoVolumeData) that will be mapped into the color map (SoTransferFunction). When the volume data type is larger than the data type on the GPU, for example float data scaled to byte data, it also specifies the range of scalar data values that will be scaled to fit in the GPU data type.

By default VolumeViz maps the entire range of the voxel's data type (e.g. 0..65535 for unsigned short) into the colormap. This is often correct for byte (8 bit) voxels, but seldom correct for 16 bit voxels and never correct for floating point voxels. Use an SoDataRange node to specify the actual (or desired) range of data values to be mapped. For example, a typical initial data range for DICOM data calibrated in Hounsfield units might be -1000 to 3000.

Data characteristics:

• The voxel value data type can be queried using the SoDataSet method getDataType().
• The number of bytes in a voxel value can be queried using the SoDataSet method getDataSize().
• The actual min and max values for the data set can be queried using the SoDataSet method getMinMax().
  
  Note that this method might force VolumeViz to load the entire data set if the volume reader for that format does not implement the getMinMax query. Normally for an LDM format data set, the min and max values are stored in the LDM header. For a non-LDM data set, if a filename and/or reader have been specified and the data set has not yet been loaded, VolumeViz will load the entire data set to compute the min and max values. For a large data set this may take a long time.
• DICOM: The Window Center (0028,1050) and Window Width (0028,1051) values (if present in the data set) can be queried by using an SoVRDicomData object obtained from the SoVRDicomFileReader or by using the MedicalHelper class. You can also use the MedicalHelper method dicomAdjustDataRange.

When using multiple volumes (see SoMultiDataSeparator), a single SoDataRange node can be used to specify the data range for all volumes or each volume can have its own independent data range. In the second case, create one SoDataRange node for each volume and set the dataRangeId equal to the SoDataSet::dataSetId of the corresponding volume.

Note that the meaning of the min and max fields in SoDataRange is quite different than the meaning of the minValue and maxValue fields in SoTransferFunction. The fields in SoDataRange specify the range of voxel values that will be mapped into the full color map. The fields in SoTransferFunction specify the range of indices in the color map that will actually be used to store the color map. The visual effect changing these fields can be quite similar, but there are trade-offs to be aware of. Changing the SoTransferFunction fields is generally much faster and can be a useful approximation of changing the data range, but the resolution of the color map (the ratio of data values to color map entries) is reduced.

NOTE: Setting the min value greater than or equal to the max value will cause this node to be ignored.

Brightness and contrast:

Often the distribution of voxel values within the actual data range is not uniform and more details can be seen by adjusting the SoDataRange values to increase brightness and/or contrast. This is particularly true when using a gray scale color map (for example the predefined INTENSITY map in SoTransferFunction ). In medical imaging this range setting is often specified by the window center and window width.

The window center is the image intensity that will be displayed as a medium-gray and the window width is the range of data values between full black and full white. For example, if the data volume contains byte data with a native range of 0 to 255, the default data range (0 to 255) is effectively specifying a window center of 128 and width of 256. To increase contrast in the resulting image we might set a data range of 20 to 110, which makes the window center and width 65 and 90 respectively.

Performance:

For larger data types, changing the data range may require VolumeViz to recreate the data textures on the GPU. This is necessary to maximize use of the available bits of precision on the GPU. Since Open Inventor 9.6, recreating data textures should not be required for 8 bit data or for 16 bit data when the SoDataSet::texturePrecision field is set to 16.

Recreating data textures may be slow for larger volumes, even in the 512^3 range. There are several parameters that significantly affect this:

• Tile size:
  For backward compatibility, the default tile size is still only 64. This is quite small for modern CPU/GPU hardware. The smaller the tile size, the larger the total number of tiles that must be managed by VolumeViz. This overhead can be significant, especially for operations that require reloading the data textures on the GPU, for example, changing the data range (SoDataRange). For smaller volumes, like 512^3, it can be efficient to set the tile size large enough to contain the entire volume. For very large volumes, larger tile sizes are efficient for SoVolumeRender but somewhat inefficient for slice rendering because complete tiles must be loaded even though the slice only uses part of the data. Applications should experiment.
  
  For volumes stored in LDM file format, the tile size must be specified when the volume is converted to LDM (see SoConverter and the "-t" option). For other data data formats the tile size should be specified after the SoVolumeData node is created, using the ldmResourceParameters field, but before setting the filename field.
• LDM_USE_IN_MEM_COMPRESSION
  This environment variable (see SoPreferences) affects much more than its name implies. VolumeViz always manages data as "tiles", regardless of the data format. In many cases VolumeViz must create (or uncompress) the tiles at run time. These cases include in-memory volumes, any volume reader that does not implement the readTile() method (all built-in formats except LDM) and compressed LDM format files. If this variable is true ( the default value), then VolumeViz only keeps a small cache of tiles in memory. See the SoBufferObject method getBufferObjectCache() for the current default and note that this setting is separate from the max main memory parameter. If a tile's data is needed and that tile is not in the cache, the tile must be recreated. This overhead can be significant, especially for operations that require recreating data textures on the GPU, for example, changing the data range (SoDataRange). We recommend setting this variable to false unless the memory conserving feature for compressed tiles is critical.
• SoDataSet::texturePrecision
  When the data set's texturePrecision is at least equal to the numSignificantBits, then the data range scaling can be applied on the fly during rendering (i.e. on the GPU). This implies that data textures don't need to be regenerated when the data range changes and interactivity is much better.
• SoVolumeRender::subDivideTiles
  This parameter doesn't actually resend data to the GPU but it does require updating the sub-tile min/max values, which can be quite costly. Setting subDivideTiles to FALSE may increase DataRange performance (the default is FALSE).

If the data set contains explicit RGBA values (SoVolumeData dataRGBA field is true), then SoDataRange and SoTransferFunction have no effect on rendering.

FILE FORMAT/DEFAULT

DataRange{

dataRangeId	1
min	0
max	0
mapOnFullColorRange	TRUE

}

ACTION BEHAVIOR

SoCallbackAction, SoGLRenderAction, SoPickAction, SoWriteAction, SoGetBoundingBoxAction
Sets a data range in the current traversal state.

SEE ALSO

SoDataSet, SoTransferFunction

Definition at line 190 of file SoDataRange.h.

Constructor & Destructor Documentation

SoDataRange()

SoDataRange::SoDataRange

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoDataRange::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoDataRange::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

dataRangeId

SoSFInt32 SoDataRange::dataRangeId

This field allows the use of multiple data ranges for the same shape.

By default all data range nodes are initialized to a data range id of 1. If you want to use multiple data ranges, different data range ids must be assigned. The data range id is only used in a render compositing scheme (see SoDataSet).

NOTE: field available since Open Inventor 6.1.2

Definition at line 208 of file SoDataRange.h.

mapOnFullColorRange

SoSFBool SoDataRange::mapOnFullColorRange

Specifies how to map data values that are outside of the data range.

If mapOnFullColorRange is TRUE (default), then any data values less than or equal to the min data value are mapped to the first color entry and any data values greater than or equal to the max data value are mapped to the last color entry.

If mapOnFullColorRange is FALSE, then any data value less than min data value is mapped to the first color entry and the min data value is mapped to the second color entry; any data value greater than the max data value is mapped to the last color entry and the max data value is mapped to the next to the last color entry.

Definition at line 233 of file SoDataRange.h.

max

SoSFDouble SoDataRange::max

Maximum data value of the data range.

Definition at line 219 of file SoDataRange.h.

min

SoSFDouble SoDataRange::min

Minimum data value of the data range.

Note: If min is greater than or equal to max, this node is ignored.

Definition at line 214 of file SoDataRange.h.

---

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

• LDM/nodes/SoDataRange.h