MarkerListToWEMPlane

MLModule
genre WEMGenerate
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLWEMModules
definition MLWEMModules.def
keywords convert, surface

Purpose

The module MarkerListToWEMPlane generates a deformed WEM plane out of markers.

Details

The modules generates a WEM plane on base of a marker list using a PCA (principal component analysis). The basic plane is oriented in a way that the shortest axis of the PCA is the normal of the basic plane and the longest axis of the PCA defines the basic plane’s size (Relative Size = 1).

The plane can be deformed by another set of markers. Of course, for both tasks, the same set of markers can be used.

Windows

Default Panel

../../../Modules/ML/MLWEMModules/mhelp/Images/Screenshots/MarkerListToWEMPlane._default.png

Input Fields

inPCAMarkerList

name: inPCAMarkerList, type: XMarkerList(MLBase)

The markers of this marker list are used to establish the PCA which influences the main orientation and size of the WEM plane.

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

inDeformMarkerList

name: inDeformMarkerList, type: XMarkerList(MLBase)

The markers of this marker list influence the deformation of the WEM plane.

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

Output Fields

outWEM

name: outWEM, type: WEM(MLBase)
For accessing this object via scripting see the Scripting Reference: MLWEMWrapper.

Parameter Fields

Field Index

Apply: Trigger id: Integer
Auto Apply: Bool isProcessing: Bool
Clear: Trigger Label: String
Description: String Overwrite label and description: Bool
elapsedTime: Float Relative Size: Float
Generation Mode: Enum shouldComputeNormals: Bool
Global Normal: Vector3 Smoothing Passes: Integer
Grid Resolution: Integer Update Mode: Enum

Visible Fields

Auto Apply

name: autoApply, type: Bool, default: TRUE

If checked, the module computes anew on a change of any fields on the panel.

Update Mode

name: updateMode, type: Enum, default: AutoUpdate, deprecated name: autoUpdate

Defines how this module should react on any input field change.

Values:

Title Name Deprecated Name Description
Off Off FALSE The output WEM is left unchanged.
Auto Update AutoUpdate TRUE The output WEM is computed anew.
Auto Clear AutoClear   The output WEM is cleared (made empty).

Apply

name: apply, type: Trigger

If pressed, the module generates the WEM plane anew.

Clear

name: clear, type: Trigger, deprecated name: clearOutput

If pressed, the output WEM is cleared and attached modules are notified.

Overwrite label and description

name: overwriteLabelDescription, type: Bool, default: FALSE

If checked, label and description strings are set in the output WEM to Label and Description.

Label

name: label, type: String

Sets a label string in the output WEM.

Description

name: description, type: String

Sets a description string in the output WEM.

Generation Mode

name: generationMode, type: Enum, default: Quads

Defines the output WEM generation mode.

Values:

Title Name Description
Quads Quads Quads are being generated.
Triangles Triangles Triangles are being generated.

Relative Size

name: relativeSize, type: Float, default: 1.2, minimum: 1.1, maximum: 3

Sets the relative size of the initial plane which is always a square.

A size of 1 means that the plane’s width and height is as large as the largest axis of the PCA.

A size of 2 means the double of the size of 1.

Grid Resolution

name: gridResolution, type: Integer, default: 40, minimum: 1, maximum: 300

Sets the resolution of the grid or the number of quads in a row/column.

Smoothing Passes

name: smoothingPasses, type: Integer, default: 150, minimum: 1, maximum: 300

Sets the amount of smoothing passes of the Laplacian smoothing.

Global Normal

name: globalNormal, type: Vector3, persistent: no

Shows the global normal of the generated plane.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, persistent: no

elapsedTime

name: elapsedTime, type: Float, persistent: no

id

name: id, type: Integer, default: 0

shouldComputeNormals

name: shouldComputeNormals, type: Bool, default: TRUE