CoverageCS (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

All Known Subinterfaces:

CurvilinearCS, FmrcCS, GridCS

All Known Implementing Classes:

CoverageCSImpl, CurvilinearCSImpl, FmrcCSImpl, GridCSImpl
```
public interface CoverageCS
```
A Coordinate System for coverage data. Where:
- CS:D -> Rn
- D is the domain
- R is a coordinate axis. n is getCoordinateAxes().size()
Since:

Jan 19, 2010

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface CoverageCS.Subset

static class CoverageCS.Type

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CoverageCS.Subset`
`static class`	`CoverageCS.Type`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ProjectionRect`	`getBoundingBox()` Get horizontal bounding box in projection coordinates.
`CalendarDateRange`	`getCalendarDateRange()` If there is a time coordinate, get the time covered.
`java.util.List<CoordinateAxis>`	`getCoordinateAxes()` Get the list of all axes.
`java.util.List<CoordinateTransform>`	`getCoordinateTransforms()` Get the list of all CoordinateTransforms.
`java.util.List<Dimension>`	`getDomain()` Get the list of dimensions used by any of the Axes in the Coordinate System.
`LatLonRect`	`getLatLonBoundingBox()` Get horizontal bounding box in lat, lon coordinates.
`java.lang.String`	`getName()` The name of the Grid Coordinate System.
`java.util.List<CoordinateAxis>`	`getOtherCoordinateAxes()` Get the list of axes that are not x,y,z,t.
`ProjectionImpl`	`getProjection()` Get the Projection that performs the transform math.
`CoverageCS.Subset`	`getSubset()`
`CoordinateAxis`	`getTimeAxis()` Get the Time axis, if it exists.
`CoordinateAxis`	`getVerticalAxis()` Get the Z axis.
`VerticalCT`	`getVerticalCT()` Get the Vertical CoordinateTransform, it it exists.
`VerticalTransform`	`getVerticalTransform()` Get the VerticalTransform that performs the transform math.
`CoordinateAxis`	`getXHorizAxis()` Get the X axis.
`CoordinateAxis`	`getYHorizAxis()` Get the Y axis.
`boolean`	`hasTimeAxis()` True if there is a Time Axis.
`boolean`	`isLatLon()` Does this use lat/lon horizontal axes? If not, then the horizontal axes are GeoX, GeoY, and there must be a Projection defined.
`boolean`	`isProductSet()` True if all axes are 1 dimensional.
`boolean`	`isZPositive()` True if increasing z coordinate values means "up" in altitude
`CoverageCS.Subset`	`makeSubsetFromLatLonRect(LatLonRect llbb)` Get Index Ranges for the given lat, lon bounding box.
`void`	`show(java.util.Formatter f, boolean showCoordValues)` Show information about this

- Method Detail
  - getName
```
java.lang.String getName()
```
    The name of the Grid Coordinate System.
    
    Returns:
    
    name of the Grid Coordinate System
  - getDomain
```
java.util.List<Dimension> getDomain()
```
    Get the list of dimensions used by any of the Axes in the Coordinate System.
    
    Returns:
    
    List of Dimension
  - getCoordinateAxes
```
java.util.List<CoordinateAxis> getCoordinateAxes()
```
    Get the list of all axes.
    
    Returns:
    
    List of CoordinateAxis.
  - getOtherCoordinateAxes
```
java.util.List<CoordinateAxis> getOtherCoordinateAxes()
```
    Get the list of axes that are not x,y,z,t.
    
    Returns:
    
    List of CoordinateAxis.
  - isProductSet
```
boolean isProductSet()
```
    True if all axes are 1 dimensional.
    
    Returns:
    
    true if all axes are 1 dimensional.
  - getCoordinateTransforms
```
java.util.List<CoordinateTransform> getCoordinateTransforms()
```
    Get the list of all CoordinateTransforms.
    
    Returns:
    
    List of CoordinateTransform.
  - getXHorizAxis
```
CoordinateAxis getXHorizAxis()
```
    Get the X axis. May be 1 or 2 dimensional.
    
    Returns:
    
    X CoordinateAxis, may not be null.
  - getYHorizAxis
```
CoordinateAxis getYHorizAxis()
```
    Get the Y axis. May be 1 or 2 dimensional.
    
    Returns:
    
    Y CoordinateAxis, may not be null.
  - isLatLon
```
boolean isLatLon()
```
    Does this use lat/lon horizontal axes? If not, then the horizontal axes are GeoX, GeoY, and there must be a Projection defined.
    
    Returns:
    
    true if lat/lon horizontal axes
  - getLatLonBoundingBox
```
LatLonRect getLatLonBoundingBox()
```
    Get horizontal bounding box in lat, lon coordinates. For projection, only an approximation based on corners.
    
    Returns:
    
    LatLonRect bounding box.
  - getBoundingBox
```
ProjectionRect getBoundingBox()
```
    Get horizontal bounding box in projection coordinates. For lat/lon, the ProjectionRect has units of degrees north and east.
    
    Returns:
    
    ProjectionRect bounding box.
  - getProjection
```
ProjectionImpl getProjection()
```
    Get the Projection that performs the transform math. Same as getProjectionCT().getProjection().
    
    Returns:
    
    ProjectionImpl or null.
  - getVerticalAxis
```
CoordinateAxis getVerticalAxis()
```
    Get the Z axis.
    
    Returns:
    
    Y CoordinateAxis, may be null.
  - isZPositive
```
boolean isZPositive()
```
    True if increasing z coordinate values means "up" in altitude
    
    Returns:
    
    true if increasing z coordinate values means "up" in altitude
  - getVerticalCT
```
VerticalCT getVerticalCT()
```
    Get the Vertical CoordinateTransform, it it exists.
    
    Returns:
    
    VerticalCT or null.
  - getVerticalTransform
```
VerticalTransform getVerticalTransform()
```
    Get the VerticalTransform that performs the transform math. Same as getVerticalCT().getVerticalTransform().
    
    Returns:
    
    VerticalTransform or null.
  - hasTimeAxis
```
boolean hasTimeAxis()
```
    True if there is a Time Axis.
    
    Returns:
    
    true if there is a Time Axis.
  - getTimeAxis
```
CoordinateAxis getTimeAxis()
```
    Get the Time axis, if it exists. May be 1 or 2 dimensional. If 1D, will be a CoordinateAxis1DTime. If 2D, then you can use getTimeAxisForRun(). A time coordinate must be a udunit date or ISO String, so it can always be converted to a Date. Typical meaning is the date of measurement or valid forecast time.
    
    Returns:
    
    the time coordinate axis, may be null.
  - getCalendarDateRange
```
CalendarDateRange getCalendarDateRange()
```
    If there is a time coordinate, get the time covered.
    
    Returns:
    
    DateRange or null if no time coordinate
  - show
```
void show(java.util.Formatter f,
          boolean showCoordValues)
```
    Show information about this
    
    Parameters:
    
    f - put info here
    
    showCoordValues - optionally show the coordinate values
  - makeSubsetFromLatLonRect
```
CoverageCS.Subset makeSubsetFromLatLonRect(LatLonRect llbb)
                                    throws InvalidRangeException
```
    Get Index Ranges for the given lat, lon bounding box. For projection, only an approximation based on corners. Must have CoordinateAxis1D or 2D for x and y axis.
    
    Parameters:
    
    llbb - a lat/lon bounding box.
    
    Returns:
    
    list of 2 Range objects, first y then x.
    
    Throws:
    
    InvalidRangeException - if llbb generates bad ranges
  - getSubset
```
CoverageCS.Subset getSubset()
```

Interface CoverageCS

Nested Class Summary

Method Summary

Method Detail

getName

getDomain

getCoordinateAxes

getOtherCoordinateAxes

isProductSet

getCoordinateTransforms

getXHorizAxis

getYHorizAxis

isLatLon

getLatLonBoundingBox

getBoundingBox

getProjection

getVerticalAxis

isZPositive

getVerticalCT

getVerticalTransform

hasTimeAxis

getTimeAxis

getCalendarDateRange

show

makeSubsetFromLatLonRect

getSubset