WEMInfo

MLModule

genre	WEMInformation
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLWEMModules
definition	MLWEMModules.def
see also	SoWEMRenderer
keywords	information

Purpose

The module WEMInfo provides some general and statistic information about the connected WEM.

Details

The module displays general information about an entire WEM or the selected WEMPatches, as well as more detailed information on its statistics panel.

For every Primitive Value List (PVL), statistical information (minimum, maximum, mean, and units) is displayed.

To generate statistics that are stored in a PVL, use the module WEMGenerateStatistics.

Windows

Default Panel

Input Fields

The WEM to gather information about.

inWEM

name: inWEM, type: WEM(MLBase)

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

Output Fields

outputCurveData

name: outputCurveData, type: CurveData(MLBase)

A histogram curve if all is valid, containing the information of the chosen statistic.

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

Parameter Fields

Field Index

apply: Trigger	Max.: Vector3	Repaint notifications: Bool
Area (globalSurfaceArea): Double	Maximum: Vector3	Root Mean Square Deviation: Double
Area (surfaceArea): Double	Maximum Value: Double	Selected WEM Ids: String
autoApply: Bool	Mean Value: Double	Selection notifications: Bool
autoClear: Bool	Min.: Vector3	Size (globalSize): Vector3
autoUpdate: Bool	Minimum: Vector3	Size (size): Vector3
Bounding Box Mode: Enum	Minimum Value: Double	Standard Deviation: Double
Center (globalCenter): Vector3	Num. Edges (globalNumEdges): Integer	Unique Id: Integer
Center (center): Vector3	Num. Edges (numEdges): Integer	Valid list: Bool
Curve Scale Factor: Double	Num. Faces (globalNumFaces): Integer	Value Type: String
Description: String	Num. Faces (numFaces): Integer	Value Units: String
elapsedTime: Float	Num. Locked Faces (globalNumLockedFaces): Integer	Volume (globalSurfaceVolume): Double
Finishing notifications: Bool	Num. Locked Faces (numLockedFaces): Integer	Volume (surfaceVolume): Double
Global Information Fields Valid: Bool	Num. Nodes (globalNumNodes): Integer	WEMs: String
hasEdges: Bool	Num. Nodes (numNodes): Integer	XExt: Float
Information Fields Valid: Bool	Num. Values in List: Integer	XMain Axis: Vector3
Is WEM valid: Bool	Patch Type: Enum	YExt: Float
isProcessing: Bool	Primitive Value: String	YMain Axis: Vector3
Label: String	primitiveValueLists: String	ZExt: Float
List Type: Enum	Radius (globalRadius): Double	ZMain Axis: Vector3
Main Axis Center: Vector3	Radius (radius): Double

Visible Fields

Finishing notifications

name: listenToFinishingNotifications, type: Bool, default: TRUE

If checked, the module listens for FINISHED notifications and updates accordingly.

Repaint notifications

name: listenToRepaintNotifications, type: Bool, default: FALSE

If checked, the module listens for REPAINT notifications and updates accordingly.

Selection notifications

name: listenToSelectionChangedNotifications, type: Bool, default: TRUE

If checked, the module listens for SELECTION notifications and updates accordingly.

Is WEM valid

name: isWEMValid, type: Bool, persistent: no

Shows whether the input WEM is valid.

The input WEM is valid if at least one WEMPatch is not NULL and has a non-zero amount of faces and nodes. The WEMPatch does not need to have edges.

Selected WEM Ids

name: selectedWEMs, type: String, persistent: no

Shows the IDs of the selected WEMPatches.

Information Fields Valid

name: informationFieldsValid, type: Bool, persistent: no

Shows whether the information fields for selected WEMPatches are valid.

Global Information Fields Valid

name: globalInformationFieldsValid, type: Bool, persistent: no

Shows whether the fields for displaying information of all WEMPatches are valid.

Num. Nodes (globalNumNodes)

name: globalNumNodes, type: Integer, persistent: no

Shows the total number of nodes.

Num. Edges (globalNumEdges)

name: globalNumEdges, type: Integer, persistent: no

Shows the total number of edges.

Num. Faces (globalNumFaces)

name: globalNumFaces, type: Integer, persistent: no

Shows the total number of faces.

Num. Locked Faces (globalNumLockedFaces)

name: globalNumLockedFaces, type: Integer, persistent: no

Shows the total number of locked faces.

A locked face is a single-colored face that cannot be smoothed, reduced, or subdivided. If all faces are locked and the user attempts any of the listed operations, a warning will be printed to the console.

Area (globalSurfaceArea)

name: globalSurfaceArea, type: Double, persistent: no

Shows the total area in mm².

Volume (globalSurfaceVolume)

name: globalSurfaceVolume, type: Double, persistent: no

Shows the total volume in mm³.

Center (globalCenter)

name: globalCenter, type: Vector3, persistent: no

Shows the center of all WEMPatches.

Min.

name: globalMinimum, type: Vector3, persistent: no

Shows the minimum bounding box corner of all WEMPatches.

Max.

name: globalMaximum, type: Vector3, persistent: no

Shows the maximum bounding box corner of all WEMPatches.

Size (globalSize)

name: globalSize, type: Vector3, persistent: no

Shows the size of the bounding box for all WEMPatches.

Radius (globalRadius)

name: globalRadius, type: Double, persistent: no

Shows the radius of the bounding box for all WEMPatches.

Num. Nodes (numNodes)

name: numNodes, type: Integer, persistent: no

Shows the number of nodes of all selected WEMPatches.

Num. Edges (numEdges)

name: numEdges, type: Integer, persistent: no

Shows the number of edges of all selected WEMPatches.

Num. Faces (numFaces)

name: numFaces, type: Integer, persistent: no

Shows the number of faces of all selected WEMPatches.

Num. Locked Faces (numLockedFaces)

name: numLockedFaces, type: Integer, persistent: no

Shows the number of locked faces of all selected WEMPatches.

A locked face is a single-colored face that cannot be smoothed, reduced, or subdivided. If all faces are locked and the user attempts any of the listed operations, a warning will be printed to the console.

Unique Id

name: uniqueId, type: Integer, persistent: no

Shows the unique ID of the WEM. It is generated at construction time.

Patch Type

name: patchType, type: Enum, persistent: no

Shows the type of faces of a patch.

Values:

Title	Name
​Unknown	​Unknown
​Triangles	​Triangles
​Quads	​Quads
​Polygons	​Polygons

Area (surfaceArea)

name: surfaceArea, type: Double, persistent: no

Shows the total surface area in mm².

Volume (surfaceVolume)

name: surfaceVolume, type: Double, persistent: no

Shows the volume of the surface in mm³.

Label

name: label, type: String, persistent: no

Shows the label of the selected WEMPatch.

Description

name: description, type: String, persistent: no

Shows the description of the selected WEMPatch.

Bounding Box Mode

name: boundingBoxMode, type: Enum, default: Axis Aligned

Defines the bounding box mode.

Values:

Title	Name
​Axis Aligned	​Axis Aligned
​Object Aligned	​Object Aligned

Center (center)

name: center, type: Vector3, persistent: no

Shows the center of the axis-aligned bounding box.

Minimum

name: minimum, type: Vector3, persistent: no

Shows the minimum vector of the axis-aligned bounding box.

Maximum

name: maximum, type: Vector3, persistent: no

Shows the maximum vector of the axis-aligned bounding box.

Size (size)

name: size, type: Vector3, persistent: no

Shows a vector that describes the size of the axis-aligned bounding box (its extent).

Radius (radius)

name: radius, type: Double, persistent: no

Shows the radius of a bounding sphere.

Main Axis Center

name: mainAxisCenter, type: Vector3, persistent: no

Shows the center of the principal axis-aligned bounding box.

XMain Axis

name: xMainAxis, type: Vector3, persistent: no

Shows the direction vector of the x-component of the principal axis-aligned bounding box.

YMain Axis

name: yMainAxis, type: Vector3, persistent: no

Shows the direction vector of the y-component of the principal axis-aligned bounding box.

ZMain Axis

name: zMainAxis, type: Vector3, persistent: no

Shows the direction vector of the z-component of the principal axis-aligned bounding box.

XExt

name: xExt, type: Float, persistent: no

Shows the x-extent of the principal axis-aligned bounding box.

YExt

name: yExt, type: Float, persistent: no

Shows the y-extent of the principal axis-aligned bounding box.

ZExt

name: zExt, type: Float, persistent: no

Shows the y-extent of the principal axis-aligned bounding box.

Primitive Value

name: selectedPrimitiveValueList, type: String

Sets the currently selected statistic.

Valid list

name: primitiveValueListValid, type: Bool, persistent: no

Shows whether the chosen Primitive Value List is valid.

List Type

name: primitiveValueListType, type: Enum, persistent: no

Defines the association type of the Primitive Value List.

Values:

Title	Name	Description
​Node	​Node	​Values are associated to the nodes.
​Edge	​Edge	​Values are associated to the edges.
​Face	​Face	​Values are associated to the faces.

Num. Values in List

name: numberOfPrimitiveValuesInList, type: Integer, persistent: no

Shows the number of values in the Primitive Value List.

Minimum Value

name: minPrimitiveValueList, type: Double, persistent: no

Shows the minimum value of the current statistic.

Maximum Value

name: maxPrimitiveValueList, type: Double, persistent: no

Shows the maximum value of the current statistic.

Mean Value

name: meanPrimitiveValueList, type: Double, persistent: no

Shows the mean value of the current statistic.

Standard Deviation

name: stdPrimitiveValueList, type: Double, persistent: no

Shows the standard deviation of the current statistic.

Root Mean Square Deviation

name: rmsdPrimitiveValueList, type: Double, persistent: no

Shows the root of the squared deviation of the current statistic.

Value Units

name: primitiveValueListUnits, type: String, persistent: no

Shows the units of the current statistic.

Value Type

name: primitiveValueType, type: String, persistent: no

Sets the data type of the Primitive Value List.

Curve Scale Factor

name: curveScaleFactor, type: Double, default: 1, minimum: 1, maximum: 1e+08

Sets a factor for scaling the output histogram curve.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, persistent: no

elapsedTime

name: elapsedTime, type: Float, persistent: no

autoApply

name: autoApply, type: Bool, default: TRUE

autoUpdate

name: autoUpdate, type: Bool, default: TRUE

autoClear

name: autoClear, type: Bool, default: TRUE

apply

name: apply, type: Trigger

WEMs

name: WEMs, type: String, persistent: no

hasEdges

name: hasEdges, type: Bool, persistent: no

primitiveValueLists

name: primitiveValueLists, type: String, persistent: no