BoundingBox¶
- MLModule¶
genre
author
package
dll
definition
see also
Info,ImagePropertyConvert,ImageStatistics,MinMaxScan,CalculateVolume,SubImagekeywords
volume,statistic,interval,count,voxels,volume,cut,reduce,reduction,roi,extract
Purpose¶
The module BoundingBox scans the input automatically or on demand, and calculates the bounding box of all voxels which are within a given gray level interval. The found bounding box is cut from the input image and passed to the output. Also, the number of found voxels in the interval, in the box, and the corresponding volume in ml is shown.
This module only works on scalar voxel types.
If no voxels in the bounding box are found, the output image is empty, i.e., it has extent 0.
All voxels of the output image will have the same world coordinates as in the input image.
Details¶
Example¶
The example network shows a small medical data set with a segmented liver, which has much higher voxel values. The bounding box module is used to scan the volume, determine the bounding box around the liver, and to show only the liver at the output.
Windows¶
Default Panel¶
Input Fields¶
input0¶
- name: input0, type: Image¶
Output Fields¶
output0¶
- name: output0, type: Image¶
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Visible Fields¶
Bounding Box¶
- name: boundingBox, type: String, persistent: no¶
Shows both corners of the bounding box that are still within the box.
If not defined, the values are (0, 0, 0, 0, 0, 0) and (-1, -1, -1, -1, -1, -1).
Extent¶
- name: boundingBoxExtent, type: IntVector6, persistent: no¶
Shows the extent of the bounding box in voxels.
If the bounding box is empty, the value is (0, 0, 0, 0, 0, 0).
Use (useMin)¶
- name: useMin, type: Bool, default: TRUE¶
Use
minimum voxel value.
Use (useMax)¶
- name: useMax, type: Bool, default: FALSE¶
Use
maximum voxel value.
Min Value¶
- name: objectMin, type: Double, default: 1, deprecated name: IntMin¶
Sets the minimum voxel value. Only used if
Use Min Valueis true.
Max Value¶
- name: objectMax, type: Double, default: 1, deprecated name: IntMax¶
Sets the maximum voxel value. Only used if
Use Max Valueis true.
Update Mode¶
- name: updateMode, type: Enum, default: AutoUpdate, deprecated name: AutoCompute¶
Defines how module reacts to input changes.
Values:
Title |
Name |
Deprecated Name |
Description |
|---|---|---|---|
Update |
AutoUpdate |
TRUE |
The module updates its output on any input or field change. |
Clear |
AutoClear |
FALSE,Off |
The module invalidates its output on any input or field change. |
Update¶
- name: update, type: Trigger, deprecated name: CalcBox,Calculate¶
When pressed, the module updates its output.
Up To Date¶
- name: upToDate, type: Bool, persistent: no, deprecated name: ResultsValid¶
Shows whether the module’s output is up-to-date.
Object Size¶
= (objectVolume)¶
Box Size¶
= (boxVolume)¶
- name: boxVolume, type: Double, persistent: no, deprecated name: boxVol¶
Shows the volume of voxels in ml within the entire output box.