ucar.nc2.dataset
Class CoordinateAxis1D

java.lang.Object
  extended by ucar.nc2.Variable
      extended by ucar.nc2.dataset.VariableDS
          extended by ucar.nc2.dataset.CoordinateAxis
              extended by ucar.nc2.dataset.CoordinateAxis1D
All Implemented Interfaces:
java.lang.Comparable<VariableSimpleIF>, Enhancements, EnhanceScaleMissing, VariableEnhanced, VariableIF, VariableSimpleIF
Direct Known Subclasses:
CoordinateAxis1DTime

public class CoordinateAxis1D
extends CoordinateAxis

A 1-dimensional Coordinate Axis. Its values must be monotonic.

If this is char valued, it will have rank 2, otherwise it will have rank 1.

If string or char valued, only getCoordName() can be called.

If the coordinates are regularly spaced, isRegular() is true, and the values are equal to getStart() + i * getIncrement().

Author:
john caron
See Also:
CoordinateAxis.factory(ucar.nc2.dataset.NetcdfDataset, ucar.nc2.dataset.VariableDS)

Nested Class Summary
 
Nested classes/interfaces inherited from class ucar.nc2.dataset.CoordinateAxis
CoordinateAxis.AxisComparator
 
Field Summary
 
Fields inherited from class ucar.nc2.Variable
defaultSizeToCache
 
Constructor Summary
CoordinateAxis1D(NetcdfDataset ds, Group group, java.lang.String shortName, DataType dataType, java.lang.String dims, java.lang.String units, java.lang.String desc)
          Constructor when theres no underlying variable.
CoordinateAxis1D(NetcdfDataset ncd, VariableDS vds)
          Create a 1D coordinate axis from an existing Variable
 
Method Summary
 CoordinateAxis copyNoCache()
          Make a copy, with an independent cache.
 int findCoordElement(double coordVal)
          Given a coordinate position, find what grid element contains it.
 int findCoordElement(double coordVal, int lastIndex)
          Given a coordinate position, find what grid element contains it.
 int findCoordElementBounded(double coordVal)
          Given a coordinate position, find what grid element contains it, but always return valid index.
 double[] getBound1()
          Get the coordinate bound1 as a double array.
 double[] getBound2()
          Get the coordinate bound1 as a double array.
 double getCoordEdge(int index)
          Get the ith coordinate edge.
 double[] getCoordEdges()
          Get the coordinate edges as a double array.
 double[] getCoordEdges(int i)
          Get the coordinate edges for the ith coordinate.
 java.lang.String getCoordName(int index)
          The "name" of the ith coordinate.
 double getCoordValue(int index)
          Get the ith coordinate value.
 double[] getCoordValues()
          Get the coordinate values as a double array.
 double getIncrement()
          Get increment value if isRegular()
 double getMaxValue()
          The largest coordinate value.
 double getMinValue()
          The smallest coordinate value.
 java.util.List<NamedObject> getNames()
          Get the list of names, to be used for user selection.
 double getStart()
          Get starting value if isRegular()
 boolean isLayer()
          Caution: many datasets do not explicitly specify this info, this is often a guess; default is false.
 boolean isRegular()
          If true, then value(i) = getStart() + i * getIncrement().
 CoordinateAxis1D section(Range r)
          Create a new CoordinateAxis1D as a section of this CoordinateAxis1D.
 void setLayer(boolean isLayer)
          Set if coordinate lies between a layer, or is at a point.
 
Methods inherited from class ucar.nc2.dataset.CoordinateAxis
equals, factory, getAxisType, getBoundaryRef, getInfo, getPositive, getUnitsString, hashCode, isContiguous, isNumeric, setAxisType, setBoundaryRef, setContiguous, setPositive
 
Methods inherited from class ucar.nc2.dataset.VariableDS
addCoordinateSystem, clearCoordinateSystems, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, enhance, getCoordinateSystems, getDescription, getOriginalDataType, getOriginalName, getOriginalVariable, getProxyReader, getUseNaNs, getValidMax, getValidMin, hasFillValue, hasInvalidData, hasMissing, hasMissingValue, hasScaleOffset, isFillValue, isInvalidData, isMissing, isMissingFast, isMissingValue, lookupEnumString, removeCoordinateSystem, setFillValueIsMissing, setInvalidDataIsMissing, setMissingDataIsMissing, setName, setOriginalVariable, setProxyReader, setUnitsString, setUseNaNs, toStringDebug
 
Methods inherited from class ucar.nc2.Variable
addAttribute, compareTo, createNewCache, findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getElementSize, getName, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameEscaped, getParentGroup, getParentStructure, getRanges, getRank, getShape, getShape, getShapeAsSection, getShortName, getSize, getSizeToCache, getSPobject, hasCachedData, invalidateCache, isCaching, isCoordinateVariable, isImmutable, isMemberOfStructure, isMetadata, isScalar, isUnknownLength, isUnlimited, isUnsigned, isVariableLength, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToByteChannel, remove, removeAttribute, removeAttributeIgnoreCase, resetDimensions, resetShape, section, section, setCachedData, setCaching, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setEnumTypedef, setImmutable, setIsScalar, setParentGroup, setParentStructure, setSizeToCache, setSPobject, slice, toString, writeCDL
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ucar.nc2.VariableIF
findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getDataType, getDimension, getDimensions, getDimensionsAll, getElementSize, getName, getNameAndDimensions, getNameEscaped, getParentGroup, getParentStructure, getRanges, getRank, getShape, getShapeAsSection, getShortName, getSize, isCoordinateVariable, isMemberOfStructure, isMetadata, isScalar, isUnlimited, isUnsigned, isVariableLength, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, section
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

CoordinateAxis1D

public CoordinateAxis1D(NetcdfDataset ncd,
                        VariableDS vds)
Create a 1D coordinate axis from an existing Variable

Parameters:
ncd - the containing dataset
vds - wrap this VariableDS, which is not changed.

CoordinateAxis1D

public CoordinateAxis1D(NetcdfDataset ds,
                        Group group,
                        java.lang.String shortName,
                        DataType dataType,
                        java.lang.String dims,
                        java.lang.String units,
                        java.lang.String desc)
Constructor when theres no underlying variable. You better set the values too!

Parameters:
ds - the containing dataset.
group - the containing group; if null, use rootGroup
shortName - axis name.
dataType - data type
dims - list of dimension names
units - units of coordinates, preferably udunit compatible.
desc - long name.
Method Detail

section

public CoordinateAxis1D section(Range r)
                         throws InvalidRangeException
Create a new CoordinateAxis1D as a section of this CoordinateAxis1D.

Parameters:
r - the section range
Returns:
a new CoordinateAxis1D as a section of this CoordinateAxis1D
Throws:
InvalidRangeException - if IllegalRange

copyNoCache

public CoordinateAxis copyNoCache()
Description copied from class: CoordinateAxis
Make a copy, with an independent cache.

Overrides:
copyNoCache in class CoordinateAxis
Returns:
copy of this CoordinateAxis

getCoordName

public java.lang.String getCoordName(int index)
The "name" of the ith coordinate. If nominal, this is all there is to a coordinate. If numeric, this will return a String representation of the coordinate.

Parameters:
index - which one ?
Returns:
the ith coordinate value as a String

getCoordValue

public double getCoordValue(int index)
Get the ith coordinate value. This is the value of the coordinate axis at which the data value is associated. These must be strictly monotonic.

Parameters:
index - which coordinate. Between 0 and getNumElements()-1 inclusive.
Returns:
coordinate value.
Throws:
java.lang.UnsupportedOperationException - if !isNumeric()

getMinValue

public double getMinValue()
Description copied from class: CoordinateAxis
The smallest coordinate value. Only call if isNumeric.

Overrides:
getMinValue in class CoordinateAxis
Returns:
the minimum coordinate value

getMaxValue

public double getMaxValue()
Description copied from class: CoordinateAxis
The largest coordinate value. Only call if isNumeric.

Overrides:
getMaxValue in class CoordinateAxis
Returns:
the maximum coordinate value

getCoordEdge

public double getCoordEdge(int index)
Get the ith coordinate edge. Exact only if isContiguous() is true, otherwise use getBound1() and getBound2(). This is the value where the underlying grid element switches from "belonging to" coordinate value i-1 to "belonging to" coordinate value i. In some grids, this may not be well defined, and so should be considered an approximation or a visualization hint.

  Coordinate edges must be strictly monotonic:
    coordEdge(0) < coordValue(0) < coordEdge(1) < coordValue(1) ...
    ... coordEdge(i) < coordValue(i) < coordEdge(i+1) < coordValue(i+1) ...
    ... coordEdge(n-1) < coordValue(n-1) < coordEdge(n)
  

Parameters:
index - which coordinate. Between 0 and getNumElements() inclusive.
Returns:
coordinate edge.
Throws:
java.lang.UnsupportedOperationException - if !isNumeric()

getCoordValues

public double[] getCoordValues()
Get the coordinate values as a double array.

Returns:
coordinate value.
Throws:
java.lang.UnsupportedOperationException - if !isNumeric()

getCoordEdges

public double[] getCoordEdges()
Get the coordinate edges as a double array. Exact only if isContiguous() is true, otherwise use getBound1() and getBound2().

Returns:
coordinate edges.
Throws:
java.lang.UnsupportedOperationException - if !isNumeric()

getBound1

public double[] getBound1()
Get the coordinate bound1 as a double array. bound1[i] # coordValue[i] # bound2[i], where # is < if increasing (bound1[i] < bound1[i+1]) else < if decreasing.

Returns:
coordinate bound1.
Throws:
java.lang.UnsupportedOperationException - if !isNumeric()

getBound2

public double[] getBound2()
Get the coordinate bound1 as a double array. bound1[i] # coordValue[i] # bound2[i], where # is < if increasing (bound1[i] < bound1[i+1]) else < if decreasing.

Returns:
coordinate bound2.
Throws:
java.lang.UnsupportedOperationException - if !isNumeric()

getCoordEdges

public double[] getCoordEdges(int i)
Get the coordinate edges for the ith coordinate. Can use this for isContiguous() true or false.

Parameters:
i - coordinate index
Returns:
double[2] edges for ith coordinate

findCoordElement

public int findCoordElement(double coordVal)
Given a coordinate position, find what grid element contains it. This means that
 edge[i] <= pos < edge[i+1] (if values are ascending)
 edge[i] > pos >= edge[i+1] (if values are descending)
 

Parameters:
coordVal - position in this coordinate system
Returns:
index of grid point containing it, or -1 if outside grid area

findCoordElement

public int findCoordElement(double coordVal,
                            int lastIndex)
Given a coordinate position, find what grid element contains it. This means that
 edge[i] <= pos < edge[i+1] (if values are ascending)
 edge[i] > pos >= edge[i+1] (if values are descending)
 

Parameters:
coordVal - position in this coordinate system
lastIndex - last position we looked for, or -1 if none
Returns:
index of grid point containing it, or -1 if outside grid area

findCoordElementBounded

public int findCoordElementBounded(double coordVal)
Given a coordinate position, find what grid element contains it, but always return valid index.

Parameters:
coordVal - position in this coordinate system
Returns:
index of grid point containing it, or closest

getStart

public double getStart()
Get starting value if isRegular()

Returns:
starting value if isRegular()

getIncrement

public double getIncrement()
Get increment value if isRegular()

Returns:
increment value if isRegular()

isLayer

public boolean isLayer()
Caution: many datasets do not explicitly specify this info, this is often a guess; default is false.

Returns:
true if coordinate lies between a layer, or false if its at a point.

setLayer

public void setLayer(boolean isLayer)
Set if coordinate lies between a layer, or is at a point.

Parameters:
isLayer - true if coordinate lies between a layer, or false if its at a point

isRegular

public boolean isRegular()
If true, then value(i) = getStart() + i * getIncrement().

Returns:
if evenly spaced.

getNames

public java.util.List<NamedObject> getNames()
Get the list of names, to be used for user selection. The ith one refers to the ith coordinate.

Returns:
List of ucar.nc2.util.NamedObject, or empty list.