ucar.nc2.dataset
Class CoordinateAxis2D

java.lang.Object
  ucar.nc2.Variable
      ucar.nc2.dataset.VariableDS
          ucar.nc2.dataset.CoordinateAxis
              ucar.nc2.dataset.CoordinateAxis2D

All Implemented Interfaces:

java.lang.Comparable<VariableSimpleIF>, Enhancements, EnhanceScaleMissing, VariableEnhanced, VariableIF, VariableSimpleIF

public class CoordinateAxis2D
extends CoordinateAxis

A 2-dimensional numeric Coordinate Axis. Must be invertible meaning, roughly, that if you draw lines connecting the points, none would cross.

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

Nested classes/interfaces inherited from class ucar.nc2.Variable

Variable.Cache

Field Summary

Fields inherited from class ucar.nc2.dataset.CoordinateAxis

axisType, boundaryRef, isContiguous, ncd, positive, POSITIVE_DOWN, POSITIVE_UP

Fields inherited from class ucar.nc2.dataset.VariableDS

orgVar

Fields inherited from class ucar.nc2.Variable

attributes, cache, dataType, debugCaching, defaultSizeToCache, dimensions, elementSize, group, isMetadata, isVariableLength, ncfile, parent, postReader, preReader, shape, shapeAsSection, shortName, sizeToCache, spiObject

Constructor Summary

CoordinateAxis2D(NetcdfDataset ncd, VariableDS vds)
Create a 2D coordinate axis from an existing VariableDS

Method Summary

protected Variable	copy()
double	getCoordValue(int i, int j) Get the coordinate value at the i, j index.
double[]	getCoordValues() Get the coordinate values as a 1D double array, in canonical order.
ArrayDouble.D2	getMidpoints()
static ArrayDouble.D2	makeXEdges(ArrayDouble.D2 midx) For regular Grids
static ArrayDouble.D2	makeXEdgesRotated(ArrayDouble.D2 midx) For staggered Grids
static ArrayDouble.D2	makeYEdges(ArrayDouble.D2 midy) For regular Grids
static ArrayDouble.D2	makeYEdgesRotated(ArrayDouble.D2 midy) For staggered Grids
CoordinateAxis2D	section(Range r1, Range r2) Create a new CoordinateAxis2D as a section of this CoordinateAxis2D.

Methods inherited from class ucar.nc2.dataset.CoordinateAxis

equals, factory, getAxisType, getBoundaryRef, getInfo, getMaxValue, getMinValue, getPositive, getUnitsString, hashCode, isContiguous, isNumeric, makeCopy, setAxisType, setBoundaryRef, setContiguous, setPositive

Methods inherited from class ucar.nc2.dataset.VariableDS

_read, _read, addCoordinateSystem, convertEnums, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, enhance, getCoordinateSystems, getDescription, getOriginalDataType, getOriginalName, getOriginalVariable, getProxyReader, getUseNaNs, getValidMax, getValidMin, hasFillValue, hasInvalidData, hasMissing, hasMissingValue, hasScaleOffset, isCoordinateVariable, isFillValue, isInvalidData, isMissing, isMissingFast, isMissingValue, removeCoordinateSystem, setFillValueIsMissing, setInvalidDataIsMissing, setMissingDataIsMissing, setName, setOriginalVariable, setProxyReader, setUnitsString, setUseNaNs, toStringDebug

Methods inherited from class ucar.nc2.Variable

addAttribute, compareTo, createNewCache, extraInfo, findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getElementSize, getName, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameEscaped, getParentGroup, getParentStructure, getRanges, getRank, getScalarData, getShape, getShapeAsSection, getShortName, getSize, getSizeToCache, getSPobject, hasCachedData, invalidateCache, isCaching, isImmutable, isMemberOfStructure, isMetadata, isScalar, isUnknownLength, isUnlimited, isUnsigned, isVariableLength, lookupEnumString, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, remove, removeAttribute, 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

clone, finalize, 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, 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

CoordinateAxis2D

public CoordinateAxis2D(NetcdfDataset ncd,
                        VariableDS vds)

Create a 2D coordinate axis from an existing VariableDS

Parameters:

ncd - the containing dataset

vds - create it from here

Method Detail

copy

protected Variable copy()

Overrides:

copy in class CoordinateAxis

getCoordValue

public double getCoordValue(int i,
                            int j)

Get the coordinate value at the i, j index.

Parameters:

i - index 0

j - index 1

Returns:

coordinate value.

getCoordValues

public double[] getCoordValues()

Get the coordinate values as a 1D double array, in canonical order.

Returns:

coordinate values

Throws:

java.lang.UnsupportedOperationException - if !isNumeric()

section

public CoordinateAxis2D section(Range r1,
                                Range r2)
                         throws InvalidRangeException

Create a new CoordinateAxis2D as a section of this CoordinateAxis2D.

Parameters:

r1 - the section on the first index

r2 - the section on the second index

Returns:

a section of this CoordinateAxis2D

Throws:

InvalidRangeException - if specified Ranges are invalid

getMidpoints

public ArrayDouble.D2 getMidpoints()

makeXEdges

public static ArrayDouble.D2 makeXEdges(ArrayDouble.D2 midx)

For regular Grids

Parameters:

midx - x coordinates of midpoints

Returns:

x coordinates of edges with shape (ny+1, nx+1)

makeYEdges

public static ArrayDouble.D2 makeYEdges(ArrayDouble.D2 midy)

For regular Grids

Parameters:

midy - y coordinates of midpoints

Returns:

y coordinates of edges with shape (ny+1, nx+1)

makeXEdgesRotated

public static ArrayDouble.D2 makeXEdgesRotated(ArrayDouble.D2 midx)

For staggered Grids

Parameters:

midx - x coordinates of midpoints

Returns:

x coordinates of edges with shape (ny+2, nx+1)

makeYEdgesRotated

public static ArrayDouble.D2 makeYEdgesRotated(ArrayDouble.D2 midy)

For staggered Grids

Parameters:

midy - y coordinates of midpoints

Returns:

y coordinates of edges with shape (ny+2, nx+1)