SoGVRSecondaryVolume

InventorModule

genre	VolRendExtensions
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoGVR
definition	soGVR.def
inherits from	SoGVRSecondaryVolumeSettings

Purpose

The SoGVRSecondaryVolume module allows for setting an additional octree volume to the SoGVRVolumeRenderer. In the current implementation, up to four secondary volumes can be added to the SoGVRVolumeRenderer module in addition to the volume that is directly connected to the renderer. The secondary volume must have the same voxel size and orientation, but may be a subregion of the volume connected to the renderer. The secondary volume must receive a unique Volume Name if you want to use more than one secondary volume in the scene. If an associated secondary LUT is given (see SoGVRSecondaryLUT), the volume data will be mapped using the LUT. The resulting color will be combined with the main volume using the Combine Mode.

Details

The input image must have the same orientation and voxel size as the main volume of the SoGVRVolumeRenderer, but it may be a sub-image as, e.g., generated by a BoundingBox module.

Input Fields

image

name: image, type: Image

ML image to use as secondary volume

inVolume

name: inVolume, type: MLBase

GVRVolume to use as secondary volume (instead of the image field).

Output Fields

self

name: self, type: SoNode

A node that must be put in front of the SoGVRVolumeRenderer

see also SoGVRSecondaryVolumeSettings.self

Parameter Fields

Field Index

Associated Lut Name: String	Volume Name: String
Combine Mode: Enum
Current Time Point: Integer
Enable Rendering: Bool
Enabled: Bool
Filter Data: Bool
Time Point Mode: Enum
Visibility: Enum

Visible Fields

Enabled

name: enabled, type: Bool, default: TRUE

If checked, the loading of the volume is enabled.

see also SoGVRSecondaryVolumeSettings.enabled

Enable Rendering

name: enableRendering, type: Bool, default: TRUE

If checked, the rendering of the volume is enabled.

Volume Name

name: volumeName, type: String, default: secondaryVolume

Sets the name of the volume.

This defines how it can be accessed in the GLSL shaders.

see also SoGVRSecondaryVolumeSettings.volumeName

Associated Lut Name

name: associatedLutName, type: String, default: secondaryLut

Sets the name of the SoGVRSecondaryLUT to use.

see also SoGVRSecondaryVolumeSettings.associatedLutName

Filter Data

name: filterData, type: Bool, default: TRUE

If checked, the linear filtering of the volume data is enabled.

see also SoGVRSecondaryVolumeSettings.filterData

Visibility

name: visibility, type: Enum, default: VolumeVisibleWithSecondaryLUT

Defines the visibility of the volume data.

Values:

Title	Name	Description
Always Visible	VolumeAlwaysVisible	The volume is always visible.
Same Visibility As Main Volume	VolumeSameVisibilityAsMainVolume	The volume is visible where the main volume is visible.
Visible With Secondary LUT	VolumeVisibleWithSecondaryLUT	The volume’s visibility is detected by the min/max and histogram of the secondary LUT.

Combine Mode

name: combineMode, type: Enum, default: CombineBlend

Defines how to combine with the main volume and other secondary volumes.

Values:

Title	Name	Description
Add	CombineAdd	Add to the result.
Max	CombineMax	Use the maximum value of the current result and the classified secondary volume.
Blend	CombineBlend	Blend the secondary volume on top of the current result.

Time Point Mode

name: timePointMode, type: Enum, default: SameAsMainVolume

Defines the time point handling.

Values:

Title	Name	Description
Same As Main Volume	SameAsMainVolume	Time point is same as main volume.
Manual	Manual	Time point is given by Current Time Point.

Current Time Point

name: currentTimePoint, type: Integer, default: 0, minimum: 0

Defines the rendered time point.