CalculateVoxelSum

MacroModule

genre	Statistics
author	Jan-Martin Kuhnigk
package	FMEstable/ReleaseMeVis
definition	CalculateVoxelSum.def
see also	ImageStatistics, CalculateVolume
keywords	sum, voxel, statistics, values

Purpose

Calculates the sum of all voxel values in the input image.

Usage

Connect to an input image and press update.

Details

Note that higher c,t,u dimensions are counted as well, so the sum is computed for the full (potentially 6D) image.

Windows

Default Panel

Input Fields

inImage

name: inImage, type: Image, deprecated name: input0

The input image.

Parameter Fields

Field Index

[]: Trigger

Clear: Trigger

Has Valid Output: Bool

On Input Change Behavior: Enum

Status Code: Enum

Status Message: String

Update: Trigger

Voxel Sum: 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,autoUpdate

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

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no, deprecated name: isValid

Indicates validity of output field values (success of computation).

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.

Voxel Sum

name: outVoxelSum, type: Double, persistent: no, deprecated name: voxelSum

Sum of all voxel values in the input image over all (up to 6) dimensions.