SaveFibers

MLModule
genre FiberTracking
author Jan Klein
package FMEwork/Release
dll MLFiberUtils
definition MLFiberUtils.def
keywords DTI, tensor, save, fiber, file

Purpose

The module SaveFibers saves a fiber set or fiber set container. As file format, either the proprietary MeVisLab “fbr” format or the VTK polydata format can be chosen.

Usage

Connect any module with fiber output to the input of the module and choose filename and (optional) file format. In case of vtk polydata format, one has the option to flip all x, y, and/or z- components.

Windows

Default Panel

../../../Modules/ML/MLDiffusionMRI/MLFiberUtils/mhelp/Images/Screenshots/SaveFibers._default.png

Input Fields

inputFiberSet

name: inputFiberSet, type: FiberSetContainer::FiberSet/FiberSetContainer(MLBase)

Either a Fiber, FiberSet, or FiberSetContainer has to be connected to the input.

Parameter Fields

Field Index

&Save: Trigger Object Name: String
Auto save: Bool prog: Float
Base directory: String Status: String
File is up to date: Bool Use: Bool
File Name: String VTK polydata: Bool
flip x: Bool  
flip y: Bool  
flip z: Bool  

Visible Fields

&Save

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

If pressed, the module saves the attached fibers.

Status

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

Shows status information about this module.

File Name

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

Sets the filename under which the fibers should be saved to disk.

Use

name: useBaseDir, type: Bool, default: FALSE

If checked, the Base directory is used in generating the filename.

Base directory

name: baseDir, type: String

Sets an optional base directory where the fibers are saved to.

Object Name

name: nodeName, type: String, default: BaseObject

Sets the name of the (object) file.

Auto save

name: autoSave, type: Bool, default: FALSE

If checked, the module saved anew on changing any parameter or input.

File is up to date

name: upToDate, type: Bool, default: FALSE

Shows whether the file is up to date.

VTK polydata

name: vtkPolydata, type: Bool, default: FALSE

Optional, fibers can be stored as VTK polydata format.

flip x

name: xFlip, type: Bool, default: FALSE

If true, all x-components of all fibers are multiplied by -1.

flip y

name: yFlip, type: Bool, default: FALSE

If true, all y-components of all fibers are multiplied by -1.

flip z

name: zFlip, type: Bool, default: FALSE

If true, all z-components of all fibers are multiplied by -1.

Hidden Fields

prog

name: prog, type: Float, default: 0