net.imagej.units

Interface UnitService

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, ImageJService, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, Service, Versioned

All Known Implementing Classes:

DefaultUnitService

public interface UnitService
extends ImageJService

Service for defining units and making unit conversions.

Author:

Barry DeZonia

Method Summary

Modifier and Type	Method and Description
void	defineUnit(String unitName, String baseUnit, Calibrator calibrator) Defines a unit conversion that can be referred to via the value() method.
void	defineUnit(String unitName, String baseUnit, double scale) Defines a unit conversion that can be referred to via the value() method.
void	defineUnit(String unitName, String baseUnit, double scale, double offset) Defines a unit conversion that can be referred to via the value() method.
double	value(double inputValue, String inputUnit, String outputUnit) Returns a value after conversion between two compatible types of units.

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

value

double value(double inputValue,
             String inputUnit,
             String outputUnit)

Returns a value after conversion between two compatible types of units. Each unit can be a compound unit string. For instance "inch" or "kg*m/s" or "pounds/inch^2", "km/hour**2", etc. Returns the number of output unit values represented by the number of input values of input type. Returns Double.NaN if the unit types are incompatible.

Parameters:

inputValue - The double representing the number of input units.

inputUnit - The string representing the input unit.

outputUnit - The string representing the output unit.

Returns:

The value in output units after converting the inputValue from input units.

Throws:

IllegalArgumentException - if conversion fails with the given arguments (e.g., if the units are incompatible).

defineUnit

void defineUnit(String unitName,
                String baseUnit,
                double scale)

Defines a unit conversion that can be referred to via the value() method. Note that baseUnit is not necessarily a name. It could be a compound unit string like "m/s^2" etc. Imagine we define a unit called "fliggs" that is 14.2 m/s^2.

Parameters:

unitName - The name of the unit being defined e.g. "fliggs".

baseUnit - The unit the defined unit is based upon e.g. "m/s^2".

scale - The ratio of defined units to base units e.g. 14.2.

defineUnit

void defineUnit(String unitName,
                String baseUnit,
                double scale,
                double offset)

Defines a unit conversion that can be referred to via the value() method. Note that baseUnit is not necessarily a name. It could be a compound unit string like "m/s^2" etc. Imagine we define a unit called "fliggs" that is 14.2 m/s^2 offset by 3.3 from baseUnit. An example of an offset is the 32 used in conversion between celsius and fahrenheit.

Parameters:

unitName - The name of the unit being defined e.g. "fliggs".

baseUnit - The unit the defined unit is based upon e.g. "m/s^2".

scale - The ratio of defined units to base units e.g. 14.2.

offset - The offset of defined units to base units e.g. 3.3.

defineUnit

void defineUnit(String unitName,
                String baseUnit,
                Calibrator calibrator)

Defines a unit conversion that can be referred to via the value() method. Note that baseUnit is not necessarily a name. It could be a compound unit string like "m/s^2" etc. Imagine we define a unit called "fliggs" that has a nonlinear conversion from baseUnit. One supplies a Calibrator that handles conversion. The Calibrator allows any kind of conversion between units including nonlinear ones (i.e. can support log units).

Parameters:

unitName - The name of the unit being defined e.g. "fliggs".

baseUnit - The unit the defined unit is based upon e.g. "m/s^2".

calibrator - The Calibrator the maps between the two unit spaces.