CSOVoxelSetToImage

MLModule

genre	CSOModule
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLCSOModules
definition	MLCSOModules.def
keywords	contour, translate, voxelize, rasterize

Purpose

The module CSOVoxelSetToImage converts a CSOVoxelSetList to an ML image.

Usage

Attach a reference image and a CSOVoxelSetList to the module and press Update.

Details

The input reference image is optional since the CSOVoxelSetList stores the original image’s voxelToWorld matrix and the image extent.

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

An optional reference image to obtain image extent, data type, and voxel-to-world matrix.

inCSOVoxelSetList

name: inCSOVoxelSetList, type: CSOVoxelSetList(MLBase)

The CSOVoxelSetList to be converted to an image.

For accessing this object via scripting, see the Scripting Reference: MLCSOVoxelSetListWrapper.

Output Fields

output0

name: output0, type: Image

The converted image.

Parameter Fields

Field Index

Auto Update: Bool	Write all values to first u-dimension: Bool
Data Type: Enum
Filter By: Enum
Id Filter: String
inputImageValid: Bool
Invert: Bool
Update: Trigger
Voxel Set Mode: Enum

Visible Fields

Auto Update

name: autoUpdate, type: Bool, default: FALSE

If checked, the module computes a new output image if any input is changed.

Data Type

name: dataType, type: Enum, default: float

Sets a data type for the output image in case that no input reference image is attached.

Note that the module does not clamp the output image values against the data type range. The values are simply cast to the output data type, which can lead to unwanted results.

The alternative would be to apply some ML magic, which leads in the most cases to even more unwanted results.

Values:

Title	Name
​int8	​int8
​unsigned int8	​unsigned int8
​int16	​int16
​unsigned int16	​unsigned int16
​int32	​int32
​unsigned int32	​unsigned int32
​float	​float
​double	​double
​int64	​int64
​unsigned int64	​unsigned int64
​complexf	​complexf
​complexd	​complexd
​quaternionf	​quaternionf
​quaterniond	​quaterniond
​vecf2	​vecf2
​vec2	​vec2
​vecf3	​vecf3
​vec3	​vec3
​vecf4	​vecf4
​vec4	​vec4
​vecf5	​vecf5
​vec5	​vec5
​vecf6	​vecf6
​vec6	​vec6
​vecf7	​vecf7
​vec7	​vec7
​vecf8	​vecf8
​vec8	​vec8
​vecf9	​vecf9
​vec9	​vec9
​vecf10	​vecf10
​vec10	​vec10
​vecf16	​vecf16
​vec16	​vec16
​vecf32	​vecf32
​vec32	​vec32
​vecf64	​vecf64
​vec64	​vec64
​matf2	​matf2
​mat2	​mat2
​matf3	​matf3
​mat3	​mat3
​matf4	​matf4
​mat4	​mat4
​matf5	​matf5
​mat5	​mat5
​matf6	​matf6
​mat6	​mat6
​Vector2i8	​Vector2i8
​Vector2i16	​Vector2i16
​Vector2i32	​Vector2i32
​Vector2i64	​Vector2i64
​Vector3i8	​Vector3i8
​Vector3i16	​Vector3i16
​Vector3i32	​Vector3i32
​Vector3i64	​Vector3i64
​Vector4i8	​Vector4i8
​Vector4i16	​Vector4i16
​Vector4i32	​Vector4i32
​Vector4i64	​Vector4i64
​Vector5i8	​Vector5i8
​Vector5i16	​Vector5i16
​Vector5i32	​Vector5i32
​Vector5i64	​Vector5i64
​Vector6i8	​Vector6i8
​Vector6i16	​Vector6i16
​Vector6i32	​Vector6i32
​Vector6i64	​Vector6i64
​Vector7i8	​Vector7i8
​Vector7i16	​Vector7i16
​Vector7i32	​Vector7i32
​Vector7i64	​Vector7i64
​Vector8i8	​Vector8i8
​Vector8i16	​Vector8i16
​Vector8i32	​Vector8i32
​Vector8i64	​Vector8i64
​Vector9i8	​Vector9i8
​Vector9i16	​Vector9i16
​Vector9i32	​Vector9i32
​Vector9i64	​Vector9i64
​Vector10i8	​Vector10i8
​Vector10i16	​Vector10i16
​Vector10i32	​Vector10i32
​Vector10i64	​Vector10i64
​Vector16i8	​Vector16i8
​Vector16i16	​Vector16i16
​Vector16i32	​Vector16i32
​Vector16i64	​Vector16i64
​Vector32i8	​Vector32i8
​Vector32i16	​Vector32i16
​Vector32i32	​Vector32i32
​Vector32i64	​Vector32i64
​Vector64i8	​Vector64i8
​Vector64i16	​Vector64i16
​Vector64i32	​Vector64i32
​Vector64i64	​Vector64i64

Write all values to first u-dimension

name: writeAllValuesToFirstUDimension, type: Bool, default: FALSE

If checked, all the voxels are written to the first u-dimension.

Otherwise, each CSO is voxelized to the u-dimension that corresponds to the CSO’s index.

Voxel Set Mode

name: voxelSetMode, type: Enum, default: VoxelSetModeReplaceMax

Defines how the target voxel value is computed in case that CSOs overlap.

Values:

Title	Name	Description
​Add	​VoxelSetModeAdd	​Voxel values are added.
​Replace Max	​VoxelSetModeReplaceMax	​The maximum voxel value is written.
​Replace Min	​VoxelSetModeReplaceMin	​The minimum voxel value is written. The initial background value is not considered here.
​XOR	​VoxelSetModeXOR	​Applies an XOR logic; an even number of values to be written to the same voxel results in a voxel with background value, an odd number of voxels to be written results in the last value that was written.

Filter By

name: filterById, type: Enum, default: CSO

Defines by which structure the CSOVoxelSetList should be filtered by.

Values:

Title	Name	Description
​Cso	​CSO	​Filter by CSO(VoxelSet) ID.
​Group	​Group	​Filter by CSO(VoxelSet)Group ID.

Id Filter

name: idFilter, type: String

Sets a string consisting of the IDs for filtering.

Invert

name: invertFilter, type: Bool, default: FALSE

If checked, the Id Filter logic is inverted.

Update

name: update, type: Trigger

When pressed, the modules computes a new output image.

Hidden Fields

inputImageValid

name: inputImageValid, type: Bool, default: FALSE