public class SpatialUnits extends Object
These units can be specified by a string or an enum.
e.g. find a enum for nm.
e.g. find a string representation for NANO.
Acceptable string representations are: m, mm, mm^2, mm^3, nm, nm^2, nm^3, μm, μm^2,
μm^3
.
Modifier and Type | Class and Description |
---|---|
static class |
SpatialUnits.UnitSuffix
Suffix that describes a particular quantity of units (micron, nano, square microns etc.)
|
Modifier and Type | Method and Description |
---|---|
static double |
convertFromUnits(double valueUnits,
SpatialUnits.UnitSuffix unitSuffix)
Converts a value from another unit-type to base units.
|
static double |
convertFromUnits(double valueUnits,
String unitSuffix)
Converts a value from another unit-type to base units.
|
static double |
convertToUnits(double valueBaseUnits,
SpatialUnits.UnitSuffix unitSuffix)
Converts a value in base-units to another unit-type.
|
static double |
convertToUnits(double valueBaseUnits,
String unitSuffix)
Converts a value in base-units to another unit-type.
|
static String |
suffixStringForMeters(SpatialUnits.UnitSuffix suffix)
A string that describes the suffix for meters.
|
public static String suffixStringForMeters(SpatialUnits.UnitSuffix suffix)
e.g. m^2
or nm^3
etc.
suffix
- the suffix to describe.public static double convertToUnits(double valueBaseUnits, String unitSuffix)
valueBaseUnits
- the value in base units.unitSuffix
- the suffix describing the desired unit.public static double convertToUnits(double valueBaseUnits, SpatialUnits.UnitSuffix unitSuffix)
valueBaseUnits
- the value in base units.unitSuffix
- the suffix describing the desired unit.public static double convertFromUnits(double valueUnits, String unitSuffix)
valueUnits
- the value in base units.unitSuffix
- the suffix associated with valueUnits
.public static double convertFromUnits(double valueUnits, SpatialUnits.UnitSuffix unitSuffix)
valueUnits
- the value in base units.unitSuffix
- the suffix associated with valueUnits
.Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.