CoordinateAxis1D (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.nc2.Variable
- - ucar.nc2.dataset.VariableDS
  - - ucar.nc2.dataset.CoordinateAxis
    - - ucar.nc2.dataset.CoordinateAxis1D

All Implemented Interfaces:

Comparable<VariableSimpleIF>, IsMissingEvaluator, EnhanceScaleMissingUnsigned, VariableEnhanced, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

CoordinateAxis1DTime

Deprecated.
use GridAxis1D
```
@Deprecated
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().
This will also set "cell bounds" for this axis. By default, the cell bounds are midway between the coordinates values, and are therefore contiguous, and can be accessed though getCoordEdge(i). The only way the bounds can be set is if the coordinate variable has an attribute "bounds" that points to another variable bounds(ncoords,2). These contain the cell bounds, and must be ascending or descending as the coordinate values are. In this case isContiguous() is true when bounds1(i+1) == bounds2(i) for all i.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CoordinateAxis1D.Builder<T extends CoordinateAxis1D.Builder<T>>
Deprecated.
- Nested classes/interfaces inherited from class ucar.nc2.dataset.CoordinateAxis
  CoordinateAxis.AxisComparator
- Nested classes/interfaces inherited from class ucar.nc2.Variable
  Variable.Cache

Nested Classes
Modifier and Type	Class and Description
`static class`	`CoordinateAxis1D.Builder<T extends CoordinateAxis1D.Builder<T>>` Deprecated.

Field Summary

Fields
Modifier and Type Field and Description

protected double[] coords
Deprecated.

protected boolean wasRead
Deprecated.
- Fields inherited from class ucar.nc2.dataset.CoordinateAxis
  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, dimensions, elementSize, hashCode, isVariableLength, ncfile, permitCaching, proxyReader, shape, spiObject

Fields
Modifier and Type	Field and Description
`protected double[]`	`coords` Deprecated.
`protected boolean`	`wasRead` Deprecated.

Constructor Summary

Constructors
Modifier Constructor and Description

protected CoordinateAxis1D(CoordinateAxis1D.Builder<?> builder, Group parentGroup)
Deprecated.

Constructors
Modifier	Constructor and Description
`protected`	`CoordinateAxis1D(CoordinateAxis1D.Builder<?> builder, Group parentGroup)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected CoordinateAxis1D.Builder<?>`	`addLocalFieldsToBuilder(CoordinateAxis1D.Builder<? extends CoordinateAxis1D.Builder<?>> b)` Deprecated.
`static CoordinateAxis1D.Builder<?>`	`builder()` Deprecated. Get Builder for this class that allows subclassing.
`CoordinateAxis1D`	`correctLongitudeWrap()` Deprecated. If longitude coordinate is not monotic, construct a new one that is.
`int`	`findCoordElement(double coordVal)` Deprecated. Given a coordinate value, find what grid element contains it.
`int`	`findCoordElementBounded(double coordVal)` Deprecated. Given a coordinate position, find what grid element contains it, or is closest to it.
`double[]`	`getBound1()` Deprecated. Get the coordinate bound1 as a double array.
`double[]`	`getBound2()` Deprecated. Get the coordinate bound1 as a double array.
`double[]`	`getCoordBounds(int i)` Deprecated. Get the coordinate bounds for the ith coordinate.
`double`	`getCoordBoundsMidpoint(int i)` Deprecated.
`double`	`getCoordEdge(int index)` Deprecated. Get the ith coordinate edge.
`double[]`	`getCoordEdges()` Deprecated. Get the coordinate edges as a double array.
`String`	`getCoordName(int index)` Deprecated. The "name" of the ith coordinate.
`double`	`getCoordValue(int index)` Deprecated. Get the ith coordinate value.
`double[]`	`getCoordValues()` Deprecated. Get the coordinate values as a double array.
`double`	`getIncrement()` Deprecated. Get increment value if isRegular()
`double`	`getMaxEdgeValue()` Deprecated.
`double`	`getMaxValue()` Deprecated. The largest coordinate value.
`double`	`getMinEdgeValue()` Deprecated.
`double`	`getMinValue()` Deprecated. The smallest coordinate value.
`double`	`getStart()` Deprecated. Get starting value if isRegular()
`boolean`	`isContiguous()` Deprecated. If the edges are contiguous or disjoint Caution: many datasets do not explicitly specify this info, this is often a guess; default is true.
`boolean`	`isInterval()` Deprecated. If this coordinate has interval values.
`boolean`	`isRegular()` Deprecated. If true, then value(i) = getStart() + i * getIncrement().
`protected void`	`readValues()` Deprecated.
`CoordinateAxis1D`	`section(Range r)` Deprecated. Create a new CoordinateAxis1D as a section of this CoordinateAxis1D.
`CoordinateAxis1D.Builder<?>`	`toBuilder()` Deprecated. Turn into a mutable Builder.

Methods inherited from class ucar.nc2.dataset.CoordinateAxis
addLocalFieldsToBuilder, equals, fromVariableDS, getAxisType, getBoundaryRef, getCalendarFromAttribute, getCalendarFromAttribute, getInfo, getPositive, getUnitsString, hashCode, isIndependentCoordinate, isNumeric

Methods inherited from class ucar.nc2.dataset.VariableDS
_read, _read, addLocalFieldsToBuilder, applyScaleOffset, applyScaleOffset, convert, convertArray, convertMissing, convertMissing, convertNeeded, convertUnsigned, convertUnsigned, fromVar, getCoordinateSystems, getDatasetLocation, getDescription, getEnhanceMode, getFillValue, getMissingDataArray, getMissingValues, getNetcdfFile, getOffset, getOriginalArrayType, getOriginalDataType, getOriginalName, getOriginalVariable, getScaledOffsetType, getScaleFactor, getSignedness, getUnsignedConversionType, getValidMax, getValidMin, hasFillValue, hasMissing, hasMissingValue, hasScaleOffset, hasValidData, isFillValue, isInvalidData, isMissing, isMissingValue, lookupEnumString, proxyReadArray, proxyReadArray, readArray, readArray, readToStream, reallyRead, reallyRead, setCaching, showScaleMissingProxy, toString, toStringDebug

Methods inherited from class ucar.nc2.Variable
_readScalarData, addLocalFieldsToBuilder, attributes, compareTo, extraInfo, findAttribute, findAttributeString, findDimensionIndex, getArrayType, getDataType, getDimension, getDimensions, getDimensionSet, getDimensionsString, getElementSize, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getParentGroup, getParentStructure, getRanges, getRank, getSection, getShape, getShape, getShapeAsSection, getShortName, getSize, getSizeToCache, getSPobject, hasCachedData, invalidateCache, isCaching, isCoordinateVariable, isMemberOfStructure, isMetadata, isScalar, isUnlimited, isVariableLength, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, reduce, resetShape, section, section, setCachedData, slice, writeCDL

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced
getFullName, getParentGroup, getShortName

- Field Detail
  - wasRead
```
protected boolean wasRead
```
    Deprecated.
  - coords
```
protected double[] coords
```
    Deprecated.
- Constructor Detail
  - CoordinateAxis1D
```
protected CoordinateAxis1D(CoordinateAxis1D.Builder<?> builder,
                           Group parentGroup)
```
    Deprecated.
- Method Detail
  - section
```
public CoordinateAxis1D section(Range r)
                         throws InvalidRangeException
```
    Deprecated.
    
    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
  - getCoordName
```
public String getCoordName(int index)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    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:
    
    UnsupportedOperationException - if !isNumeric()
  - getMinValue
```
public double getMinValue()
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    Description copied from class: CoordinateAxis
    
    The largest coordinate value. Only call if isNumeric.
    
    Overrides:
    
    getMaxValue in class CoordinateAxis
    
    Returns:
    
    the maximum coordinate value
  - getMinEdgeValue
```
public double getMinEdgeValue()
```
    Deprecated.
  - getMaxEdgeValue
```
public double getMaxEdgeValue()
```
    Deprecated.
  - getCoordEdge
```
public double getCoordEdge(int index)
```
    Deprecated.
    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:
    
    UnsupportedOperationException - if !isNumeric()
  - getCoordValues
```
public double[] getCoordValues()
```
    Deprecated.
    
    Get the coordinate values as a double array.
    
    Returns:
    
    coordinate value.
    
    Throws:
    
    UnsupportedOperationException - if !isNumeric()
  - getCoordEdges
```
public double[] getCoordEdges()
```
    Deprecated.
    
    Get the coordinate edges as a double array. Exact only if isContiguous() is true, otherwise use getBound1() and getBound2().
    
    Returns:
    
    coordinate edges.
    
    Throws:
    
    UnsupportedOperationException - if !isNumeric()
  - isContiguous
```
public boolean isContiguous()
```
    Deprecated.
    
    Description copied from class: CoordinateAxis
    
    If the edges are contiguous or disjoint Caution: many datasets do not explicitly specify this info, this is often a guess; default is true.
    
    Overrides:
    
    isContiguous in class CoordinateAxis
    
    Returns:
    
    true if the edges are contiguous or false if disjoint. Assumed true unless set otherwise.
  - isInterval
```
public boolean isInterval()
```
    Deprecated.
    
    If this coordinate has interval values. If so, then one should use getBound1, getBound2, and not getCoordEdges()
    
    Overrides:
    
    isInterval in class CoordinateAxis
    
    Returns:
    
    true if coordinate has interval values
  - getBound1
```
public double[] getBound1()
```
    Deprecated.
    
    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:
    
    UnsupportedOperationException - if !isNumeric()
  - getBound2
```
public double[] getBound2()
```
    Deprecated.
    
    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:
    
    UnsupportedOperationException - if !isNumeric()
  - getCoordBounds
```
public double[] getCoordBounds(int i)
```
    Deprecated.
    
    Get the coordinate bounds for the ith coordinate. Can use this for isContiguous() true or false.
    
    Parameters:
    
    i - coordinate index
    
    Returns:
    
    double[2] edges for ith coordinate
  - getCoordBoundsMidpoint
```
public double getCoordBoundsMidpoint(int i)
```
    Deprecated.
  - findCoordElement
```
public int findCoordElement(double coordVal)
```
    Deprecated.
    Given a coordinate value, find what grid element contains it. This means that
```
 edge[i] <= value < edge[i+1] (if values are ascending)
 edge[i] > value >= 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
  - findCoordElementBounded
```
public int findCoordElementBounded(double coordVal)
```
    Deprecated.
    
    Given a coordinate position, find what grid element contains it, or is closest to it.
    
    Parameters:
    
    coordVal - position in this coordinate system
    
    Returns:
    
    index of grid point containing it, or best estimate of closest grid interval.
  - getStart
```
public double getStart()
```
    Deprecated.
    
    Get starting value if isRegular()
    
    Returns:
    
    starting value if isRegular()
  - getIncrement
```
public double getIncrement()
```
    Deprecated.
    
    Get increment value if isRegular()
    
    Returns:
    
    increment value if isRegular()
  - isRegular
```
public boolean isRegular()
```
    Deprecated.
    
    If true, then value(i) = getStart() + i * getIncrement().
    
    Returns:
    
    if evenly spaced.
  - correctLongitudeWrap
```
public CoordinateAxis1D correctLongitudeWrap()
```
    Deprecated.
    
    If longitude coordinate is not monotic, construct a new one that is. LOOK Should this be here? Perhaps its a Grid method?
  - readValues
```
protected void readValues()
```
    Deprecated.
  - toBuilder
```
public CoordinateAxis1D.Builder<?> toBuilder()
```
    Deprecated.
    
    Description copied from class: Variable
    
    Turn into a mutable Builder. Can use toBuilder().build() to copy.
    
    Overrides:
    
    toBuilder in class CoordinateAxis
  - addLocalFieldsToBuilder
```
protected CoordinateAxis1D.Builder<?> addLocalFieldsToBuilder(CoordinateAxis1D.Builder<? extends CoordinateAxis1D.Builder<?>> b)
```
    Deprecated.
  - builder
```
public static CoordinateAxis1D.Builder<?> builder()
```
    Deprecated.
    
    Get Builder for this class that allows subclassing.
    
    See Also:
    
    "https://community.oracle.com/blogs/emcmanus/2010/10/24/using-builder-pattern-subclasses"

Class CoordinateAxis1D

Nested Class Summary

Nested classes/interfaces inherited from class ucar.nc2.dataset.CoordinateAxis

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

Field Summary

Fields inherited from class ucar.nc2.dataset.CoordinateAxis

Fields inherited from class ucar.nc2.dataset.VariableDS

Fields inherited from class ucar.nc2.Variable

Constructor Summary

Method Summary

Methods inherited from class ucar.nc2.dataset.CoordinateAxis

Methods inherited from class ucar.nc2.dataset.VariableDS

Methods inherited from class ucar.nc2.Variable

Methods inherited from class java.lang.Object

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced

Field Detail

wasRead

coords

Constructor Detail

CoordinateAxis1D

Method Detail

section

getCoordName

getCoordValue

getMinValue

getMaxValue

getMinEdgeValue

getMaxEdgeValue

getCoordEdge

getCoordValues

getCoordEdges

isContiguous

isInterval

getBound1

getBound2

getCoordBounds

getCoordBoundsMidpoint

findCoordElement

findCoordElementBounded

getStart

getIncrement

isRegular

correctLongitudeWrap

readValues

toBuilder

addLocalFieldsToBuilder

builder