<h2>org.das2.datum.Units</h2><p>Class for indicating physical units, and other random units.</p>
<hr>
<a name="dimensionless"></a>
<h2>dimensionless</h2>
<p></p>

<hr>
<a name="radians"></a>
<h2>radians</h2>
<p></p>

<hr>
<a name="degrees"></a>
<h2>degrees</h2>
<p></p>

<hr>
<a name="deg"></a>
<h2>deg</h2>
<p></p>

<hr>
<a name="degrees2"></a>
<h2>degrees2</h2>
<p></p>

<hr>
<a name="rgbColor"></a>
<h2>rgbColor</h2>
<p>It's often enough that we just want to paint data with a particular color that 
 there's a special unit which is used to trigger a branch, and the color will
 be used.  This can have an alpha channel as well in the high byte, but zero will imply that the
 alpha channel is missing and opaque will be used.</p>

<hr>
<a name="celciusDegrees"></a>
<h2>celciusDegrees</h2>
<p></p>

<hr>
<a name="fahrenheitDegrees"></a>
<h2>fahrenheitDegrees</h2>
<p></p>

<hr>
<a name="years"></a>
<h2>years</h2>
<p></p>

<hr>
<a name="days"></a>
<h2>days</h2>
<p></p>

<hr>
<a name="hours"></a>
<h2>hours</h2>
<p></p>

<hr>
<a name="hours2"></a>
<h2>hours2</h2>
<p></p>

<hr>
<a name="minutes"></a>
<h2>minutes</h2>
<p></p>

<hr>
<a name="seconds"></a>
<h2>seconds</h2>
<p></p>

<hr>
<a name="seconds2"></a>
<h2>seconds2</h2>
<p></p>

<hr>
<a name="milliseconds"></a>
<h2>milliseconds</h2>
<p></p>

<hr>
<a name="milliseconds2"></a>
<h2>milliseconds2</h2>
<p></p>

<hr>
<a name="microseconds"></a>
<h2>microseconds</h2>
<p></p>

<hr>
<a name="microseconds2"></a>
<h2>microseconds2</h2>
<p></p>

<hr>
<a name="microseconds3"></a>
<h2>microseconds3</h2>
<p></p>

<hr>
<a name="nanoseconds"></a>
<h2>nanoseconds</h2>
<p></p>

<hr>
<a name="ns"></a>
<h2>ns</h2>
<p></p>

<hr>
<a name="picoseconds"></a>
<h2>picoseconds</h2>
<p></p>

<hr>
<a name="bytesPerSecond"></a>
<h2>bytesPerSecond</h2>
<p></p>

<hr>
<a name="kiloBytesPerSecond"></a>
<h2>kiloBytesPerSecond</h2>
<p></p>

<hr>
<a name="bytes"></a>
<h2>bytes</h2>
<p></p>

<hr>
<a name="kiloBytes"></a>
<h2>kiloBytes</h2>
<p></p>

<hr>
<a name="hertz"></a>
<h2>hertz</h2>
<p></p>

<hr>
<a name="kiloHertz"></a>
<h2>kiloHertz</h2>
<p></p>

<hr>
<a name="megaHertz"></a>
<h2>megaHertz</h2>
<p></p>

<hr>
<a name="gigaHertz"></a>
<h2>gigaHertz</h2>
<p></p>

<hr>
<a name="eV"></a>
<h2>eV</h2>
<p></p>

<hr>
<a name="ev"></a>
<h2>ev</h2>
<p></p>

<hr>
<a name="keV"></a>
<h2>keV</h2>
<p></p>

<hr>
<a name="MeV"></a>
<h2>MeV</h2>
<p></p>

<hr>
<a name="pcm3"></a>
<h2>pcm3</h2>
<p>1 / cm<sup>3</sup></p>

<hr>
<a name="kelvin"></a>
<h2>kelvin</h2>
<p></p>

<hr>
<a name="cm_2s_1keV_1"></a>
<h2>cm_2s_1keV_1</h2>
<p></p>

<hr>
<a name="cm_2s_1MeV_1"></a>
<h2>cm_2s_1MeV_1</h2>
<p></p>

<hr>
<a name="v2pm2Hz"></a>
<h2>v2pm2Hz</h2>
<p>Volts <sup>2</sup> m<sup>-2</sup> Hz<sup>-1</sup></p>

<hr>
<a name="wpm2"></a>
<h2>wpm2</h2>
<p>Watts / m<sup>2</sup></p>

<hr>
<a name="meters"></a>
<h2>meters</h2>
<p></p>

<hr>
<a name="millimeters"></a>
<h2>millimeters</h2>
<p></p>

<hr>
<a name="centimeters"></a>
<h2>centimeters</h2>
<p></p>

<hr>
<a name="kiloMeters"></a>
<h2>kiloMeters</h2>
<p></p>

<hr>
<a name="inches"></a>
<h2>inches</h2>
<p></p>

<hr>
<a name="typographicPoints"></a>
<h2>typographicPoints</h2>
<p></p>

<hr>
<a name="nT"></a>
<h2>nT</h2>
<p></p>

<hr>
<a name="cmps"></a>
<h2>cmps</h2>
<p></p>

<hr>
<a name="mps"></a>
<h2>mps</h2>
<p></p>

<hr>
<a name="centigrade"></a>
<h2>centigrade</h2>
<p>begin of LocationUnits.  These must be defined after the physical units to support Basis.</p>

<hr>
<a name="fahrenheitScale"></a>
<h2>fahrenheitScale</h2>
<p></p>

<hr>
<a name="dollars"></a>
<h2>dollars</h2>
<p>currencies for demonstration purposes.</p>

<hr>
<a name="euros"></a>
<h2>euros</h2>
<p></p>

<hr>
<a name="yen"></a>
<h2>yen</h2>
<p></p>

<hr>
<a name="rupee"></a>
<h2>rupee</h2>
<p></p>

<hr>
<a name="us2020"></a>
<h2>us2020</h2>
<p>Microseconds since midnight Jan 1, 2020, excluding those within a leap second.  Differences across leap
 second boundaries do not represent the number of microseconds elapsed.</p>

<hr>
<a name="us2000"></a>
<h2>us2000</h2>
<p>Microseconds since midnight Jan 1, 2000, excluding those within a leap second.  Differences across leap
 second boundaries do not represent the number of microseconds elapsed.</p>

<hr>
<a name="us1980"></a>
<h2>us1980</h2>
<p>Microseconds since midnight Jan 1, 1980, excluding those within a leap second.</p>

<hr>
<a name="t2010"></a>
<h2>t2010</h2>
<p>Seconds since midnight Jan 1, 2010, excluding leap seconds.</p>

<hr>
<a name="t2000"></a>
<h2>t2000</h2>
<p>Seconds since midnight Jan 1, 2000, excluding leap seconds.</p>

<hr>
<a name="t1970"></a>
<h2>t1970</h2>
<p>seconds since midnight Jan 1, 1970, excluding leap seconds.</p>

<hr>
<a name="ms1970"></a>
<h2>ms1970</h2>
<p>milliseconds since midnight Jan 1, 1970, excluding leap seconds.</p>

<hr>
<a name="us1970"></a>
<h2>us1970</h2>
<p>milliseconds since midnight Jan 1, 1970, excluding leap seconds.</p>

<hr>
<a name="mj1958"></a>
<h2>mj1958</h2>
<p>roughly days since on midnight on 1958-01-01, Julian - 2436204.5 to be more precise.</p>

<hr>
<a name="mjd"></a>
<h2>mjd</h2>
<p>The Modified Julian Day (MJD) is the number of days (with decimal fraction of the day) that have elapsed since midnight at the beginning of Wednesday November 17, 1858. 
 Julian - 2400000.5</p>

<hr>
<a name="julianDay"></a>
<h2>julianDay</h2>
<p>The Julian Day (MJD) is the number of days (with decimal fraction of the day) that have elapsed since noon on January 1, 4713 BCE.  
 Julian - 2400000.5</p>

<hr>
<a name="cdfEpoch"></a>
<h2>cdfEpoch</h2>
<p>cdf epoch milliseconds since midnight, 01-Jan-0000, excluding those with a leap second.  There must be skipped days, because this doesn't yield 01-Jan-0000 for 0.,
 but works fine at 1-1-2000., excluding those within a leap second</p>

<hr>
<a name="cdfTT2000"></a>
<h2>cdfTT2000</h2>
<p>the number of nanoseconds since 01-Jan-2000T12:00, roughly.  This includes leap seconds, so conversion is more than a scale,offset.</p>

<hr>
<a name="decimalYear"></a>
<h2>decimalYear</h2>
<p>the year plus the fraction into the current year, ((doy-1)/365) for non-leap years.</p>

<hr>
<a name="percent"></a>
<h2>percent</h2>
<p>ratiometric units</p>

<hr>
<a name="dB"></a>
<h2>dB</h2>
<p>Define a set of units to describe ratiometric (logarithmic) spacing.  
 Note the log10Ratio is the preferred method for expressing spacing, but all are convertible
 See logERatio, log10Ratio and Google for "fold change."</p>

<hr>
<a name="ampRatio"></a>
<h2>ampRatio</h2>
<p></p>

<hr>
<a name="percentIncrease"></a>
<h2>percentIncrease</h2>
<p></p>

<hr>
<a name="log10Ratio"></a>
<h2>log10Ratio</h2>
<p></p>

<hr>
<a name="logERatio"></a>
<h2>logERatio</h2>
<p></p>

<hr>
<a name="add"></a>
<h2>add</h2>
add( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> a, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> b, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> bUnits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p></p>

<h3>Parameters</h3>
a - a Number
<br>
b - a Number
<br>
bUnits - an Units

<h3>Returns:</h3>
org.das2.datum.Datum

<br><br>
<a href="https://github.com/autoplot/dev/search?q=add&unscoped_q=add">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#add">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="convertDoubleTo"></a>
<h2>convertDoubleTo</h2>
convertDoubleTo( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> toUnits, double value ) &rarr; double

<p>convert the double in this units' space to toUnits' space.</p>

<h3>Parameters</h3>
toUnits - the units.
<br>
value - the value in toUnits.

<h3>Returns:</h3>
the double in the new units system.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=convertDoubleTo&unscoped_q=convertDoubleTo">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#convertDoubleTo">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="createDatum"></a>
<h2>createDatum</h2>
createDatum( double value ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p></p>

<h3>Parameters</h3>
value - a double

<h3>Returns:</h3>
org.das2.datum.Datum

<br><br>
<a href="https://github.com/autoplot/dev/search?q=createDatum&unscoped_q=createDatum">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#createDatum">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
createDatum( int value ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a><br>
createDatum( long value ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a><br>
createDatum( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> value ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a><br>
createDatum( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> value ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a><br>
createDatum( double value, double resolution ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a><br>
<hr>
<a name="divide"></a>
<h2>divide</h2>
divide( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> a, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> b, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> bUnits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p></p>

<h3>Parameters</h3>
a - a Number
<br>
b - a Number
<br>
bUnits - an Units

<h3>Returns:</h3>
org.das2.datum.Datum

<br><br>
<a href="https://github.com/autoplot/dev/search?q=divide&unscoped_q=divide">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#divide">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="format"></a>
<h2>format</h2>
format( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> datum ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p>format the Datum.</p>

<h3>Parameters</h3>
datum - the Datum

<h3>Returns:</h3>
the Datum formatted as a string.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=format&unscoped_q=format">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#format">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getAllUnits"></a>
<h2>getAllUnits</h2>
getAllUnits(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/util/List.html'>java.util.List</a>

<p>return all the known units.</p>

<h3>Returns:</h3>
list of all the known units.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getAllUnits&unscoped_q=getAllUnits">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getAllUnits">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getBasis"></a>
<h2>getBasis</h2>
getBasis(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Basis.html'>org.das2.datum.Basis</a>

<p>return the Basis which defines the meaning of zero and the direction of positive values, such as 
 "since midnight, Jan 1, 1970"</p>

<h3>Returns:</h3>
the Basis object, which simply identifies a basis.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getBasis&unscoped_q=getBasis">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getBasis">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getByName"></a>
<h2>getByName</h2>
getByName( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> s ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

<p>returns a Units object with the given string representation that is stored in the unitsMap.
 Unlike lookupUnits, this will not allocate new units but will throw an IllegalArgumentException
 if the string is not recognized.</p>

<h3>Parameters</h3>
s - units identifier

<h3>Returns:</h3>
units object
<h3>See Also:</h3>
<a href='null'>lookupUnits(java.lang.String)</a> <br>
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getByName&unscoped_q=getByName">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getByName">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getCanonicalUnit"></a>
<h2>getCanonicalUnit</h2>
getCanonicalUnit( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> units ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

<p>return the preferred unit to use when there are multiple representations
 of the same unit (having conversion UnitsConverter.IDENTITY).</p>

<h3>Parameters</h3>
units - an Units

<h3>Returns:</h3>
the preferred unit
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getCanonicalUnit&unscoped_q=getCanonicalUnit">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getCanonicalUnit">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getConverter"></a>
<h2>getConverter</h2>
getConverter( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> fromUnits, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> toUnits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/UnitsConverter.html'>org.das2.datum.UnitsConverter</a>

<p>lookup the UnitsConverter object that takes numbers from fromUnits to toUnits.  
 This will chain together UnitsConverters registered via units.registerConverter.</p>

<h3>Parameters</h3>
fromUnits - units instance that is the source units.
<br>
toUnits - units instance that is the target units.

<h3>Returns:</h3>
UnitsConverter object
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getConverter&unscoped_q=getConverter">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getConverter">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
getConverter( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> toUnits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/UnitsConverter.html'>org.das2.datum.UnitsConverter</a><br>
<hr>
<a name="getConvertibleUnits"></a>
<h2>getConvertibleUnits</h2>
getConvertibleUnits(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units[]</a>

<p>return the units to which this unit is convertible.</p>

<h3>Returns:</h3>
the units to which this unit is convertible.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getConvertibleUnits&unscoped_q=getConvertibleUnits">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getConvertibleUnits">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getDatumFormatterFactory"></a>
<h2>getDatumFormatterFactory</h2>
getDatumFormatterFactory(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/format/DatumFormatterFactory.html'>org.das2.datum.format.DatumFormatterFactory</a>

<p>return the formatter factor for this Datum.</p>

<h3>Returns:</h3>
an org.das2.datum.format.DatumFormatterFactory

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getDatumFormatterFactory&unscoped_q=getDatumFormatterFactory">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getDatumFormatterFactory">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getFillDatum"></a>
<h2>getFillDatum</h2>
getFillDatum(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p></p>

<h3>Returns:</h3>
org.das2.datum.Datum

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getFillDatum&unscoped_q=getFillDatum">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getFillDatum">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getFillDouble"></a>
<h2>getFillDouble</h2>
getFillDouble(  ) &rarr; double

<p></p>

<h3>Returns:</h3>
double

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getFillDouble&unscoped_q=getFillDouble">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getFillDouble">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getId"></a>
<h2>getId</h2>
getId(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p>get the id uniquely identifying the units.  Note the id may contain
 special tokens, like "since" for time locations.</p>

<h3>Returns:</h3>
the id.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getId&unscoped_q=getId">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getId">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="getOffsetUnits"></a>
<h2>getOffsetUnits</h2>
getOffsetUnits(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

<p>return the units from the Basis for the unit, such as "seconds" in
 "seconds since midnight, Jan 1, 1970"</p>

<h3>Returns:</h3>
this units offsets.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getOffsetUnits&unscoped_q=getOffsetUnits">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#getOffsetUnits">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="grannyFormat"></a>
<h2>grannyFormat</h2>
grannyFormat( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> datum ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p>format the Datum, allowing use of subscripts and superscripts interpretted by GrannyTextRenderer.</p>

<h3>Parameters</h3>
datum - the Datum

<h3>Returns:</h3>
the Datum formatted as a string, possibly containing control sequences like !A and !n, etc.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=grannyFormat&unscoped_q=grannyFormat">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#grannyFormat">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="isConvertibleTo"></a>
<h2>isConvertibleTo</h2>
isConvertibleTo( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> toUnits ) &rarr; boolean

<p>return true if the unit can be converted to toUnits.</p>

<h3>Parameters</h3>
toUnits - Units object.

<h3>Returns:</h3>
true if the unit can be converted to toUnits.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=isConvertibleTo&unscoped_q=isConvertibleTo">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#isConvertibleTo">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="isFill"></a>
<h2>isFill</h2>
isFill( double value ) &rarr; boolean

<p></p>

<h3>Parameters</h3>
value - a double

<h3>Returns:</h3>
boolean

<br><br>
<a href="https://github.com/autoplot/dev/search?q=isFill&unscoped_q=isFill">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#isFill">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
isFill( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> value ) &rarr; boolean<br>
<hr>
<a name="isValid"></a>
<h2>isValid</h2>
isValid( double value ) &rarr; boolean

<p>test if the double represents a valid datum in the context of this unit.
 Note slight differences in implementation may cause isFill and isValid 
 to produce inconsistent results.  For example, this code checks for NaNs
 whereas isFill does not.</p>

<h3>Parameters</h3>
value - the value to check.

<h3>Returns:</h3>
true if the data is not fill and not NaN.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=isValid&unscoped_q=isValid">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#isValid">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="lookupTimeLengthUnit"></a>
<h2>lookupTimeLengthUnit</h2>
lookupTimeLengthUnit( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> s ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

<p>return canonical das2 unit for colloquial time.</p>

<h3>Parameters</h3>
s - string containing time unit like s, sec, millisec, etc.

<h3>Returns:</h3>
the unit or ParseException if the unit is not recognized.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=lookupTimeLengthUnit&unscoped_q=lookupTimeLengthUnit">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#lookupTimeLengthUnit">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="lookupTimeUnits"></a>
<h2>lookupTimeUnits</h2>
lookupTimeUnits( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> base, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> offsetUnits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

<p>lookupUnits canonical units object, or allocate one.  If one is
 allocated, then parse for "&lt;unit&gt; since &lt;datum&gt;" and add conversion to
 "microseconds since 2000-001T00:00."  Note leap seconds are ignored!</p>

<h3>Parameters</h3>
base - the base time, for example 2000-001T00:00.
<br>
offsetUnits - the offset units for example microseconds.  Positive values of the units will be since the base time.

<h3>Returns:</h3>
the unit.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=lookupTimeUnits&unscoped_q=lookupTimeUnits">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#lookupTimeUnits">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
lookupTimeUnits( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> units ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a><br>
<hr>
<a name="lookupUnits"></a>
<h2>lookupUnits</h2>
lookupUnits( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> sunits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

<p>lookupUnits canonical units object, or allocate one if the 
 unit has not been used already.
 Examples include:
   "nT" where it's already allocated,
   "apples" where it allocates a new one, and
   "seconds since 2011-12-21T00:00" where it uses lookupTimeUnits.</p>

<h3>Parameters</h3>
sunits - string identifier.

<h3>Returns:</h3>
canonical units object.
<h3>See Also:</h3>
<a href='null'>getByName(java.lang.String)</a> <br>
<br><br>
<a href="https://github.com/autoplot/dev/search?q=lookupUnits&unscoped_q=lookupUnits">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#lookupUnits">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="main"></a>
<h2>main</h2>
main( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String[]</a> args ) &rarr; void

<p></p>

<h3>Parameters</h3>
args - a java.lang.String[]

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=main&unscoped_q=main">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#main">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="multiply"></a>
<h2>multiply</h2>
multiply( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> a, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> b, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> bUnits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p></p>

<h3>Parameters</h3>
a - a Number
<br>
b - a Number
<br>
bUnits - an Units

<h3>Returns:</h3>
org.das2.datum.Datum

<br><br>
<a href="https://github.com/autoplot/dev/search?q=multiply&unscoped_q=multiply">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#multiply">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="nominal"></a>
<h2>nominal</h2>
nominal(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/EnumerationUnits.html'>org.das2.datum.EnumerationUnits</a>

<p>return unit for identifying nominal data.  Strings are enumerated using
 this unit using the result's create(string) method, which returns a datum
 representing the string.  This method allocates
 a number for the string if one hasn't already been allocated, and the 
 name is unique within the namespace "default".</p>

<h3>Returns:</h3>
an EnumerationUnit with the namespace "default"
<br><br>
<a href="https://github.com/autoplot/dev/search?q=nominal&unscoped_q=nominal">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#nominal">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
nominal( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> nameSpace ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/EnumerationUnits.html'>org.das2.datum.EnumerationUnits</a><br>
<hr>
<a name="parse"></a>
<h2>parse</h2>
parse( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> s ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p>parse the string in the context of these units.  The string may
 throw a parse exception if it cannot be parsed, or may return
 a known unit.</p>

<h3>Parameters</h3>
s - a String

<h3>Returns:</h3>
a Datum

<br><br>
<a href="https://github.com/autoplot/dev/search?q=parse&unscoped_q=parse">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#parse">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="registerConverter"></a>
<h2>registerConverter</h2>
registerConverter( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> toUnits, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/UnitsConverter.html'>org.das2.datum.UnitsConverter</a> converter ) &rarr; void

<p>register a converter between the units.  Note these converters can be 
 changed together to derive conversions. (A to B, B to C defines A to C.)</p>

<h3>Parameters</h3>
toUnits - the target units
<br>
converter - the converter that goes from this unit to target units.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=registerConverter&unscoped_q=registerConverter">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#registerConverter">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="subtract"></a>
<h2>subtract</h2>
subtract( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> a, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html'>Number</a> b, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> bUnits ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p></p>

<h3>Parameters</h3>
a - a Number
<br>
b - a Number
<br>
bUnits - an Units

<h3>Returns:</h3>
org.das2.datum.Datum

<br><br>
<a href="https://github.com/autoplot/dev/search?q=subtract&unscoped_q=subtract">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#subtract">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>
<hr>
<a name="toString"></a>
<h2>toString</h2>
toString(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p></p>

<h3>Returns:</h3>
java.lang.String

<br><br>
<a href="https://github.com/autoplot/dev/search?q=toString&unscoped_q=toString">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/datum/Units.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/datum/Units.html#toString">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCoreDatum/src/org/das2/datum/Units.java">[view source]</a>
<br>
<br>