WEMSelectPatches

MLModule
genre WEMProcessing
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLWEMModules
definition MLWEMModules.def
see also WEMDemergePatches, WEMThreshold
inherits from WEMProcessor
keywords create, filter

Purpose

The module WEMMDSSelectPatches allows for selecting patches of a WEM and creating new WEM from them.

Usage

Connect a WEM to the input field. Select the parameters described below to define which patches shall be copied to the new WEM.

Click Apply to create the new WEM (or alternatively enable the Auto Apply option).

Hitting the Clear button clears the output WEM (removes all patches).

Details

This module creates a new WEM based on the WEM/patches connected to its input.

Each time the Apply button is clicked, a new WEM is created that consists of all patches from the WEM connected to the input that match the criteria specified in the Selection Settings box.

The input WEM is not altered.

If the option Auto Apply is enabled, all parameter changes automatically trigger the creation of the new WEM.

Hitting the Clear button removes all patches from the output WEM.

Tips

If the Allow only one single output patch option is enabled, the Label and the Description attributes need to be set - otherwise they will be erased (or overwritten with the default - empty - value, respectively).

Windows

Default Panel

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

Input Fields

inWEM

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

Output Fields

outWEM

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

Parameter Fields

Visible Fields

Auto Apply

name: autoApply, type: Bool, default: FALSE

If checked, the module selects the output patch on changing any parameter.

see also WEMGenerator.autoApply

Update Mode

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

Defines the update mode of this module.

see also WEMGenerator.updateMode

Apply

name: apply, type: Trigger

If pressed, the module selects the output patch(es) on base of the paramters.

see also WEMGenerator.apply

Clear

name: clear, type: Trigger

If pressed, the module clears its output.

see also WEMGenerator.clear

Overwrite Label Description

name: overwriteLabelDescription, type: Bool, default: FALSE

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

see also WEMGenerator.overwriteLabelDescription

Label

name: label, type: String

Sets the label string to the output WEMPatch.

Available only if Allow only one single output patch is checked.

see also WEMGenerator.label

Description

name: description, type: String

Sets the description string to the output WEMPatch.

Available only if Allow only one single output patch is checked.

see also WEMGenerator.description

Selection Mode

name: selectMode, type: Enum, default: Patch Number

Defines which property of the input WEM patches shall be used for selection.

Values:

Title Name
Patch Number Patch Number
Patch ID Patch ID
Primitive Value: LUT PrimitiveValue: LUT
Primitive Value PrimitiveValue

Selection Value

name: selectValue, type: String

Sets a value to selected the WEMPatch. The use of the value depends on Selection Mode.

Primitive Value Name

name: primitiveValueName, type: String

Sets a primitive value list name to select a WEMPatch, if Selection Mode is set to PrimitiveValue. A patch is selected if the mean PVL value is equal to the given value specified in Selection Value.

Allow only one single output patch

name: singleOutputPatch, type: Bool, default: TRUE

If checked, generally only one (the first, if more than one is available) patch is copied.

In this case it is posssible to edit the attributes of the patch(see Triangulate Patches).

Some options selectable for the Selection Value parameter result in only one patch being copied to the output WEM (e.g. Patch ID), others result in multiple patches being copied (e.g. Primitive Value: LUT).

Triangulate Patches

name: triangulatePatches, type: Bool, default: TRUE

If checked, all patches will be triangulate before adding them to the output WEM.

Remember: some WEM modules support arbitrary polygons, others do not.

Normally, all patches from the input WEM are copied to he output WEM “as they are” (i.e. with the same number and type of faces like in the input WEM).

Available only if Allow only one single output patch is not checked.

Status

name: status, type: String, persistent: no

Shows the module’s status.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, persistent: no

see WEMGenerator.isProcessing

elapsedTime

name: elapsedTime, type: Float, persistent: no

see WEMGenerator.elapsedTime

id

name: id, type: Integer, default: 0

see WEMGenerator.id

shouldComputeNormals

name: shouldComputeNormals, type: Bool, default: TRUE

see WEMGenerator.shouldComputeNormals

workDirectlyOnInputWEMs

name: workDirectlyOnInputWEMs, type: Bool, default: FALSE

see WEMProcessor.workDirectlyOnInputWEMs

listenToFinishNotifications

name: listenToFinishNotifications, type: Bool, default: TRUE

see WEMProcessor.listenToFinishNotifications

listenToRepaintNotifications

name: listenToRepaintNotifications, type: Bool, default: TRUE

see WEMProcessor.listenToRepaintNotifications

listenToSelectionChangedNotifications

name: listenToSelectionChangedNotifications, type: Bool, default: TRUE

see WEMProcessor.listenToSelectionChangedNotifications

progress

name: progress, type: Float, persistent: no

see WEMProcessor.progress

triangulationMode

name: triangulationMode, type: Enum, default: Strip

see WEMProcessor.triangulationMode