CalculateVolume¶
- MLModule¶
genre
author
package
dll
definition
see also
Info,ImagePropertyConvert,ImageStatistics,MinMaxScan,BoundingBox,SoDiagram2Dkeywords
minimum,maximum,statistic,interval,4D,dynamic,count,voxels,size
Purpose¶
The module CalculateVolume scans the input and counts all voxels that are within a given interval.
Usage¶
The voxel number and the voxel number multiplied with the voxel size (i.e., the volume in microliters, milliliters, or liters) is given as result.
Also a factor can be specified to support changes to other units, e.g., from milliliters to gallons.
Details¶
For 4D images, the time curve / sequence of volumes is given as ml.CurveData to output and can be visualized, e.g., using a SoDiagram2D module.
Windows¶
Default Panel¶
Input Fields¶
input0¶
- name: input0, type: Image¶
Output Fields¶
outTimeCurve¶
- name: outTimeCurve, type: CurveData(MLBase), deprecated name: outputTimeCurve¶
For accessing this object via scripting, see the Scripting Reference:
MLCurveDataWrapper.
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Visible Fields¶
Min¶
- name: minMode, type: Enum, default: UserDefined¶
Defines the minimum value mode.
Values:
Title |
Name |
Deprecated Name |
Description |
|---|---|---|---|
User Defined |
UserDefined |
user defined |
A user-defined value can be set in |
Image Min |
ImageMin |
image min |
The image’s static minimum value is set as the lower bound. |
User Def. (intMin)¶
Max¶
- name: maxMode, type: Enum, default: ImageMax¶
Defines the maximum value mode.
Values:
Title |
Name |
Deprecated Name |
Description |
|---|---|---|---|
User Defined |
UserDefined |
user defined |
A user-defined value can be set in |
Image Max |
ImageMax |
image max |
The image’s static maximum value is set as the upper bound. |
User Def. (intMax)¶
Auto Update¶
- name: autoUpdate, type: Bool, default: TRUE, deprecated name: autoCompute¶
If checked, the module computes anew on any field or input change.
Update¶
- name: update, type: Trigger, deprecated name: calculateVolume¶
When pressed, the module computes anew.
Unit¶
- name: unit, type: Enum, default: Milliliters¶
Defines a unit for the volume output.
Values:
Title |
Name |
Deprecated Name |
|---|---|---|
Voxels |
Voxels |
voxels (numvox) |
Microliters (mm^3) |
Microliters |
microliters (mm^3) |
Milliliters (ml) |
Milliliters |
milliliters (ml) |
Liters (l) |
Liters |
liters (l) |
Factor * Voxels |
FactorTimesVoxels |
factor * numvox |
Factor * mm^3 |
FactorTimesMicroliters |
factor * mm^3 |
Factor¶
- name: factor, type: Double, default: 1¶
Sets a factor that is multiplied with all results.
Total Volume¶
- name: totalVolume, type: Double, persistent: no¶
Shows the total volume.
No of Timepoints¶
- name: numTimepoints, type: Integer, persistent: no¶
Shows the number of time points.
Min. Timepoint¶
- name: minTimepoint, type: Integer, persistent: no¶
Shows the time point with the least amount of voxels.
Volume (minTimepointVolume)¶
- name: minTimepointVolume, type: Double, persistent: no¶
Shows the amount of voxels in the time point with the least amount of voxels.
Max. Timepoint¶
- name: maxTimepoint, type: Integer, persistent: no¶
Shows the time point with the largest amount of voxels.
Volume (maxTimepointVolume)¶
- name: maxTimepointVolume, type: Double, persistent: no¶
Shows the amount of voxels in the time point with the largest amount of voxels.
User Timepoint¶
- name: userTimepoint, type: Integer, default: 0¶
Sets a specific time point for evaluation.
Volume (userTimepointVolume)¶
- name: userTimepointVolume, type: Double, persistent: no¶
Shows the amount of voxels in the user defined time point.
Type¶
- name: curveType, type: Enum, default: Line¶
Defines the type of output curve.
Values:
Title |
Name |
Deprecated Name |
|---|---|---|
Line |
Line |
line |
Area |
Area |
area |
Style¶
- name: curveStyle, type: Integer, default: 0¶
Sets the line style for the output curve.