CoverageCSImpl (NetCDF-Java Library 4.3.16 API)

java.lang.Object
- ucar.nc2.ft.grid.impl.CoverageCSImpl

All Implemented Interfaces:

CoverageCS

Direct Known Subclasses:

FmrcCSImpl, GridCSImpl, SwathCSImpl
```
public class CoverageCSImpl
extends Object
implements CoverageCS
```
Coverage Coordinate System implementation.

Since:

12/25/12

Author:

John

Nested Class Summary
- Nested classes/interfaces inherited from interface ucar.nc2.ft.grid.CoverageCS
  CoverageCS.Subset, CoverageCS.Type

Field Summary

Fields
Modifier and Type	Field and Description
`protected CoordinateSystem`	`cs`
`protected NetcdfDataset`	`ds`
`protected CoverageCSFactory`	`fac`
`protected ProjectionRect`	`mapArea`
`protected ProjectionImpl`	`projection`

Constructor Summary

Constructors
Modifier Constructor and Description

protected CoverageCSImpl(NetcdfDataset ds, CoordinateSystem cs, CoverageCSFactory fac)

Constructors
Modifier	Constructor and Description
`protected`	`CoverageCSImpl(NetcdfDataset ds, CoordinateSystem cs, CoverageCSFactory fac)`

Method Summary

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.
`List<CoordinateAxis>`	`getCoordinateAxes()` Get the list of all axes.
`List<CoordinateTransform>`	`getCoordinateTransforms()` Get the list of all CoordinateTransforms.
`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.
`String`	`getName()` The name of the Grid Coordinate System.
`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(Formatter f, boolean showCoords)` Show information about this
`String`	`toString()`

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

- Field Detail
  - ds
```
protected NetcdfDataset ds
```
  - cs
```
protected CoordinateSystem cs
```
  - fac
```
protected CoverageCSFactory fac
```
  - projection
```
protected ProjectionImpl projection
```
  - mapArea
```
protected ProjectionRect mapArea
```
- Constructor Detail
  - CoverageCSImpl
```
protected CoverageCSImpl(NetcdfDataset ds,
              CoordinateSystem cs,
              CoverageCSFactory fac)
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: CoverageCS
    
    The name of the Grid Coordinate System.
    
    Specified by:
    
    getName in interface CoverageCS
    
    Returns:
    name of the Grid Coordinate System
  - getDomain
```
public List<Dimension> getDomain()
```
    Description copied from interface: CoverageCS
    
    Get the list of dimensions used by any of the Axes in the Coordinate System.
    
    Specified by:
    
    getDomain in interface CoverageCS
    
    Returns:
    List of Dimension
  - getCoordinateAxes
```
public List<CoordinateAxis> getCoordinateAxes()
```
    Description copied from interface: CoverageCS
    
    Get the list of all axes.
    
    Specified by:
    
    getCoordinateAxes in interface CoverageCS
    
    Returns:
    List of CoordinateAxis.
  - getOtherCoordinateAxes
```
public List<CoordinateAxis> getOtherCoordinateAxes()
```
    Description copied from interface: CoverageCS
    
    Get the list of axes that are not x,y,z,t.
    
    Specified by:
    
    getOtherCoordinateAxes in interface CoverageCS
    
    Returns:
    List of CoordinateAxis.
  - isProductSet
```
public boolean isProductSet()
```
    Description copied from interface: CoverageCS
    
    True if all axes are 1 dimensional.
    
    Specified by:
    
    isProductSet in interface CoverageCS
    
    Returns:
    true if all axes are 1 dimensional.
  - getCoordinateTransforms
```
public List<CoordinateTransform> getCoordinateTransforms()
```
    Description copied from interface: CoverageCS
    
    Get the list of all CoordinateTransforms.
    
    Specified by:
    
    getCoordinateTransforms in interface CoverageCS
    
    Returns:
    List of CoordinateTransform.
  - getXHorizAxis
```
public CoordinateAxis getXHorizAxis()
```
    Description copied from interface: CoverageCS
    
    Get the X axis. May be 1 or 2 dimensional.
    
    Specified by:
    
    getXHorizAxis in interface CoverageCS
    
    Returns:
    X CoordinateAxis, may not be null.
  - getYHorizAxis
```
public CoordinateAxis getYHorizAxis()
```
    Description copied from interface: CoverageCS
    
    Get the Y axis. May be 1 or 2 dimensional.
    
    Specified by:
    
    getYHorizAxis in interface CoverageCS
    
    Returns:
    Y CoordinateAxis, may not be null.
  - isLatLon
```
public boolean isLatLon()
```
    Description copied from interface: CoverageCS
    
    Does this use lat/lon horizontal axes? If not, then the horizontal axes are GeoX, GeoY, and there must be a Projection defined.
    
    Specified by:
    
    isLatLon in interface CoverageCS
    
    Returns:
    true if lat/lon horizontal axes
  - getLatLonBoundingBox
```
public LatLonRect getLatLonBoundingBox()
```
    Description copied from interface: CoverageCS
    
    Get horizontal bounding box in lat, lon coordinates. For projection, only an approximation based on corners.
    
    Specified by:
    
    getLatLonBoundingBox in interface CoverageCS
    
    Returns:
    LatLonRect bounding box.
  - getBoundingBox
```
public ProjectionRect getBoundingBox()
```
    Description copied from interface: CoverageCS
    
    Get horizontal bounding box in projection coordinates. For lat/lon, the ProjectionRect has units of degrees north and east.
    
    Specified by:
    
    getBoundingBox in interface CoverageCS
    
    Returns:
    ProjectionRect bounding box.
  - getProjection
```
public ProjectionImpl getProjection()
```
    Description copied from interface: CoverageCS
    
    Get the Projection that performs the transform math. Same as getProjectionCT().getProjection().
    
    Specified by:
    
    getProjection in interface CoverageCS
    
    Returns:
    ProjectionImpl or null.
  - getVerticalAxis
```
public CoordinateAxis getVerticalAxis()
```
    Description copied from interface: CoverageCS
    
    Get the Z axis.
    
    Specified by:
    
    getVerticalAxis in interface CoverageCS
    
    Returns:
    Y CoordinateAxis, may be null.
  - isZPositive
```
public boolean isZPositive()
```
    Description copied from interface: CoverageCS
    
    True if increasing z coordinate values means "up" in altitude
    
    Specified by:
    
    isZPositive in interface CoverageCS
    
    Returns:
    true if increasing z coordinate values means "up" in altitude
  - getVerticalCT
```
public VerticalCT getVerticalCT()
```
    Description copied from interface: CoverageCS
    
    Get the Vertical CoordinateTransform, it it exists.
    
    Specified by:
    
    getVerticalCT in interface CoverageCS
    
    Returns:
    VerticalCT or null.
  - getVerticalTransform
```
public VerticalTransform getVerticalTransform()
```
    Description copied from interface: CoverageCS
    
    Get the VerticalTransform that performs the transform math. Same as getVerticalCT().getVerticalTransform().
    
    Specified by:
    
    getVerticalTransform in interface CoverageCS
    
    Returns:
    VerticalTransform or null.
  - hasTimeAxis
```
public boolean hasTimeAxis()
```
    Description copied from interface: CoverageCS
    
    True if there is a Time Axis.
    
    Specified by:
    
    hasTimeAxis in interface CoverageCS
    
    Returns:
    true if there is a Time Axis.
  - getTimeAxis
```
public CoordinateAxis getTimeAxis()
```
    Description copied from interface: CoverageCS
    
    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.
    
    Specified by:
    
    getTimeAxis in interface CoverageCS
    
    Returns:
    the time coordinate axis, may be null.
  - getCalendarDateRange
```
public CalendarDateRange getCalendarDateRange()
```
    Description copied from interface: CoverageCS
    
    If there is a time coordinate, get the time covered.
    
    Specified by:
    
    getCalendarDateRange in interface CoverageCS
    
    Returns:
    DateRange or null if no time coordinate
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - show
```
public void show(Formatter f,
        boolean showCoords)
```
    Description copied from interface: CoverageCS
    
    Show information about this
    
    Specified by:
    
    show in interface CoverageCS
    
    Parameters:
    f - put info here
    showCoords - optionally show the coordinate values
  - makeSubsetFromLatLonRect
```
public CoverageCS.Subset makeSubsetFromLatLonRect(LatLonRect llbb)
                                           throws InvalidRangeException
```
    Description copied from interface: CoverageCS
    
    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.
    
    Specified by:
    
    makeSubsetFromLatLonRect in interface CoverageCS
    
    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
```
public CoverageCS.Subset getSubset()
```
    Specified by:
    
    getSubset in interface CoverageCS

Class CoverageCSImpl

Nested Class Summary

Nested classes/interfaces inherited from interface ucar.nc2.ft.grid.CoverageCS

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ds

cs

fac

projection

mapArea

Constructor Detail

CoverageCSImpl

Method Detail

getName

getDomain

getCoordinateAxes

getOtherCoordinateAxes

isProductSet

getCoordinateTransforms

getXHorizAxis

getYHorizAxis

isLatLon

getLatLonBoundingBox

getBoundingBox

getProjection

getVerticalAxis

isZPositive

getVerticalCT

getVerticalTransform

hasTimeAxis

getTimeAxis

getCalendarDateRange

toString

show

makeSubsetFromLatLonRect

getSubset