BoundingBoxWithMargin¶

MacroModule¶

genre	`Subimage`
authors	`Frank Heckel`, `Christian Kanthak`
package	`FMEstable/ReleaseMeVis`
definition	BoundingBoxWithMargin.def
see also	`BoundingBox`, `Info`, `ImagePropertyConvert`, `ImageStatistics`, `MinMaxScan`, `CalculateVolume`, `SubImage`
keywords	`bounding`, `box`, `volume`, `statistic`, `interval`, `count`, `voxels`, `volume`, `cut`, `reduce`, `reduction`, `roi`, `extract`, `BoundingBoxExt`

Purpose¶

Like the module :module:’BoundingBox’ this module scans the input image and calculates the bounding box of all voxels which are within a given gray level interval. In addition this module has an optional margin for each dimension that is added to the determined bounding box. The extended bounding box is cut from the input image and passed to the output. If the resulting sub image exceeds the input image the missing voxels are filled with a given gray level fill value. Also the number of found voxels in the interval, in the box and the corresponding volume in ml are shown.

Usage¶

See example network.

Windows¶

Default Panel¶

../../../Modules/Macros/Geometry/mhelp/Images/Screenshots/BoundingBoxWithMargin._default.png

Input Fields¶

inImage¶

name: inImage, type: Image¶: The image on which a bounding box should be computed.

Output Fields¶

outImage¶

name: outImage, type: Image¶: The extended bounding box. If the bounding box exceeds the input image the missing values will be filled with the given gray level fill value.

Parameter Fields¶

Field Index¶

`= (outObjectVolume)`: `Double`	`Extended Box World`: `String`	`Status Code`: `Enum`
`= (outExtendedBoxVolume)`: `Double`	`Extent`: `String`	`Status Message`: `String`
`[]`: `Trigger`	`Fill Value`: `Double`	`T`: `Integer`
`Always clamp to input image region`: `Bool`	`Has Valid Output`: `Bool`	`U`: `Integer`
`C`: `Integer`	`Max Value`: `Double`	`Update`: `Trigger`
`Clear`: `Trigger`	`Min Value`: `Double`	`X`: `Integer`
`Extended Box`: `String`	`Object Size`: `Integer`	`Y`: `Integer`
`Extended Box Size`: `Integer`	`On Input Change Behavior`: `Enum`	`Z`: `Integer`

Visible Fields¶

Min Value¶

name: inObjectMinimum, type: Double, default: 0, deprecated name: objectMin¶: The minimum limit of the interval which voxels must fullfil to be counted.

Max Value¶

name: inObjectMaximum, type: Double, default: 0, deprecated name: objectMax¶: The maximum limit of the interval which voxels must fullfil to be counted.

X¶

name: inMarginX, type: Integer, default: 0, deprecated name: marginX¶: The margin in voxels in x-dimension that is added to the bounding box of the object.

Y¶

name: inMarginY, type: Integer, default: 0, deprecated name: marginY¶: The margin in voxels in y-dimension that is added to the bounding box of the object.

Z¶

name: inMarginZ, type: Integer, default: 0, deprecated name: marginZ¶: The margin in voxels in z-dimension that is added to the bounding box of the object.

C¶

name: inMarginC, type: Integer, default: 0, deprecated name: marginC¶: The margin in voxels in c-dimension that is added to the bounding box of the object.

T¶

name: inMarginT, type: Integer, default: 0, deprecated name: marginT¶: The margin in voxels in t-dimension that is added to the bounding box of the object.

U¶

name: inMarginU, type: Integer, default: 0, deprecated name: marginU¶: The margin in voxels in u-dimension that is added to the bounding box of the object.

Fill Value¶

name: inFillValue, type: Double, default: 0, deprecated name: fillValue¶: Voxels in the bounding box that are outside of the input image are filled with this value.

Always clamp to input image region¶

name: inEnableBoxClamping, type: Bool, default: FALSE¶: If enabled, the input image can only be cropped, but never extended. Thus, the Fill Value has no effect in this case.

Extended Box¶

name: outExtendedBox, type: String, persistent: no, deprecated name: boundingBox¶: Shows both corners of the bounding box in voxel-coordinates which are still within the box.

Extended Box World¶

name: outExtendedBoxWorld, type: String, persistent: no, deprecated name: boundingBoxWorld¶: Shows both corners of the bounding box in world-coordinates which are still within the box.

Extent¶

name: outExtendedBoxExtent, type: String, persistent: no, deprecated name: boundingBoxExtent¶: The extent of the bounding box in voxels.

Object Size¶

name: outObjectVoxels, type: Integer, persistent: no, deprecated name: objectVoxels¶: The number of voxels found in the interval [minimum, maximum].

= (outObjectVolume)¶

name: outObjectVolume, type: Double, persistent: no, deprecated name: objectVolume¶: The total volume of all voxels in the interval [minimum, maximum] in ml.

Extended Box Size¶

name: outExtendedBoxVoxels, type: Integer, persistent: no, deprecated name: boxVoxels¶: The number of all voxels in the extended bounding box.

= (outExtendedBoxVolume)¶

name: outExtendedBoxVolume, type: Double, persistent: no, deprecated name: boxVolume¶: The total volume of all voxels in the extended bounding box in ml.

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¶: 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.