ImageAlignedBoundingBox

MacroModule

author	Torben Paetz
package	FMEstable/ReleaseMeVis
definition	ImageAlignedBoundingBox.def
see also	WorldAlignedBoundingBox
keywords	BoundingBox

Purpose

Calculates the image-aligned bounding box of the input image in world coordinates.

Usage

Connect input image and update module.

Windows

Default Panel

Input Fields

inImage

name: inImage, type: Image

Image for which the bounding box should be determined

Parameter Fields

Field Index

[]: Trigger	MaxX_MinY_MaxZ: Vector3	Status Code: Enum
BoxCenter: Vector3	MaxX_MinY_MinZ: Vector3	Status Message: String
BoxExtent: Vector3	MinX_MaxY_MaxZ: Vector3	Update: Trigger
Clear: Trigger	MinX_MaxY_MinZ: Vector3
doNotClearOnFailedUpdate: Bool	MinX_MinY_MaxZ: Vector3
Has Valid Output: Bool	MinX_MinY_MinZ: Vector3
MaxX_MaxY_MaxZ: Vector3	Mode: Enum
MaxX_MaxY_MinZ: Vector3	On Input Change Behavior: Enum

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

[]

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

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.

Mode

name: inMode, type: Enum, default: VoxelVolume

Defines what the bounding boxes should cover

Values:

Title	Name
Voxel Volume	VoxelVolume
Voxel Center	VoxelCenter
Lower Voxel Corner	LowerVoxelCorner
Upper Voxel Corner	UpperVoxelCorner

MinX_MinY_MinZ

name: outMinX_MinY_MinZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (x,y and z are minimum)

MinX_MinY_MaxZ

name: outMinX_MinY_MaxZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (x and y are minimum, z is maximum)

MinX_MaxY_MinZ

name: outMinX_MaxY_MinZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (x and z are minimum, y is maximum)

MaxX_MinY_MinZ

name: outMaxX_MinY_MinZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (y and z are minimum, x is maximum)

MinX_MaxY_MaxZ

name: outMinX_MaxY_MaxZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (x is minimum, y and z are maximum)

MaxX_MinY_MaxZ

name: outMaxX_MinY_MaxZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (y is minimum, x and z are maximum)

MaxX_MaxY_MinZ

name: outMaxX_MaxY_MinZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (z is minimum, x and y are maximum)

MaxX_MaxY_MaxZ

name: outMaxX_MaxY_MaxZ, type: Vector3, persistent: no

Corner coordinate of the image aligned bounding box (x,y and z are maximum)

BoxExtent

name: outBoxExtent, type: Vector3, persistent: no

Extent of the image aligned bounding box

BoxCenter

name: outBoxCenter, type: Vector3, persistent: no

Center of the image aligned bounding box

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.