CalculateVolume

MLModule

genre	Volumetry
status	stable
authors	Horst Hahn, Wolf Spindler
package	MeVisLab/Standard
dll	MLVolumetry
definition	MLVolumetry.def
see also	Info, ImagePropertyConvert, ImageStatistics, MinMaxScan, BoundingBox, Diagram2D
keywords	calculate, minimum, maximum, volume, statistic, interval, 4d, dynamic, count, voxels, size, CalcVolume

Purpose

The module CalculateVolume scans the input and counts all voxels which 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 Diagram2D module.

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

Output Fields

outTimeCurve

name: outTimeCurve, type: MLBase, deprecated name: outputTimeCurve

Parameter Fields

Field Index

Auto Update: Bool	Style: Integer	Volume (minTimepointVolume): Double
Factor: Double	Total Volume: Double	Volume (maxTimepointVolume): Double
Max: Enum	Type: Enum	Volume (userTimepointVolume): Double
Max. Timepoint: Integer	Unit: Enum
Min: Enum	Update: Trigger
Min. Timepoint: Integer	User Def. (intMin): Double
No of Timepoints: Integer	User Def. (intMax): Double
resultsValid: Bool	User Timepoint: Integer

Visible Fields

Min

name: minMode, type: Enum, default: UserDefined

Defines the minimum value mode.

Values:

Title	Name	Description
User Defined	UserDefined	A user defined value can be set in User Def..
Image Min	ImageMin	The image's static minimum value is set as the lower bound.

User Def. (intMin)

name: intMin, type: Double, default: 1

Sets a user defined minimum value.

Used if Min is set to UserDefined.

Max

name: maxMode, type: Enum, default: ImageMax

Defines the maximum value mode.

Values:

Title	Name	Description
User Defined	UserDefined	A user defined value can be set in User Def..
Image Max	ImageMax	The image's static maximum value is set as the upper bound.

User Def. (intMax)

name: intMax, type: Double, default: 255

Sets a user defined maximum value.

Used if Max is set to UserDefined.

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

If 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
Milliliters (ml)	Milliliters
Liters (l)	Liters
Factor * Voxels	FactorTimesVoxels
Factor * mm^3	FactorTimesMicroliters

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, default: 0

Shows the number of time points.

Min. Timepoint

name: minTimepoint, type: Integer, default: 0

Shows the time point with the least amount of voxels.

Volume (minTimepointVolume)

name: minTimepointVolume, type: Double, default: 0

Shows the amount of voxels in the time point with the least amount of voxels.

Max. Timepoint

name: maxTimepoint, type: Integer, default: 0

Shows the time point with the largest amount of voxels.

Volume (maxTimepointVolume)

name: maxTimepointVolume, type: Double, default: 0

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, default: 0

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.

Hidden Fields

resultsValid

name: resultsValid, type: Bool, default: FALSE