ucar.nc2.dataset

Class CoordinateAxis2D

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Variable

ucar.nc2.dataset.VariableDS

ucar.nc2.dataset.CoordinateAxis

ucar.nc2.dataset.CoordinateAxis2D

All Implemented Interfaces:

java.lang.Comparable<VariableSimpleIF>, IsMissingEvaluator, AttributeContainer, Enhancements, EnhanceScaleMissing, VariableEnhanced, ProxyReader, 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.

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

axisSizeToCache, axisType, boundaryRef, isContiguous, ncd, positive

Fields inherited from class ucar.nc2.dataset.VariableDS

orgDataType, orgName, orgVar

Fields inherited from class ucar.nc2.Variable

attributes, cache, dataType, debugCaching, defaultCoordsSizeToCache, defaultSizeToCache, dimensions, elementSize, hashCode, isMetadata, isVariableLength, ncfile, permitCaching, proxyReader, shape, shapeAsSection, sizeToCache, spiObject

Fields inherited from class ucar.nc2.CDMNode

annotations, dodsname, group, immutable, parentstruct, shortName, sort

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Variable	copy()
ArrayDouble.D3	getCoordBoundsArray() Only call if isInterval()
CoordinateAxisTimeHelper	getCoordinateAxisTimeHelper()
double	getCoordValue(int j, int i) 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	getCoordValuesArray()
ArrayDouble.D2	getMidpoints() Deprecated. use getCoordValuesArray
ArrayDouble.D2	getXEdges()
ArrayDouble.D2	getYEdges()
boolean	isInterval() An interval coordinate consists of two numbers, bound1 and bound2.
static ArrayDouble.D2	makeXEdges(ArrayDouble.D2 midx) Normal case: do something reasonable in deciding on the edges when we have the midpoints of a 2D coordinate.
static ArrayDouble.D2	makeXEdgesRotated(ArrayDouble.D2 midx) Experimental: for WRF rotated (NMM "E") Grids
static ArrayDouble.D2	makeYEdges(ArrayDouble.D2 midy) Normal case: do something reasonable in deciding on the edges when we have the midpoints of a 2D coordinate.
static ArrayDouble.D2	makeYEdgesRotated(ArrayDouble.D2 midy) Experimental: for WRF rotated (NMM "E") 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

copyNoCache, equals, factory, getAxisType, getBoundaryRef, getCalendarFromAttribute, getInfo, getMaxValue, getMinValue, getPositive, getUnitsString, hashCode, isContiguous, isCoordinateVariable, isNumeric, setAxisType, setBoundaryRef, setPositive

Methods inherited from class ucar.nc2.dataset.VariableDS

_read, _read, addCoordinateSystem, clearCoordinateSystems, convertEnums, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, convertScaleOffsetMissing, enhance, getCoordinateSystems, getDatasetLocation, getDescription, getEnhanceMode, getMissingDataArray, getOriginalDataType, getOriginalName, getOriginalVariable, getUseNaNs, getValidMax, getValidMin, hasCachedDataRecurse, hasFillValue, hasInvalidData, hasMissing, hasMissingValue, hasScaleOffset, isFillValue, isInvalidData, isMissing, isMissingFast, isMissingValue, lookupEnumString, readToStream, reallyRead, reallyRead, removeCoordinateSystem, setCaching, setFillValueIsMissing, setInvalidDataIsMissing, setMissingDataIsMissing, setName, setOriginalVariable, setUnitsString, setUseNaNs, showScaleMissingProxy, toStringDebug

Methods inherited from class ucar.nc2.Variable

addAll, addAttribute, compareTo, createNewCache, extraInfo, findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getDAPName, getDAPName, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getElementSize, getEnumTypedef, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getProxyReader, getRanges, getRank, getScalarData, getShape, getShape, getShapeAll, getShapeAsSection, getShapeNotScalar, getSize, getSizeToCache, getSPobject, hasCachedData, hashCodeShow, invalidateCache, isCaching, isImmutable, isMetadata, isScalar, isUnknownLength, isUnlimited, isUnsigned, isVariableLength, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToByteChannel, reduce, remove, removeAttribute, removeAttributeIgnoreCase, resetDimensions, resetShape, section, section, setCachedData, setCachedData, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setEnumTypedef, setImmutable, setIsScalar, setParentGroup, setProxyReader, setSizeToCache, setSPobject, setUnsigned, setValues, setValues, slice, toString, writeCDL, writeCDL

Methods inherited from class ucar.nc2.CDMNode

annotate, getAnnotation, getAnnotations, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getName, getParentStructure, getShortName, getSort, isMemberOfStructure, localhash, setDODSName, setImmutable, setParentStructure, setShortName, setSort, unwrap

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, getEnumTypedef, getFullName, getFullNameEscaped, getNameAndDimensions, 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 ucar.nc2.VariableSimpleIF

getName

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 j,
                            int i)

Get the coordinate value at the i, j index.

Parameters:

i - index 0 (fastest varying, right-most)

j - index 1

Returns:

midpoint.get(j, i).

isInterval

public boolean isInterval()

Description copied from class: CoordinateAxis

An interval coordinate consists of two numbers, bound1 and bound2. The coordinate value must lie between them, but otherwise is somewhat arbitrary. If not interval, then it has one number, the coordinate value.

Overrides:

isInterval in class CoordinateAxis

Returns:

true if its an interval coordinate.

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

getCoordValuesArray

public ArrayDouble.D2 getCoordValuesArray()

getCoordBoundsArray

public ArrayDouble.D3 getCoordBoundsArray()

Only call if isInterval()

Returns:

bounds array pr null if not an interval

getMidpoints

public ArrayDouble.D2 getMidpoints()

Deprecated. use getCoordValuesArray

getXEdges

public ArrayDouble.D2 getXEdges()

getYEdges

public ArrayDouble.D2 getYEdges()

makeXEdges

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

Normal case: do something reasonable in deciding on the edges when we have the midpoints of a 2D coordinate.

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)

Normal case: do something reasonable in deciding on the edges when we have the midpoints of a 2D coordinate.

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)

Experimental: for WRF rotated (NMM "E") 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)

Experimental: for WRF rotated (NMM "E") Grids

Parameters:

midy - y coordinates of midpoints

Returns:

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

getCoordinateAxisTimeHelper

public CoordinateAxisTimeHelper getCoordinateAxisTimeHelper()