FiberCache

MLModule

genre	FiberTracking
author	Jan Klein
package	FMEwork/Release
dll	MLFiberUtils
definition	MLFiberUtils.def
see also	FiberInfo, FiberSetContainerToFiberSet, FiberSetToFiberSetContainer
keywords	DTI, tensor, fiber, cache, buffer

Purpose

The module FiberCache serves as a storage container for objects of type FiberSet.

Additionally, it allows to modify the FiberSet attributes label, color and visibility. Once an object is inserted into the cache, it is copied into an internal container. Thus, all objects in the FiberCache remain valid, even if the input objects are deleted.

Details

This module wraps the functionality of a FiberSetContainer into a module. The FiberSetContainer internally uses a map to store and retrieve objects. Therefore, each object that is inserted requires a key to allow later retrieval. To simulate the behavior of a list, the FiberCache offers the possibility to automatically assign unique integer-based keys for all objects.

The content of the FiberCache is displayed in a list. The check boxes allow to toggle the visibility of a FiberSet. Optionally, the key of each FiberSet can be displayed in the list. When selecting objects in the list, the key of the selected FiberSet is copied to the field Key.

FiberSets can be deleted either by key, or by their visibility status.

Windows

Default Panel

Input Fields

inputFibers

name: inputFibers, type: MLBase

Object of type FiberSet or FiberSetContainer.

Output Fields

outputFiberSetContainer

name: outputFiberSetContainer, type: MLBase

A FiberSetContainer representing the content of the FiberCache.

outputSelectedFiberSet

name: outputSelectedFiberSet, type: MLBase

The currently selected FiberSet as specified by the current Key. None, if Key is empty.

Parameter Fields

Field Index

Allow to overwrite existing objects: Bool	Color: Color	Number of all Fibers: Integer
Apply Color: Trigger	Incremental Labeling: Bool	Number of FiberSets: Integer
Apply Label: Trigger	insertEmptyFiberSet: Trigger	Overwrite Container Attributes: Bool
applyVisibility: Trigger	internalKeys: String	Overwrite FiberSet attributes: Bool
Auto Update: Bool	isVisible: Bool	Show key: Bool
Automatic key: Bool	Keep original attributes when overwriting: Bool	toggleString: String
Clear All: Trigger	Key: String	Update: Trigger
Clear by Key: Trigger	Label / Index: String	Use keys of input FiberSetContainer: Bool
Clear Off: Trigger	Label Index: Integer
Clear On: Trigger	List String: String

Visible Fields

Clear All

name: clearAll, type: Trigger

If pressed, all fiber sets in the cache are deleted.

Clear by Key

name: clearByKey, type: Trigger

If pressed, the fibers specified by Key are deleted from the cache.

Clear On

name: clearVisible, type: Trigger

If pressed, all visible fibers are deleted from the cache.

Clear Off

name: clearInvisible, type: Trigger

If pressed, all invisible fibers are deleted from the cache.

Number of FiberSets

name: numberOfFiberSets, type: Integer, persistent: no

Shows the number of fibers sets in the cache.

Number of all Fibers

name: numberOfFibers, type: Integer, persistent: no

Shows the number of fibers in the cache.

Automatic key

name: automaticKey, type: Bool, default: TRUE

If checked, the keys are generated automatically.

Key

name: key, type: String

Sets the list of keys that define the active fiber sets.

Allow to overwrite existing objects

name: allowOverwrite, type: Bool, default: TRUE

If checked, new fibers are allowed to overwrite fiber that are already stored in the cache.

Otherwise, an attempted double entry is ignored so that the first fiber stays in the cache.

Keep original attributes when overwriting

name: keepAttributes, type: Bool, default: TRUE

If checked, the attributes of a previous fiber are saved when the fiber is being overwritten.

Use keys of input FiberSetContainer

name: useInputKeys, type: Bool, default: FALSE

If checked, the keys provided by the input fiber set container are used for caching.

Otherwise, new keys may be generated automatically.

This option works only if the input is a fiber set container.

Incremental Labeling

name: incrementalLabeling, type: Bool, default: TRUE

If checked, an incrementing integer is attached to the label.

Note that the label does not need to be unique, unlike the key.

Label Index

name: labelIndex, type: Integer, default: 0

Sets a label index that is used with the label of a fiber set.

Color

name: color, type: Color, default: 0 0 0

Sets the color attribute of the active fiber set.

Label / Index

name: label, type: String, default: FiberSet

Sets a string label to the active fiber set(s).

Apply Color

name: applyColor, type: Trigger

If pressed, the chosen color is set to the active fiber set(s).

Apply Label

name: applyLabel, type: Trigger

If pressed, the set label string (and index) is set to the active fiber set(s).

Overwrite Container Attributes

name: overwriteContainerAttributes, type: Bool, default: FALSE

If checked, the label and color attributes are set to new fiber set containers.

Overwrite FiberSet attributes

name: overwriteFiberSetAttributes, type: Bool, default: TRUE

If checked, the label and color attributes are set to new fiber sets.

List String

name: listString, type: String

Shows a string that is displayed in a list view, representing the active fiber sets.

Show key

name: showKey, type: Bool, default: FALSE

If checked, the keys of all fiber sets are shown.

Auto Update

name: autoUpdate, type: Bool, default: TRUE

If checked, the module computes anew on any input or parameter changes.

Update

name: update, type: Trigger

If pressed, the module computes anew.

Hidden Fields

insertEmptyFiberSet

name: insertEmptyFiberSet, type: Trigger

isVisible

name: isVisible, type: Bool, default: TRUE

applyVisibility

name: applyVisibility, type: Trigger

toggleString

name: toggleString, type: String

internalKeys

name: internalKeys, type: String