DisplayModuleMatrix

MLModule
genre DTIImageProcessing
author Jan Klein
package FMEwork/Release
dll MLDiffusionHelpers
definition MLDiffusionHelpers.def
keywords DTI, DSI, QBALL, Q-BALL, HARDI, transition, matrix, Tuch, BaseOpMatrix

Purpose

The module DisplayModuleMatrix shows the matrix stored in a Matrix derived from Base.

Usage

Connect object of type BaseOpMatrix to input. Such a matrix can be calculated for example by the module QBallTransitionMatrix or by the module VVLGetSliceSet if available.

Windows

Default Panel

../../../Modules/ML/MLDiffusionMRI/MLDiffusionHelpers/mhelp/Images/Screenshots/DisplayModuleMatrix._default.png

Input Fields

inputTransitionMatrix

name: inputTransitionMatrix, type: MLBase

Parameter Fields

Field Index

&Save Matrix: Trigger nodeName: String
Append To File: Bool prog: Float
Auto-save: Bool Rows: Integer
baseDir: String Status: String
Columns: Integer upToDate: Bool
Erase Matrix: Trigger useBaseDir: Bool
File Name: String  
Matrix: String  

Visible Fields

Matrix

name: matrix, type: String

Shows the matrix.

Rows

name: rowNumber, type: Integer, default: 0

Shows the number of rows.

Columns

name: columnNumber, type: Integer, default: 0

Shows the number of columns.

Erase Matrix

name: eraseMatrix, type: Trigger

If pressed, the currently shown matrix is erased.

&Save Matrix

name: save, type: Trigger, deprecated name: saveObject

If pressed, the currently shown matrix is saved to disk.

Status

name: status, type: String, default: Ready., deprecated name: currStatus

Shows the status of this module.

File Name

name: filename, type: String, default: object, deprecated name: fileName

Sets a file name of a file to which the matrix can be saved.

Auto-save

name: autoSave, type: Bool, default: FALSE

If checked, the module saved the matrix on each parameter change.

Append To File

name: appendToFile, type: Bool, default: FALSE

If checked, the matrix is appended to an existing matrix file.

Hidden Fields

useBaseDir

name: useBaseDir, type: Bool, default: FALSE

baseDir

name: baseDir, type: String

nodeName

name: nodeName, type: String, default: BaseObject

upToDate

name: upToDate, type: Bool, default: FALSE

prog

name: prog, type: Float, default: 0