CSOVoxelBox¶

MLModule¶

author	`Christian Kanthak`
package	`FMEstable/ReleaseMeVis`
dll	`MLCSOBox`
definition	CSOVoxelBox.def
keywords	`CSO`, `voxel`, `image`, `bounding`, `box`

Purpose¶

The module calculates an image axes aligned bounding box from a given CSOList.

The result consists of two 3-D vectors. They reflect the most minimal and maximal coordinates using image axes axes as reference coordinate system.

Please consider that CSOs only know world coordinates. Coordinates of t, u or c dimension are not treated.

An image axes aligned bounding box is often needed when the image axes of given input image differ from world coordinate axes. This difference occurs very often at MR images. That’s because an MR scanner allow to freely define image axes.

Usage¶

Connect a valid CSOList object and a related image. Press Update afterwards to initiate calculation.

Input Fields¶

input0¶

name: input0, type: Image¶: Input image related to CSOs.

inCSOList¶

name: inCSOList, type: MLBase¶: Input CSOs.

Parameter Fields¶

Field Index¶

`[]`: `Trigger`	`On Input Change Behavior`: `Enum`
`Clear`: `Trigger`	`Status Code`: `Enum`
`Convert coordinates to integers`: `Bool`	`Status Message`: `String`
`Does exceed image extent`: `Bool`	`Update`: `Trigger`
`doNotClearOnFailedUpdate`: `Bool`
`Has Valid Output`: `Bool`
`Maximum`: `Vector3`
`Minimum`: `Vector3`

Visible Fields¶

Update¶

name: update, type: Trigger¶: Initiates update of all output field values.

Clear¶

name: clear, type: Trigger¶: Clears all output field values to a clean initial state.

On Input Change Behavior¶

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldAutoUpdate,shouldUpdateAutomatically¶: Declares how the module should react if a value of an input field changes.

Values:

Title	Name	Deprecated Name
Update	Update	TRUE
Clear	Clear	FALSE

Status Code¶

name: statusCode, type: Enum, persistent: no¶: Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title	Name
Ok	Ok
Invalid input object	Invalid input object
Invalid input parameter	Invalid input parameter
Internal error	Internal error

Status Message¶

name: statusMessage, type: String, persistent: no¶: Gives additional, detailed information about status code as human-readable message.

Has Valid Output¶

name: hasValidOutput, type: Bool, persistent: no¶: Indicates validity of output field values (success of computation).

[]¶

name: updateDone, type: Trigger, persistent: no¶: Notifies that an update was performed (Check status interface fields to identify success or failure).

Minimum¶

name: outMinimum, type: Vector3, persistent: no¶: Minimum position.

Maximum¶

name: outMaximum, type: Vector3, persistent: no¶: Maximum position.

Convert coordinates to integers¶

name: inShouldConvertCoordinatesToIntegers, type: Bool, default: FALSE¶: Enables integer output coordinates.

Does exceed image extent¶

name: outDoesExceedImageExtent, type: Bool, persistent: no¶: Indicates if the calculated box exceeds extent of given input image.

Hidden Fields¶

doNotClearOnFailedUpdate¶

name: doNotClearOnFailedUpdate, type: Bool, persistent: no¶: Prevents automated clear after update failed. This does not affect status fields. It enables the developer to analyze module’s state after failure.