Package org.anchoranalysis.image.bean.unitvalue.distance

Class DistancePhysical

Object

org.anchoranalysis.bean.AnchorBean<UnitValueDistance>

org.anchoranalysis.image.bean.unitvalue.distance.UnitValueDistance

org.anchoranalysis.image.bean.unitvalue.distance.DistancePhysical

All Implemented Interfaces:

Serializable

public class DistancePhysical
extends UnitValueDistance

Implementation of UnitValueDistance that specifies a value in physical units, as described by particular recognized strings.

See SpatialUnits for the recognized strings.

Author:

Owen Feehan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DistancePhysical()

Method Summary

Modifier and Type	Method	Description
String	getUnitType()	A string indicating type of units to use, as per SpatialUnits.
double	getValue()	The value in units of type unitType.
double	resolve(Optional<UnitConverter> unitConverter, org.anchoranalysis.spatial.orientation.DirectionVector direction)	Resolves the distance using a DirectionVector.
void	setUnitType(String unitType)	A string indicating type of units to use, as per SpatialUnits.
void	setValue(double value)	The value in units of type unitType.

Methods inherited from class org.anchoranalysis.image.bean.unitvalue.distance.UnitValueDistance

resolve, resolve, resolveForAxis

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

DistancePhysical

public DistancePhysical()

Method Details

resolve

public double resolve(Optional<UnitConverter> unitConverter, org.anchoranalysis.spatial.orientation.DirectionVector direction) throws OperationFailedException

Description copied from class: UnitValueDistance

Resolves the distance using a DirectionVector.

The magnitude of the vector is ignored, using only the direction.

Specified by:

resolve in class UnitValueDistance

Parameters:

unitConverter - converts to/from voxels to physical units.

direction - the direction-vector.

Returns:

the distance in units of voxels.

Throws:

OperationFailedException - if the resolution cannot successfully complete.

getValue

public double getValue()

The value in units of type unitType.

setValue

public void setValue(double value)

The value in units of type unitType.

getUnitType

public String getUnitType()

A string indicating type of units to use, as per SpatialUnits.

setUnitType

public void setUnitType(String unitType)

A string indicating type of units to use, as per SpatialUnits.