SoGVRMaskVolume¶

InventorModule¶

genre	`VolRendExtensions`
author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`SoGVR`
definition	soGVR.def
see also	`SoGVRVolumeRenderer`
inherits from	`SoGVRMaskSettings`

Purpose¶

The SoGVRMaskVolume module allows for setting a mask volume that can be utilized by the SoGVRVolumeRenderer module. Its main purpose is to either mask or highlight segmentation results or to use highlighted regions with a mask geometry.

The main differences to the SoGVRTagVolume are:

The mask volume can be of any resolution or size and can have an arbitrary world matrix that does not need to match the input volume of the SoGVRVolumeRenderer.
The mask volume is not converted into an octree; instead, it is loaded as a single 3D texture.
The mask volume typically provides a binary (inside/outside) decision, so its values are not interpreted as different tag values, as they are in the tag volume.
It allows for much faster updates compared to updating the tag volume.
The mask volumes should be relatively small; for example, 256x256x256 is an adequate size on current hardware. Using masks that are too large may cause OpenGL driver problems.

The mask volume can be combined with a SoGVRTagVolume to enable masking of tagged volume rendering.

Tips¶

Since the size, position, and orientation of the mask volume is arbitrary, it can be used to show subvolumes, segmentation results in different resolution, registration results, and much more.

Input Fields¶

image¶

name: image, type: Image¶: The input image must be an unsigned int8 gray scale image.

Output Fields¶

self¶

name: self, type: SoNode¶: A node that must be put in front of the SoGVRVolumeRenderer.

Parameter Fields¶

Field Index¶

`Binary`: `Bool`	`Interpolate`: `Bool`	`Replace World To Voxel Matrix`: `Bool`
`Binary Threshold`: `Float`	`Load Mask`: `Bool`	`Tag Mode`: `Enum`
`Custom World To Voxel Matrix`: `Matrix`	`Modify World Coordinates`: `Bool`	`Transform Mode`: `Enum`
`Enabled (mask)`: `Bool`	`Outside Alpha`: `Float`	`World Center`: `Vector3`
`Enabled (modifyRGBA)`: `Bool`	`Outside Color`: `Color`	`World Rotation`: `Rotation`
`Inside Alpha`: `Float`	`Outside Tag Value`: `Integer`	`World Scale`: `Vector3`
`Inside Color`: `Color`	`Overwrite Settings (overwriteSettings)`: `Bool`
`Inside Tag Value`: `Integer`	`Overwrite Settings (overwriteTransformSettings)`: `Bool`

Visible Fields¶

Load Mask¶

name: enabled, type: Bool, default: TRUE¶: If checked, the loading of the mask image is enabled.

Enabled (mask)¶

name: mask, type: Bool, default: TRUE¶: If checked, the rendering of the mask is enabled.

Binary¶

name: binary, type: Bool, default: TRUE¶: If checked, the generation of a binary mask is enabled, utilizing the Binary Threshold.

Binary Threshold¶

name: binaryThreshold, type: Float, default: 0.001, minimum: 0, maximum: 1¶: Sets a threshold to determine when a mask value is considered “inside” if Binary is enabled.

Interpolate¶

name: interpolate, type: Bool, default: FALSE¶: If checked, the mask values are subject to linear interpolation.

Enabled (modifyRGBA)¶

name: modifyRGBA, type: Bool, default: TRUE¶: If checked, the modification of the voxel color is enabled.

Inside Alpha¶

name: insideAlpha, type: Float, default: 1, minimum: 0, maximum: 1¶: Sets the alpha factor for inside voxels.

Outside Alpha¶

name: outsideAlpha, type: Float, default: 0, minimum: 0, maximum: 1¶: Sets the alpha factor for outside voxels.

Inside Color¶

name: insideColor, type: Color, default: 1 1 1¶: Sets the color for inside voxels.

Outside Color¶

name: outsideColor, type: Color, default: 1 1 1¶: Sets the color for outside voxels.

Inside Tag Value¶

name: insideTagValue, type: Integer, default: 1¶: Sets the tag value for inside voxels.

Outside Tag Value¶

name: outsideTagValue, type: Integer, default: 0¶: Sets the tag value for outside voxels.

Transform Mode¶

name: transformMode, type: Enum, default: UseWorldCoordinates¶: Defines how to transform the mask volume.

Values:

Title	Name	Description
Use World Coordinates	UseWorldCoordinates	Transforms the mask volume according to its world coordinate system relative to the main volume.
Scale To Image	ScaleToImage	Scales the mask to match the main volume. This is useful for using a small mask volume and rescaling it to the entire main volume.

Replace World To Voxel Matrix¶

name: replaceWorldToVoxelMatrix, type: Bool, default: FALSE, deprecated name: useTransformationMatrix¶: If checked, the use of Custom World To Voxel Matrix is enabled.

Custom World To Voxel Matrix¶

name: customWorldToVoxelMatrix, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1, deprecated name: transformationMatrix¶: Sets a custom world coordinate system that is used instead of the input image’s coordinate system.

Tag Mode¶

name: tagMode, type: Enum, default: Off¶: Defines how the tag value is modified.