WEMInfo¶

MLModule¶

genre	`WEMInformation`
status	`stable`
authors	`Bart De Dobbelaer`, `Olaf Konrad`, `Stefan Saur`
package	`MeVisLab/Standard`
dll	`MLWEMModules`
definition	MLWEMModules.def
see also	`SoWEMRenderer`
keywords	`WEM`, `information`

Purpose¶

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

Details¶

The module display general information about a whole WEM or a chosen WEMPatch and more detailed information on its statistics panel.

The WEMInfo's statistics panel has seven information modes:

Edge Length
Face Area
Face Quality
Node Valence
Node Curvature
Node LUT Value

For each of these modes some statistical information (minimum, maximum, mean and units) is displayed.

A more detailed explanation on some of those modes:

Mode

Description

Face Area

In this statistics mode, the total surface area and volume are also shown.

Face Quality

The face quality of a triangle is defined as the ratio of the square root of its area to its perimeter relative to this same ratio for an equilateral triangle with the same area. The quality is then one for an equilateral triangle and tends to zero for a very stretched triangle.

For non-triangle faces, the face is split up in triangles. The quality is then defined by the average of the quality of each such triangle.

Node Curvature

Node curvature is defined as the maximum angle between the node normal and the normal of all incident faces to that node.

For a flat region, the node normal and the incident face normals are about the same, which gives an angle of almost zero degrees. For corners or creases this angle becomes large, up to 70 degrees.

Windows¶

Default Panel¶

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

Input Fields¶

The WEM to gather information about.

inWEM¶

name: inWEM, type: MLBase¶

Output Fields¶

outputCurveData¶

name: outputCurveData, type: MLBase¶: A histogram curve if all is valid, containing the information of the chosen statistic.

Parameter Fields¶

Field Index¶

`apply`: `Trigger`	`globalMaximum`: `Vector3`	`Number of Nodes`: `Integer`
`Area`: `Double`	`globalMinimum`: `Vector3`	`Patch Type`: `Enum`
`autoApply`: `Bool`	`globalNumEdges`: `Integer`	`pointSize`: `Float`
`autoClear`: `Bool`	`globalNumFaces`: `Integer`	`primitiveValueLists`: `String`
`autoUpdate`: `Bool`	`globalNumNodes`: `Integer`	`primitiveValueListValid`: `Bool`
`Bounding Box Mode`: `Enum`	`globalRadius`: `Double`	`Radius`: `Double`
`boundingBoxColor`: `Color`	`globalSize`: `Vector3`	`Root Mean Square Deviation`: `Double`
`Center`: `Vector3`	`globalSurfaceArea`: `Double`	`Selected Primitive Value List`: `String`
`colorMode`: `Enum`	`globalSurfaceVolume`: `Double`	`selectedWEMs`: `String`
`Curve Scale Factor`: `Double`	`hasEdges`: `Bool`	`show`: `Bool`
`Description`: `String`	`informationFieldsValid`: `Bool`	`Size`: `Vector3`
`drawBoundingBox`: `Bool`	`isProcessing`: `Bool`	`Standard Deviation`: `Double`
`drawEdges`: `Bool`	`Label`: `String`	`Unique Id`: `Integer`
`drawFaceNormals`: `Bool`	`lineWidth`: `Float`	`useEdgeColoringMode`: `Bool`
`drawFaces`: `Bool`	`listenToFinishingNotifications`: `Bool`	`useFaceAmbientColor`: `Bool`
`drawNodeNormals`: `Bool`	`listenToRepaintNotifications`: `Bool`	`useFaceDiffuseColor`: `Bool`
`drawNodes`: `Bool`	`listenToSelectionChangedNotifications`: `Bool`	`useFaceSpecularColor`: `Bool`
`edgeColor`: `Color`	`Main Axis Center`: `Vector3`	`usePolygonOffset`: `Bool`
`editable`: `Bool`	`Maximum`: `Vector3`	`Value Units (primitiveValueListUnits)`: `String`
`elapsedTime`: `Float`	`Maximum Value`: `Double`	`Value Units (edgeLengthUnits)`: `Enum`
`faceAlphaValue`: `Float`	`Mean Value`: `Double`	`Value Units (faceAreaUnits)`: `Enum`
`faceAmbientColor`: `Color`	`Minimum`: `Vector3`	`Volume`: `Double`
`faceDiffuseColor`: `Color`	`Minimum Value`: `Double`	`WEMs`: `String`
`faceNormalsColor`: `Color`	`nodeColor`: `Color`	`XExt`: `Float`
`faceNormalsScale`: `Float`	`nodeNormalsColor`: `Color`	`XMain Axis`: `Vector3`
`faceShininessValue`: `Float`	`nodeNormalsScale`: `Float`	`YExt`: `Float`
`faceSpecularColor`: `Color`	`nodeRenderingMode`: `Enum`	`YMain Axis`: `Vector3`
`globalCenter`: `Vector3`	`Number of Edges`: `Integer`	`ZExt`: `Float`
`globalInformationFieldsValid`: `Bool`	`Number of Faces`: `Integer`	`ZMain Axis`: `Vector3`

Visible Fields¶

Number of Nodes¶

name: numNodes, type: Integer, default: 0¶: Shows the number of nodes.

Number of Edges¶

name: numEdges, type: Integer, default: 0¶: Shows the number of edges.

Number of Faces¶

name: numFaces, type: Integer, default: 0¶: Shows the number of faces.

Unique Id¶

name: uniqueId, type: Integer, default: -1¶: Shows the unique Id of the WEM. It is generated at construction time.

Patch Type¶

name: patchType, type: Enum, default: Unknown¶: Shows the type of faces of a patch.

Values:

Title	Name
Unknown	Unknown
Triangles	Triangles
Quads	Quads
Polygons	Polygons

Area¶

name: surfaceArea, type: Double, default: 0¶: Shows the total surface area in sqmm.

Volume¶

name: surfaceVolume, type: Double, default: 0¶: Shows the volume of the surface in cmm

Label¶

name: label, type: String¶: Shows the label of the selected WEMPatch.

Description¶

name: description, type: String¶: 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¶

name: center, type: Vector3, default: 0 0 0¶: Shows the center of the axis aligned bounding box.

Minimum¶

name: minimum, type: Vector3, default: 0 0 0¶: Shows the minimum vector of the axis aligned bounding box.

Maximum¶

name: maximum, type: Vector3, default: 0 0 0¶: Shows the maximum vector of the axis aligned bounding box.

Size¶

name: size, type: Vector3, default: 0 0 0¶: Shows a vector describing the size of the axis aligned bounding box (its extent).

Radius¶

name: radius, type: Double, default: 0¶: Shows the radius of a bounding sphere.

Main Axis Center¶

name: mainAxisCenter, type: Vector3, default: 0 0 0¶: Shows the center of the main axis bounding box.

XMain Axis¶

name: xMainAxis, type: Vector3, default: 0 0 0¶: Shows the direction vector of the x-component of the main axis bounding box.

YMain Axis¶

name: yMainAxis, type: Vector3, default: 0 0 0¶: Shows the direction vector of the y-component of the main axis bounding box.

ZMain Axis¶

name: zMainAxis, type: Vector3, default: 0 0 0¶: Shows the direction vector of the z-component of the main axis bounding box.

XExt¶

name: xExt, type: Float, default: 0¶: Shows the x-extent of the main axis bounding box.

YExt¶

name: yExt, type: Float, default: 0¶: Shows the y-extent of the main axis bounding box.

ZExt¶

name: zExt, type: Float, default: 0¶: Shows the y-extent of the main axis bounding box.

Selected Primitive Value List¶

name: selectedPrimitiveValueList, type: String¶: Sets the currently selected statistic.

Minimum Value¶

name: minPrimitiveValueList, type: Double, default: 0¶: Shows the minimum value of the current statistic.

Maximum Value¶

name: maxPrimitiveValueList, type: Double, default: 0¶: Shows the maximum value of the current statistic.

Mean Value¶

name: meanPrimitiveValueList, type: Double, default: 0¶: Shows the mean value of the current statistic

Standard Deviation¶

name: stdPrimitiveValueList, type: Double, default: 0¶: Shows the standard deviation of the current statistic

Root Mean Square Deviation¶

name: rmsdPrimitiveValueList, type: Double, default: 0¶: Shows the root of the squared deviation of the current statistic

Value Units (primitiveValueListUnits)¶

name: primitiveValueListUnits, type: String¶: Sets the units of the current statistic.

Value Units (edgeLengthUnits)¶

name: edgeLengthUnits, type: Enum, default: mm¶: Defines the unit for lengths of edges.

Values:

Title	Name
mm	mm
cm	cm
m	m

Value Units (faceAreaUnits)¶

name: faceAreaUnits, type: Enum, default: mm2¶: Defines the units for areas of faces.

Values:

Title	Name
mm2	mm2
cm2	cm2
m2	m2

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, default: FALSE¶

elapsedTime¶

name: elapsedTime, type: Float, default: 0¶

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¶

listenToFinishingNotifications¶

name: listenToFinishingNotifications, type: Bool, default: TRUE¶

listenToRepaintNotifications¶

name: listenToRepaintNotifications, type: Bool, default: FALSE¶

listenToSelectionChangedNotifications¶

name: listenToSelectionChangedNotifications, type: Bool, default: TRUE¶

WEMs¶

name: WEMs, type: String¶

selectedWEMs¶

name: selectedWEMs, type: String¶

informationFieldsValid¶

name: informationFieldsValid, type: Bool, default: FALSE¶

globalInformationFieldsValid¶

name: globalInformationFieldsValid, type: Bool, default: FALSE¶

globalNumNodes¶

name: globalNumNodes, type: Integer, default: 0¶

globalNumEdges¶

name: globalNumEdges, type: Integer, default: 0¶

globalNumFaces¶

name: globalNumFaces, type: Integer, default: 0¶

globalSurfaceArea¶

name: globalSurfaceArea, type: Double, default: 0¶

globalSurfaceVolume¶

name: globalSurfaceVolume, type: Double, default: 0¶

globalCenter¶

name: globalCenter, type: Vector3, default: 0 0 0¶

globalMinimum¶

name: globalMinimum, type: Vector3, default: 0 0 0¶

globalMaximum¶

name: globalMaximum, type: Vector3, default: 0 0 0¶

globalSize¶

name: globalSize, type: Vector3, default: 0 0 0¶

globalRadius¶

name: globalRadius, type: Double, default: 0¶

hasEdges¶

name: hasEdges, type: Bool, default: FALSE¶

show¶

name: show, type: Bool, default: TRUE¶

editable¶

name: editable, type: Bool, default: TRUE¶

colorMode¶

name: colorMode, type: Enum, default: General¶

Values:

Title	Name
General	General
Node Colors	Node Colors
LUT Values	LUT Values
LUT Values Integer	LUT Values Integer

drawFaces¶

name: drawFaces, type: Bool, default: TRUE¶

useFaceAmbientColor¶

name: useFaceAmbientColor, type: Bool, default: TRUE¶

faceAmbientColor¶

name: faceAmbientColor, type: Color, default: 0.266667008399963 0.266667008399963 0.266667008399963¶

useFaceDiffuseColor¶

name: useFaceDiffuseColor, type: Bool, default: TRUE¶

faceDiffuseColor¶

name: faceDiffuseColor, type: Color, default: 0.792156994342804 0.792156994342804 0.792156994342804¶

useFaceSpecularColor¶

name: useFaceSpecularColor, type: Bool, default: TRUE¶

faceSpecularColor¶

name: faceSpecularColor, type: Color, default: 0.0666669979691505 0.0666669979691505 0.0666669979691505¶

faceAlphaValue¶

name: faceAlphaValue, type: Float, default: 1, minimum: 0, maximum: 1¶

faceShininessValue¶

name: faceShininessValue, type: Float, default: 1, minimum: 0, maximum: 1¶

drawFaceNormals¶

name: drawFaceNormals, type: Bool, default: FALSE¶

faceNormalsColor¶

name: faceNormalsColor, type: Color, default: 1 1 1¶

faceNormalsScale¶

name: faceNormalsScale, type: Float, default: 1¶

drawEdges¶

name: drawEdges, type: Bool, default: FALSE¶

edgeColor¶

name: edgeColor, type: Color, default: 0 0 0¶

usePolygonOffset¶

name: usePolygonOffset, type: Bool, default: FALSE¶

lineWidth¶

name: lineWidth, type: Float, default: 1, minimum: 1¶

useEdgeColoringMode¶

name: useEdgeColoringMode, type: Bool, default: FALSE¶

drawNodes¶

name: drawNodes, type: Bool, default: FALSE¶

nodeColor¶

name: nodeColor, type: Color, default: 1 1 1¶

drawNodeNormals¶

name: drawNodeNormals, type: Bool, default: FALSE¶

nodeNormalsColor¶

name: nodeNormalsColor, type: Color, default: 1 1 1¶

nodeNormalsScale¶

name: nodeNormalsScale, type: Float, default: 1¶

pointSize¶

name: pointSize, type: Float, default: 1, minimum: 1¶

nodeRenderingMode¶

name: nodeRenderingMode, type: Enum, default: Normal¶

Values:

Title	Name
Normal	Normal
High	High
Extra High	Extra High

drawBoundingBox¶

name: drawBoundingBox, type: Bool, default: FALSE¶

boundingBoxColor¶

name: boundingBoxColor, type: Color, default: 1 1 1¶

primitiveValueLists¶

name: primitiveValueLists, type: String¶

primitiveValueListValid¶

name: primitiveValueListValid, type: Bool, default: FALSE¶

Navigation

WEMInfo¶

Purpose¶

Details¶

Windows¶

Default Panel¶

Input Fields¶

inWEM¶

Output Fields¶

outputCurveData¶

Parameter Fields¶

Field Index¶

Visible Fields¶

Number of Nodes¶

Number of Edges¶

Number of Faces¶

Unique Id¶

Patch Type¶

Area¶

Volume¶

Label¶

Description¶

Bounding Box Mode¶

Center¶

Minimum¶

Maximum¶

Size¶

Radius¶

Main Axis Center¶

XMain Axis¶

YMain Axis¶

ZMain Axis¶

XExt¶

YExt¶

ZExt¶

Selected Primitive Value List¶

Minimum Value¶

Maximum Value¶

Mean Value¶

Standard Deviation¶

Root Mean Square Deviation¶

Value Units (primitiveValueListUnits)¶

Value Units (edgeLengthUnits)¶

Value Units (faceAreaUnits)¶

Curve Scale Factor¶

Hidden Fields¶

isProcessing¶

elapsedTime¶

autoApply¶

autoUpdate¶

autoClear¶

apply¶

listenToFinishingNotifications¶

listenToRepaintNotifications¶

listenToSelectionChangedNotifications¶

WEMs¶

selectedWEMs¶

informationFieldsValid¶

globalInformationFieldsValid¶

globalNumNodes¶

globalNumEdges¶

globalNumFaces¶

globalSurfaceArea¶

globalSurfaceVolume¶

globalCenter¶

globalMinimum¶

globalMaximum¶

globalSize¶

globalRadius¶

hasEdges¶

show¶

editable¶

colorMode¶

drawFaces¶

useFaceAmbientColor¶

faceAmbientColor¶

useFaceDiffuseColor¶

faceDiffuseColor¶

useFaceSpecularColor¶

faceSpecularColor¶