CSOVolume

MLModule

genre	CSOModule
author	Jan Hendrik Moltz
package	FMEwork/ReleaseMeVis
dll	MLCSOMiscModules
definition	MLCSOMiscModules.def
see also	CalculateVolume
keywords	volumetry, area, sum

Purpose

Computes the volume of an object defined by CSOs on all slices.

Usage

Connect a CSOList and the image on which the CSOs were created. Press update if autoUpdate is not enabled.

Details

The CSOList has to fulfill the following requirements: it must not be empty, all CSOs must be closed and parallel. The CSOList should contain a single object to be measured. Use a CSOFilter module if necessary. The result is the sum of all CSO areas, multiplied by the slice thickness. The slice thickness is inferred from the voxel size of the input image and the plane normal of the CSOs. If CSOs are embedded into each other, CSOs with odd level of embedding are considered as holes and have a negative contribution to the volume.

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

Image on which the CSOs were drawn, used to infer the slice thickness.

inCSOList0

name: inCSOList0, type: MLBase

CSOList representing the object to be measured.

Parameter Fields

Field Index

[]: Trigger

Clear: Trigger

Has Valid Output: Bool

On Input Change Behavior: Enum

Status Code: Enum

Status Message: String

Update: Trigger

Volume (in ml): Double

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: shouldUpdateAutomatically,shouldAutoUpdate

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).

Volume (in ml)

name: outVolume, type: Double, persistent: no

The sum of areas of the CSOs, multiplied by the voxel size along the CSOs’ plane normals, given in ml.