RasterFunctions

MLModule

genre	Draw
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLMiscModules
definition	MLMiscModules.def
see also	Draw2D, Draw3D, Raster, Mask
keywords	set, voxelization, draw, implicit, mask, object

Purpose

The module RasterFunctions generates a list of raster functions. These functions can be used in different places, specially when a function is rastered into an image with the Raster module.

Usage

There are 3 listModes which result in 3 different ways of working with the module. Have a look at the field List Mode for information about the usage.

Windows

Default Panel

Input Fields

inputXMarkerList

name: inputXMarkerList, type: XMarkerList(MLBase)

A XMarkerList.

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

Output Fields

outputFunction

name: outputFunction, type: RasterFunctionList(MLBase)

A list of raster functions. Can be rasterized into an image using the Raster module.

Parameter Fields

Field Index

Apply: Trigger	Rotation: Rotation
Apply Mode: Enum	Rotation Mode: Enum
Clear: Trigger	Scale: Vector3
Fill Value: Double	Scale XMode: Enum
Fill Value Mode: Enum	Scale YMode: Enum
Function: Enum	Scale ZMode: Enum
Function List Size: Integer	Transform: Matrix
List Mode: Enum	Translation: Vector3

Visible Fields

Function

name: function, type: Enum, default: Box, deprecated name: Function

Defines the function type.

Values:

Title	Name	Description
Fill	Fill	This fills all points
Box	Box	This fills all points in a box
Sphere	Sphere	This fills all points in a sphere
Cylinder	Cylinder	This fills all points in a cylinder
Clip Plane	ClipPlane	This fills all points in a halfspace
Wedge	Wedge	This fills all points in a wedge
Open Wedge	OpenWedge	This fills all points in an open wedge
Cone	Cone	This fills all points in a cone
Open Cone	OpenCone	This fills all points in an open cone
Half Sphere	HalfSphere	This fills all points in a half sphere
Quarter Sphere	QuarterSphere	This fills all points in a quarter sphere
Eighth Sphere	EighthSphere	This fills all points in an eighth sphere
Slab	Slab	This fills all points in a slab

List Mode

name: listMode, type: Enum, default: Single

Defines how many functions are generated.

Values:

Title	Name	Description
Single	Single	Exactly one function is added to the list. All properties for the function have to be defined manually. This corresponds to the behavior of the original implementation of this module.
Append	Append	Create a function list by adding an arbitrary number of functions manually. All properties for the function have to be defined manually and can be changed for every entry. If Apply Mode is set to ‘autoApply’, this can be used to draw for example.
From XMarker List	FromXMarkerList	Create a function list based on the inputXMarkerList. The function properties may be defined manually or derived from marker properties (see Scale XMode, Scale YMode, Scale ZMode, Fill Value Mode and Rotation Mode).

Scale XMode

name: scaleXMode, type: Enum, default: Manual

Defines, how the scaling of the function in x direction is determined. It can either be derived from marker properties or set manually using the fields below. The field is only used if the list is generated based on the input XMarkerList.

Values:

Title	Name	Description
Manual	Manual	Defined by the first component of the Scale field.
Type	Type	Defined by the marker type.
Index	Index	Defined by the marker index.
Id	Id	Defined by the marker Id.
Vector Length	VectorLength	Defined by the length of the marker vector.
Vector X	VectorX	Defined by the x coordinate of the marker vector.
Vector Y	VectorY	Defined by the y coordinate of the marker vector.
Vector Z	VectorZ	Defined by the z coordinate of the marker vector.
Position X	PositionX	Defined by the x coordinate of the marker position.
Position Y	PositionY	Defined by the y coordinate of the marker position.
Position Z	PositionZ	Defined by the z coordinate of the marker position.
Position C	PositionC	Defined by the c coordinate of the marker position.
Position T	PositionT	Defined by the t coordinate of the marker position.
Position U	PositionU	Defined by the u coordinate of the marker position.

Scale YMode

name: scaleYMode, type: Enum, default: Manual

Defines, how the scaling of the function in y direction is determined. It can either be derived from marker properties or set manually using the fields below. The field is only used if the list is generated based on the input XMarkerList.

Values:

Title	Name	Description
Manual	Manual	Defined by the second component of the Scale field.
Type	Type	Defined by the marker type.
Index	Index	Defined by the marker index.
Id	Id	Defined by the marker Id.
Vector Length	VectorLength	Defined by the length of the marker vector.
Vector X	VectorX	Defined by the x coordinate of the marker vector.
Vector Y	VectorY	Defined by the y coordinate of the marker vector.
Vector Z	VectorZ	Defined by the z coordinate of the marker vector.
Position X	PositionX	Defined by the x coordinate of the marker position.
Position Y	PositionY	Defined by the y coordinate of the marker position.
Position Z	PositionZ	Defined by the z coordinate of the marker position.
Position C	PositionC	Defined by the c coordinate of the marker position.
Position T	PositionT	Defined by the t coordinate of the marker position.
Position U	PositionU	Defined by the u coordinate of the marker position.

Scale ZMode

name: scaleZMode, type: Enum, default: Manual

Defines, how the scaling of the function in z direction is determined. It can either be derived from marker properties or set manually using the fields below. The field is only used if the list is generated based on the input XMarkerList.

Values:

Title	Name	Description
Manual	Manual	Defined by the third component of the Scale field.
Type	Type	Defined by the marker type.
Index	Index	Defined by the marker index.
Id	Id	Defined by the marker Id.
Vector Length	VectorLength	Defined by the length of the marker vector.
Vector X	VectorX	Defined by the x coordinate of the marker vector.
Vector Y	VectorY	Defined by the y coordinate of the marker vector.
Vector Z	VectorZ	Defined by the z coordinate of the marker vector.
Position X	PositionX	Defined by the x coordinate of the marker position.
Position Y	PositionY	Defined by the y coordinate of the marker position.
Position Z	PositionZ	Defined by the z coordinate of the marker position.
Position C	PositionC	Defined by the c coordinate of the marker position.
Position T	PositionT	Defined by the t coordinate of the marker position.
Position U	PositionU	Defined by the u coordinate of the marker position.

Fill Value Mode

name: valueMode, type: Enum, default: Manual

Defines, how the rotation of the function determined. It can either be rotated such that one of the positive or negative local axes of the functions coordinate system is aligned with the marker vector or set manually using the rotation field. The field is only used if the list is generated based on the input XMarkerList.

Values:

Title	Name	Description
Manual	Manual	Defined by the Fill Value field.
Type	Type	Defined by the marker type.
Index	Index	Defined by the marker index.
Id	Id	Defined by the marker Id.
Vector Length	VectorLength	Defined by the length of the marker vector.
Vector X	VectorX	Defined by the x coordinate of the marker vector.
Vector Y	VectorY	Defined by the y coordinate of the marker vector.
Vector Z	VectorZ	Defined by the z coordinate of the marker vector.
Position X	PositionX	Defined by the x coordinate of the marker position.
Position Y	PositionY	Defined by the y coordinate of the marker position.
Position Z	PositionZ	Defined by the z coordinate of the marker position.
Position C	PositionC	Defined by the x coordinate of the marker position.
Position T	PositionT	Defined by the t coordinate of the marker position.
Position U	PositionU	Defined by the u coordinate of the marker position.

Rotation Mode

name: rotationMode, type: Enum, default: Manual

Defines, how the rotation of the function determined. It can either be rotated such that one of the positive or negative local axes of the functions coordinate system is aligned with the marker vector or set manually using the rotation field. The field is only used if the list is generated based on the input XMarkerList.

Values:

Title	Name	Description
Manual	Manual	Defined by the Rotation field.
Align Positive XTo Vector	AlignPositiveXToVector	Set rotation such, that the local positive x axis of the function is aligned to the marker vector.
Align Negative XTo Vector	AlignNegativeXToVector	Set rotation such, that the local negative x axis of the function is aligned to the marker vector.
Align Positive YTo Vector	AlignPositiveYToVector	Set rotation such, that the local positive y axis of the function is aligned to the marker vector.
Align Negative YTo Vector	AlignNegativeYToVector	Set rotation such, that the local negative y axis of the function is aligned to the marker vector.
Align Positive ZTo Vector	AlignPositiveZToVector	Set rotation such, that the local positive z axis of the function is aligned to the marker vector.
Align Negative ZTo Vector	AlignNegativeZToVector	Set rotation such, that the local negative z axis of the function is aligned to the marker vector.

Transform

name: transform, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1, deprecated name: Transform

Sets a transformation as a 4x4 transformation matrix string.

Translation

name: translation, type: Vector3, default: 0 0 0, deprecated name: Translation

Sets a translation.

Rotation

name: rotation, type: Rotation, default: 0 0 1 0, deprecated name: Rotation

Sets a rotation.

Scale

name: scale, type: Vector3, default: 1 1 1, deprecated name: Scale

Sets a scale factor vector.

Fill Value

name: fillValue, type: Double, default: 1

Stes a fill value.

Function List Size

name: functionListSize, type: Integer, persistent: no

Output of the size of the current raster function list.

Clear

name: clear, type: Trigger

Clear the list.

Apply

name: apply, type: Trigger

In List Mode ‘Single’: update the single function according to the current settings. In List Mode ‘Append’: add one function according to the current settings. In List Mode ‘From XMarkerList’: update the list based on the input XMarkerList according to the current settings.

Apply Mode

name: applyMode, type: Enum, default: AutoApply

Defines the behavior of the module on changes of any field (including inputXMarkerList).

Values:

Title	Name	Description
Auto Clear	AutoClear	Clear the list.
Auto Apply	AutoApply	In List Mode ‘Single’: update the single function according to the current settings. In List Mode ‘Append’: add one function for every field change according to the current settings. In List Mode ‘From XMarkerList’: update the list based on the input XMarkerList according to the current settings.
Off	Off	Do nothing.