OpenVDBSave

MLModule

author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLOpenVDB
definition	MLOpenVDB.def
keywords	sparse, grid

Purpose

This module allows to save the input image as OpenVDB grid. The module is experimental. It does not yet write any meta data.

Timepoints are written into the same file, appending the number of the timepoint to each grid’s name. If you need individual files for each timepoint, use a SubImage module to save each timepoint on its own.

The following datatypes are currently supported:

• int32
• int64
• float
• double
• Vector3
• Vector3f

Scalar datatypes are cast to int32 or int64 if they are smaller (like uint8, int16, etc.)

Windows

Default Panel

Parameter Fields

Field Index

Background Mode: Enum

Background Value: Double

Filename: String

Grid Name: String

Save: Trigger

Write Voxel To World Matrix: Bool

Visible Fields

Background Mode

name: backgroundMode, type: Enum, default: UserValue

Selects how the background value is determined. Selecting a good background value ensured sparsity in the resulting grid.

Values:

Title	Name	Description
User Value	UserValue	Use the Background Value field.
Input Minimum	InputMinimum	Use the input image’s minimum
Input Maximum	InputMaximum	Use the input image’s maximum

Background Value

name: backgroundValue, type: Double, default: 0

The user specified background value.

Filename

name: filename, type: String

The filename to save to.

Grid Name

name: gridName, type: String

The name of the grid that is stored in the file. If the input has multiple timepoints, multiple grids will be added to the file and the timepoint is appended to the grid name.

Write Voxel To World Matrix

name: writeVoxelToWorldMatrix, type: Bool, default: TRUE

If enabled, the voxel to world transformation is written to the file. If disabled, the grid is saved without any transformation.

Save

name: save, type: Trigger

Trigger the saving.