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

Class UnitValueExtent

Object

AnchorBean<UnitValueExtent>

UnitValueExtent

Direct Known Subclasses:

UnitValueArea, UnitValueVolume

public abstract class UnitValueExtent
extends AnchorBean<UnitValueExtent>

A base class for a value that describes an area or volume measurement, which can then be resolved to a number of voxels.

Author:

Owen

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnitValueExtent()

Method Summary

Modifier and Type	Method	Description
abstract double	resolveToVoxels(Optional<UnitConverter> unitConverter)	Resolves a measurement of area/volume (in whatever units) to units corresponding to the image pixels/voxels.

Methods inherited from class org.anchoranalysis.bean.AnchorBean

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

Methods inherited from class java.lang.Object

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

Constructor Details

UnitValueExtent

protected UnitValueExtent()

Method Details

resolveToVoxels

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

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

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.