Package org.anchoranalysis.image.bean.unitvalue.extent.volume

Class VolumePhysical

Object

AnchorBean<UnitValueExtent>

UnitValueExtent

UnitValueVolume

VolumePhysical

public class VolumePhysical
extends UnitValueVolume

Volume expressed in cubic meters, or units thereof.

Author:

Owen

Constructor Summary

Constructors

Constructor	Description
VolumePhysical()

Method Summary

Modifier and Type	Method	Description
String	getUnitType()	How much each value represents e.g. cubic nanometers, cubic millimeters etc.
double	getValue()	The volume in units of meters, with the unit described by unitType.
double	resolveToVoxels(Optional<UnitConverter> unitConverter)	Resolves a measurement of area/volume (in whatever units) to units corresponding to the image pixels/voxels.
void	setUnitType(String unitType)	How much each value represents e.g. cubic nanometers, cubic millimeters etc.
void	setValue(double value)	The volume in units of meters, with the unit described by unitType.
String	toString()	By default, we use AnchorBean.describeBean() as the string representation of the bean.

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VolumePhysical

public VolumePhysical()

Method Details

resolveToVoxels

public double resolveToVoxels(Optional<UnitConverter> unitConverter)
                       throws UnitValueException

Description copied from class: UnitValueExtent

Resolves a measurement of area/volume (in whatever units) to units corresponding to the image pixels/voxels.

Specified by:

resolveToVoxels in class UnitValueExtent

Parameters:

unitConverter - converts from voxelized units to different physical measurements of area / volume / distance.

Returns:

the resolved-value (pixels for area, voxels for volume).

Throws:

UnitValueException - if missing a UnitConverter, when needed for resolution.

toString

public String toString()

Description copied from class: AnchorBean

By default, we use AnchorBean.describeBean() as the string representation of the bean.

Overrides:

toString in class AnchorBean<UnitValueExtent>

Returns:

the string representation

getValue

public double getValue()

The volume in units of meters, with the unit described by unitType.

setValue

public void setValue(double value)

The volume in units of meters, with the unit described by unitType.

getUnitType

public String getUnitType()

How much each value represents e.g. cubic nanometers, cubic millimeters etc.

If unspecified, it describes meters (unsquared).

See SpatialUnits for acceptable string-values.

setUnitType

public void setUnitType(String unitType)

How much each value represents e.g. cubic nanometers, cubic millimeters etc.

If unspecified, it describes meters (unsquared).

See SpatialUnits for acceptable string-values.