SoVolumeSkin Class Reference
[Nodes]

Draws a data volume skin. More...

#include <VolumeViz/nodes/SoVolumeSkin.h>

Inheritance diagram for SoVolumeSkin:

Public Types
enum	FaceMode { FRONT, BACK, FRONT_AND_BACK }
Public Member Functions
virtual SoType	getTypeId () const
	SoVolumeSkin ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFInt32	dataSetId
SoSFEnum	faceMode

Detailed Description

Draws a data volume skin.

This node draws the "skin" (outer faces) of the data volume defined by the current SoVolumeData node. This skin is a set of textured polygons similar to ortho slices.

The current SoVolumeData node can be specified with dataSetId. When this field is set to 0, the last SoVolumeData node on state is used.

For a non-RGBA (scalar valued) volume, each voxel's RGBA value is determined by the current SoDataRange and SoTransferFunction. The current diffuse color and transparency (set, for example, with an SoMaterial node) modify the appearance of the voxels. This means that, for example, the current transparency can be used as a global alpha value to modulate the overall opacity. For an RGBA volume each voxel's RGBA value comes directly from the volume data.

When using an opaque transfer function (no alpha values < 1), this node generates the same image as SoVolumeRender, but with much higher performance, because only slices are rendered. A common pattern is to put an SoVolumeRender node and an SoVolumeSkin node under an SoSwitch node. This makes it easy to switch between skin rendering and volume rendering.

The interpolation field controls how the texture is interpolated.

Optionally a bump mapping effect may be applied. Normal vectors are automatically computed from the data value gradient. The enableBumpMapping and bumpScale fields control whether bump mapping is active and the intensity of the effect.

The entire skin is pickable, even where it is transparent as a result of the current transfer function. The SoVolumeSkinDetail class allows you to get the voxel position and value after picking.

Notes:

Drawing position:
An SoVolumeSkin is approximately the same as six ortho slices, but not exactly. The difference is that each face of the skin is drawn at the outer edge of the voxel slice it intersects. So if there is no SoROI, or the ROI is identical to the volume dimensions, the volume skin faces will be drawn at the limits of the volume extent (bounding box). For SoOrthoSlice, the geometry passes through the center of the voxels in the specified slice. So an ortho slice with sliceNumber = 0 will be drawn one-half voxel size (on the slice axis) in from the bounding box of the volume.

Transformation matrices:
The volume size and orientation (like geometry) can be modified by transformation nodes in the scene graph and this in turn modifies the appearance of volume rendering nodes like SoVolumeSkin. However the same transformation must be applied to the volume data node and all volume rendering nodes associated with that volume. So effectively any transformation nodes that affect the volume must be placed before the volume data node.

Picking:
The entire skin is pickable, even where it is transparent as a result of the current transfer function. The SoVolumeSkinDetail class allows you to get the voxel position and value after picking.

Clipping:
Volume primitives can be clipped using a region of interest (SoROI), geometry (SoVolumeClippingGroup) and/or height fields (SoUniformGridClipping). They are also clipped by OpenGL clipping planes (SoClipPlane), but we recommend using the VolumeViz clipping nodes instead.

Note that, in general, clipping does not work well with SoVolumeSkin because the clipped portions of the skin are not "closed", allowing the user to see inside the skin. However the SoROI node's EXCLUSION_BOX mode does work well and can be used to exclude a sub-region from the skin, forming what is sometimes called a "chair cut".

Dragging:
It is possible to interactively translate and resize a skin that is limited to a subset of the volume (sometimes called a "volume probe"). This is done using an Open Inventor dragger, e.g. SoTabBoxDragger, to adjust an SoROI node. This is such a common operation that Open Inventor provides the SoROIManip node.

Interpolation:
Interpolation is specified using the interpolation field. The default (LINEAR) does bi-linear interpolation between voxel values. The NEAREST value can be used to display individual voxels. For best image quality we recommend using the TRILINEAR or MULTISAMPLE_12 value.

Material:
The color of each voxel is modulated by the current diffuse color in the traversal state. The default diffuse color is 0.8,0.8,0.8. This results in full intensity values in the color map being displayed as 80% intensity. Therefore we recommend adding an SoMaterial node before the skin and setting its diffuseColor field to full white (1,1,1).

Transparency:
Typically the color map (SoTransferFunction) used for volume rendering (SoVolumeRender) assigns transparency (alpha < 1) to some voxel values. If you want to use the same color map for skin rendering, but render the slice completely opaque, set the alphaUse field to ALPHA_OPAQUE. This overrides the alpha values in the color map (or an RGBA volume). However it does not affect transparency assigned using an SoMaterial node.

Voxel edges:
The edges of the voxels can also be rendered. See options in the SoVolumeRenderingQuality node.

Custom shaders:
The current SoVolumeShader node, if any, allows custom shaders to be defined for special computation or rendering effects, including blending multiple volumes.

Composition with Multiple Data:
It is possible to compose datasets that have different dimensions, tile sizes and transformations.
In order to help fetch the correct data values in custom shaders, texture coordinates conversion functions are provided in the VolumeViz/vvizStructure.h shader include.
For instance,
```
     vec3 VVizTextureToTextureVec(in VVizDataSetId datasetSrc, in VVizDataSetId datasetDst, in vec3 texCoord);
```
can be used to convert texture coordinates related to one dataset to texture coordinates related to another dataset.
The conversion is based solely on the transformations applied to each dataset, which are defined by their model matrix and their extent.
Please note that the model matrix of a dataset is defined by to the SoTransformation nodes that are placed before the SoDataSet node in the order of the traversal.

Large Slice mode:
When the "large slice" mode is enabled (see SoSlice::largeSliceSupport), if all the required full resolution tiles have already been loaded, then the slice data is taken from LDM system memory cache as usual. But if some required tiles are not currently in memory, the required slice data will be loaded directly from the volume reader without loading the complete tiles. This reduces disk I/O and reduces the amount of system memory required to display the slice at full resolution, so larger (or more) slices can be displayed. The required tiles are then scheduled to be loaded asynchronously in case adjacent slices are displayed later. For example, loading a 1024x1024 SoOrthoSlice from an 8-bit dataset with 128x128x128 tiles would normally require loading 1024x1024x128 bytes of data (as complete tiles). With largeSliceSupport enabled, only 1024x1024 bytes (maximum) of data need to be loaded (in the worst case where no high resolution data is currently in memory).

Performance:
- 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 can be specified using the SoVolumeData node's ldmResourceParameters field, but only after setting the filename field or calling the setReader() method.
- LDM_USE_IN_MEM_COMPRESSION
  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 (this includes all built-in formats except LDM, e.g. DICOM, SEGY, ...) and compressed LDM format files. If this variable is true (the default), VolumeViz only keeps a small cache of created/uncompressed tiles in CPU memory. 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 all the data textures on the GPU, for example changing the data range (SoDataRange). We recommend setting this variable to false (see SoPreferences) unless saving CPU memory is critical.
- Compressed textures:
  For performance reasons, SoVolumeSkin accumulates small textures into a bigger one. When using compressed RGBA textures (via SoDataSet's field useCompressedTexture), this optimization cannot be done. If you want to favor performance rather than memory usage, you should disable compression (enabled by default if supported by the graphic card)

EXAMPLE

SoVolumeData

Note that some of the property nodes (data, material, color map, etc) will typically be shared by multiple rendering nodes. In other words the volume usually only needs to be loaded once, using a single SoVolumeData node, then multiple slices and/or regions can be rendered using that data node.

Also note that this example is for a data volume, where each voxel can be considered a discrete sample from a continuous data field and interpolation should be used to compute values between voxel centers. If you are rendering a label volume, then each voxel is an "id" assigning that voxel to a specific material, object, etc. In this case, set the interpolation field to NEAREST to disable interpolation.

   // Default setting can be a performance bottleneck
   SoPreferences::setValue( "LDM_USE_IN_MEM_COMPRESSION", "0" );

   // Keep volume viz separate from geometry
   SoSeparator* volSep = new SoSeparator();
     root->addChild( volSep );

   // Load volume data
   SoVolumeData* volData = new SoVolumeData();
     volData->fileName = "$OIVHOME/examples/data/VolumeViz/Colt.vol";
     volSep->addChild( volData );

   // Set range of data values to visualize.
   // Not required for 8-bit voxels, critical for larger data types.
   // The getMinMax() call may be expensive for non-LDM file formats.
   SoDataRange* volRange = new SoDataRange();
     if (volData->getDatumSize() > 1) {
       double minVal, maxVal;
       volData->getMinMax( minVal, maxVal );
       volRange->min = minVal;
       volRange->max = maxVal;
     }
     volSep->addChild( volRange );

   // Load opaque color map
   SoTransferFunction* volTF = new SoTransferFunction();
     volTF->predefColorMap = SoTransferFunction::BLUE_WHITE_RED;
     volSep->addChild( volTF );

   // Display volume at full intensity
   SoMaterial* volMat = new SoMaterial();
     volMat->diffuseColor.setValue( 1, 1, 1 );
     volSep->addChild( volMat );

   // Remove tile boundary artifacts while moving. 
   SoVolumeShader* volShader = new SoVolumeShader();
     volShader->interpolateOnMove = TRUE;
     volSep->addChild( volShader );

   // Display volume skin
   SoVolumeSkin* volSkin = new SoVolumeSkin();
     volSep->addChild( volSkin );

FILE FORMAT/DEFAULT

dataSetId	0
interpolation	LINEAR
alphaUse	ALPHA_AS_IS
useRGBA	FALSE
enableBumpMapping	FALSE
bumpScale	1.0
faceMode	FRONT

ACTION BEHAVIOR

SoGLRenderAction

SoVolumeData

SoGetBoundingBoxAction
Computes the bounding box that encloses the volume.

Member Enumeration Documentation

enum SoVolumeSkin::FaceMode

Use this enum with the faceMode field.

Enumerator:

FRONT	Display only front faces.
BACK	Display only back faces.
FRONT_AND_BACK	Display front and back faces.

Constructor & Destructor Documentation

SoVolumeSkin::SoVolumeSkin ( )

Constructor.

Member Function Documentation

static SoType SoVolumeSkin::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from SoSlice.

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

Returns the type identifier for this specific instance.

Reimplemented from SoSlice.

Member Data Documentation

SoSFInt32 SoVolumeSkin::dataSetId

Specifies the SoVolumeData node to use.

This is useful when datasets of different dimensions are present in the scene graph. Please see SoMultiDataSeparator for more details.

When set to 0, the last SoVolumeData node on state is used. Default is 0.

NOTE: field available since Open Inventor 10.11.0

SoSFEnum SoVolumeSkin::faceMode

Display front (facing the camera) faces or back faces.

Use enum FaceMode. Default is FRONT. Displaying only front (or back) faces reduces the amount of data that must be loaded and reduces the rendering time.

NOTE: field available since Open Inventor 8.1

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

VolumeViz/nodes/SoVolumeSkin.h

SoVolumeSkin Class Reference [Nodes]

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes