icy.math

Class UnitUtil

java.lang.Object

icy.math.UnitUtil

public class UnitUtil
extends java.lang.Object

Unit conversion utilities class.

Author:

Thomas Provoost & Stephane Dallongeville

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnitUtil.UnitPrefix

Field Summary

Fields

Modifier and Type	Field and Description
static char	MICRO_CHAR Constants for special characters
static java.lang.String	MICRO_STRING

Constructor Summary

Constructors

Constructor and Description
UnitUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	displayTimeAsStringWithComma(double valueInMs, int precision) Display the time with a comma and a given precision.
static java.lang.String	displayTimeAsStringWithComma(double valueInMs, int precision, java.util.concurrent.TimeUnit unit) Display the time with a comma and a given precision.
static java.lang.String	displayTimeAsStringWithUnits(double valueInMs, boolean displayZero) Display the time with all the units.
static java.util.concurrent.TimeUnit	getBestTimeUnit(double valueInMs) Return the best unit to display the value.
static java.util.concurrent.TimeUnit	getBestUnit(double valueInMs) Deprecated. Use getBestTimeUnit(double) instead.
static UnitUtil.UnitPrefix	getBestUnit(double value, UnitUtil.UnitPrefix currentUnit) Get the best unit with the given value and UnitUtil.UnitPrefix.
static UnitUtil.UnitPrefix	getBestUnit(double value, UnitUtil.UnitPrefix currentUnit, int dimension) Get the best unit with the given value and UnitUtil.UnitPrefix.
static java.lang.String	getBestUnitInMeters(double value, int decimals, UnitUtil.UnitPrefix currentUnit) This method returns a string containing the value rounded to a specified number of decimals and its best unit prefix.
static java.lang.String	getBytesString(double value) Return the specified value as "bytes" string : 1024 --> "1 KB" 1024*1000 --> "1 MB" 1024*1000*1000 --> "1 GB" ...
static double	getValueInUnit(double value, UnitUtil.UnitPrefix currentUnit, UnitUtil.UnitPrefix wantedUnit) Return the value from a specific unit to another unit.
static double	getValueInUnit(double value, UnitUtil.UnitPrefix currentUnit, UnitUtil.UnitPrefix wantedUnit, int dimension) Return the value from a specific unit to another unit.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MICRO_CHAR

public static final char MICRO_CHAR

Constants for special characters

See Also:

Constant Field Values

MICRO_STRING

public static final java.lang.String MICRO_STRING

See Also:

Constant Field Values

Constructor Detail

UnitUtil

public UnitUtil()

Method Detail

getBytesString

public static java.lang.String getBytesString(double value)

Return the specified value as "bytes" string :
1024 --> "1 KB"
1024*1000 --> "1 MB"
1024*1000*1000 --> "1 GB"
...

getBestUnit

public static UnitUtil.UnitPrefix getBestUnit(double value,
                              UnitUtil.UnitPrefix currentUnit,
                              int dimension)

Get the best unit with the given value and UnitUtil.UnitPrefix.
By best unit we adapt the output unit so the value stay between 0.1 --> 100 range (for dimension 1).
Be careful, this method is supposed to be used with unit in decimal system. For sexagesimal system, please use getBestTimeUnit(double) or TimeUnit methods.

Example: getBestUnit(0.01, UnitPrefix.MILLI, 1) will return UnitPrefix.MICRO

Parameters:

value - : value used to get the best unit.

currentUnit - : current unit of the value.

dimension - : current unit dimension.

Returns:

Return the best unit

See Also:

getValueInUnit(double, UnitPrefix, UnitPrefix)

getBestUnit

public static UnitUtil.UnitPrefix getBestUnit(double value,
                              UnitUtil.UnitPrefix currentUnit)

Get the best unit with the given value and UnitUtil.UnitPrefix. By best unit we adapt the output unit so the value stay between 0.1 --> 100 range (for dimension 1).
Be careful, this method is supposed to be used with unit in decimal system. For sexagesimal system, please use getBestTimeUnit(double) or TimeUnit methods.
Example: getBestUnit(0.01, UnitPrefix.MILLI, 1) will return UnitPrefix.MICRO

Parameters:

value - : value used to get the best unit.

currentUnit - : current unit of the value.

Returns:

Return the best unit

See Also:

getValueInUnit(double, UnitPrefix, UnitPrefix)

getValueInUnit

public static double getValueInUnit(double value,
                    UnitUtil.UnitPrefix currentUnit,
                    UnitUtil.UnitPrefix wantedUnit,
                    int dimension)

Return the value from a specific unit to another unit.
Be careful, this method is supposed to be used with unit in decimal system. For sexagesimal system, please use getBestTimeUnit(double) or TimeUnit methods.
Example:

• value = 0.01
• currentUnit = UnitUtil.UnitPrefix.MILLI
• wantedUnit = UnitUtil.UnitPrefix.MICRO
• returns: 10

Parameters:

value - : Original value.

currentUnit - : current unit

wantedUnit - : wanted unit

dimension - : unit dimension.

Returns:

Return a double value in the wantedUnit unit.

See Also:

getBestUnit(double, UnitPrefix)

getValueInUnit

public static double getValueInUnit(double value,
                    UnitUtil.UnitPrefix currentUnit,
                    UnitUtil.UnitPrefix wantedUnit)

Return the value from a specific unit to another unit.
Be careful, this method is supposed to be used with unit in decimal system. For sexagesimal system, please use getBestTimeUnit(double) or TimeUnit methods.
Example:

• value = 0.01
• currentUnit = UnitUtil.UnitPrefix.MILLI
• wantedUnit = UnitUtil.UnitPrefix.MICRO
• returns: 10

Parameters:

value - : Original value.

currentUnit - : current unit

wantedUnit - : wanted unit

Returns:

Return a double value in the wantedUnit unit.

See Also:

getBestUnit(double, UnitPrefix)

getBestUnitInMeters

public static java.lang.String getBestUnitInMeters(double value,
                                   int decimals,
                                   UnitUtil.UnitPrefix currentUnit)

This method returns a string containing the value rounded to a specified number of decimals and its best unit prefix. This method is supposed to be used with meters only.

Parameters:

value - : value to display

decimals - : number of decimals to keep

currentUnit - : current unit prefix (Ex: UnitUtil.UnitPrefix.MILLI)

getBestTimeUnit

public static java.util.concurrent.TimeUnit getBestTimeUnit(double valueInMs)

Return the best unit to display the value. The best unit is chosen according to the precision.
Example:

• 62001 ms -> TimeUnit.MILLISECONDS
• 62000 ms -> TimeUnit.SECONDS
• 60000 ms -> TimeUnit.MINUTES

Parameters:

valueInMs - : value in milliseconds.

Returns:

Return a TimeUnit enumeration value.

getBestUnit

@Deprecated
public static java.util.concurrent.TimeUnit getBestUnit(double valueInMs)

Deprecated. Use getBestTimeUnit(double) instead.

displayTimeAsStringWithComma

public static java.lang.String displayTimeAsStringWithComma(double valueInMs,
                                            int precision,
                                            java.util.concurrent.TimeUnit unit)

Display the time with a comma and a given precision.

Parameters:

valueInMs - : value in milliseconds

precision - : number of decimals after comma

Returns:

Example: "2.5 h", "1.543 min", "15 ms".

displayTimeAsStringWithComma

public static java.lang.String displayTimeAsStringWithComma(double valueInMs,
                                            int precision)

Display the time with a comma and a given precision.

Parameters:

valueInMs - : value in milliseconds

precision - : number of decimals after comma

Returns:

Example: "2.5 h", "1.543 min", "15 ms".

displayTimeAsStringWithUnits

public static java.lang.String displayTimeAsStringWithUnits(double valueInMs,
                                            boolean displayZero)

Display the time with all the units.

Parameters:

valueInMs - : value in milliseconds

displayZero - : Even if a unit is not relevant (equals to zero), it will be displayed.

Returns:

Example: "2h 3min 40sec 350ms".