CSOAffineTransformationModificator

MLModule
genre CSOModule
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLCSOModules
definition MLCSOModules.def
see also CSOFilter, CSOManager
keywords matrix, rotate, shear, translate, scale

Purpose

The module CSOAffineTransformationModificator applies a 4x4 transformation on a subset of all input CSOs. The module can either modify the subset of chosen CSOs directly or generate copies of them before applying the matrix to them.

Usage

Attach a CSOList to the module’s input and enter a list of CSO ids into the according field for selecting the subset of CSOs that are to be transformed.

If the module does not work directly on the input CSOList (Work directly on input CSOList), the module copies the input CSOList to its output and performs the transformation on the copied output list.

Details

The module simply applies the transformation matrix on each coordinate of the seed point and the path points of all chosen CSOs.

Windows

Default Panel

../../../Modules/ML/MLCSOModules/mhelp/Images/Screenshots/CSOAffineTransformationModificator._default.png

Input Fields

inCSOList

name: inCSOList, type: CSOList(MLBase)

A CSOList is the input of this module.

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

Output Fields

outCSOList

name: outCSOList, type: CSOList(MLBase)

If the module should not work directly on the input CSOList (Work directly on input CSOList), a copy is made and the alterations are performed on this copy.

The output is either a pointer to the input CSOList or pointer to an internal copy.

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

Parameter Fields

Field Index

addCSOToGroupMode: Enum Enable Undo/Redo: Bool Work directly on input CSOList: Bool
addCSOToGroupWithId: Integer Finishing: Bool  
addCSOToGroupWithLabel: String id: Integer  
Auto apply: Bool isProcessing: Bool  
Change settings of modified CSOs: Bool Matrix: Matrix  
CSO Ids: String Mode: Enum  
done: Trigger Selection: Bool  
emptyGroupBeforeGeneration: Bool Update: Trigger  

Visible Fields

Mode

name: updateMode, type: Enum, default: AutoClear

Defines how the module reacts on changes of the input (CSOList) or on notifications.

Values:

Title Name Description
Off Off The module does nothing.
Auto Update AutoUpdate The module computes anew on changes to the input or on notifications.
Auto Clear AutoClear  

Auto apply

name: autoApply, type: Bool, default: FALSE

If checked, the module computes anew if a field on the GUI has been changed.

Update

name: apply, type: Trigger

If pressed, the module computes anew.

CSO Ids

name: csoIdList, type: String

Sets a space-separated list of CSO ids that should be transformed by the gived matrix.

If the list is empty, all CSOs are being transformed.

Work directly on input CSOList

name: workDirectlyOnInputList, type: Bool, default: TRUE

If checked, the module works directly on the input list.

Otherwise, the module creates a copy of the input CSOList and works on that copy.

Enable Undo/Redo

name: useUndoRedo, type: Bool, default: TRUE

Change settings of modified CSOs

name: changeSettingsForModifiedCSOs, type: Bool, default: FALSE

If checked, the settings (visual, voxelization, editing, etc.) are changed according to the module’s settings for all transformed CSOs.

Finishing

name: listenToFinishingNotifications, type: Bool, default: TRUE

If checked, the module updates on finished notifications if the module’s Mode is set to AutoUpdate.

Selection

name: listenToSelectionNotifications, type: Bool, default: TRUE

If checked, the module updates on selection notifications if the module’s Mode is set to AutoUpdate.

Matrix

name: matrix, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1

Sets the 4x4 matrix that is applied to all seed and path points of the chosen CSOs.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, persistent: no

done

name: done, type: Trigger, persistent: no

emptyGroupBeforeGeneration

name: emptyGroupBeforeGeneration, type: Bool, default: FALSE

addCSOToGroupMode

name: addCSOToGroupMode, type: Enum, default: AddToGroupByLabel

Values:

Title Name
None AddToGroupNone
By Label AddToGroupByLabel
By Id AddToGroupById

addCSOToGroupWithLabel

name: addCSOToGroupWithLabel, type: String

addCSOToGroupWithId

name: addCSOToGroupWithId, type: Integer, default: -1

id

name: id, type: Integer, default: 0