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 from markers.
Details¶
The module generates a WEM plane based on a marker list using PCA (principal component analysis). The basic plane is oriented such that the shortest axis of the PCA serves as the normal of the basic plane, while the longest axis of the PCA defines the size of the basic plane (Relative Size
= 1).
The basic plane can be deformed by another set of markers. For both tasks, the same set of markers can, of course, be used.
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). |
Clear¶
-
name:
clear
, type:
Trigger
, deprecated name:
clearOutput
¶ When 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
andDescription
.
Generation Mode¶
-
name:
generationMode
, type:
Enum
, default:
Quads
¶ Defines the output WEM generation mode.
Values:
Title | Name | Description |
---|---|---|
Quads | Quads | Quads are generated. |
Triangles | Triangles | Triangles are 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 are equal to the largest axis of the PCA.
Grid Resolution¶
-
name:
gridResolution
, type:
Integer
, default:
40
, minimum:
1
, maximum:
300
¶ Sets the resolution of the grid or the number of quads per row and column.