ucar.nc2.internal.grid

Class GridHorizCS

java.lang.Object

ucar.nc2.internal.grid.GridHorizCS

All Implemented Interfaces:

GridHorizCoordinateSystem

Direct Known Subclasses:

GridLatLon2D

public class GridHorizCS
extends Object
implements GridHorizCoordinateSystem

HorizCS with 1D x,y axes.

Nested Class Summary

Nested classes/interfaces inherited from interface ucar.nc2.grid.GridHorizCoordinateSystem

GridHorizCoordinateSystem.CoordReturn

Method Summary

Modifier and Type	Method and Description
static GridHorizCS	create(GridAxis xaxis, GridAxis yaxis, Projection projection)
boolean	equals(Object o)
Optional<GridHorizCoordinateSystem.CoordReturn>	findXYindexFromCoord(double x, double y) From the (x,y) projection point, find the indices and coordinates of the horizontal 2D grid.
ProjectionRect	getBoundingBox() Get horizontal bounding box in projection coordinates.
String	getGeoUnits() Get the horizontal coordinate units, null for latlon.
String	getHorizStaggerType() Horizontal staggering (currently based on WRF).
LatLonPoint	getLatLon(int xindex, int yindex) Get the Lat/Lon coordinates of the midpoint of a grid cell, using the x,y indices
LatLonRect	getLatLonBoundingBox() Get horizontal bounding box in lat, lon coordinates.
Projection	getProjection() Get the horizontal Projection.
List<Range>	getRangesFromLatLonRect(LatLonRect rect) Get Index Ranges for the given lat, lon bounding box.
GridAxis1D	getXHorizAxis() Get the 1D X axis (either GeoX or Lon); null if LatLon2D
GridAxis1D	getYHorizAxis() Get the 1D Y axis (either GeoY or Lat); null if LatLon2D
int	hashCode()
boolean	isGlobalLon() Is this a global coverage over longitude ?
boolean	isLatLon() Does this use lat/lon horizontal axes?
boolean	isRegular() True if both X and Y axes are 1 dimensional and are regularly spaced.
List<GridAxis>	subset(GridSubset params, Formatter errlog) Subset both x and y axis based on the given parameters.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static GridHorizCS create(GridAxis xaxis,
                                 GridAxis yaxis,
                                 @Nullable
                                 Projection projection)

getXHorizAxis

@Nullable
public GridAxis1D getXHorizAxis()

Description copied from interface: GridHorizCoordinateSystem

Get the 1D X axis (either GeoX or Lon); null if LatLon2D

Specified by:

getXHorizAxis in interface GridHorizCoordinateSystem

getYHorizAxis

@Nullable
public GridAxis1D getYHorizAxis()

Description copied from interface: GridHorizCoordinateSystem

Get the 1D Y axis (either GeoY or Lat); null if LatLon2D

Specified by:

getYHorizAxis in interface GridHorizCoordinateSystem

getProjection

public Projection getProjection()

Description copied from interface: GridHorizCoordinateSystem

Get the horizontal Projection.

Specified by:

getProjection in interface GridHorizCoordinateSystem

isLatLon

public boolean isLatLon()

Description copied from interface: GridHorizCoordinateSystem

Does this use lat/lon horizontal axes?

Specified by:

isLatLon in interface GridHorizCoordinateSystem

isGlobalLon

public boolean isGlobalLon()

Description copied from interface: GridHorizCoordinateSystem

Is this a global coverage over longitude ?

Specified by:

isGlobalLon in interface GridHorizCoordinateSystem

isRegular

public boolean isRegular()

Description copied from interface: GridHorizCoordinateSystem

True if both X and Y axes are 1 dimensional and are regularly spaced.

Specified by:

isRegular in interface GridHorizCoordinateSystem

getGeoUnits

@Nullable
public String getGeoUnits()

Description copied from interface: GridHorizCoordinateSystem

Get the horizontal coordinate units, null for latlon. Needed to convert projection units. TODO add to projection directly ??

Specified by:

getGeoUnits in interface GridHorizCoordinateSystem

getHorizStaggerType

@Nullable
public String getHorizStaggerType()

Description copied from interface: GridHorizCoordinateSystem

Horizontal staggering (currently based on WRF).

Specified by:

getHorizStaggerType in interface GridHorizCoordinateSystem

getLatLonBoundingBox

public LatLonRect getLatLonBoundingBox()

Description copied from interface: GridHorizCoordinateSystem

Get horizontal bounding box in lat, lon coordinates. For projection, only an approximation based on corners.

Specified by:

getLatLonBoundingBox in interface GridHorizCoordinateSystem

getBoundingBox

public ProjectionRect getBoundingBox()

Description copied from interface: GridHorizCoordinateSystem

Get horizontal bounding box in projection coordinates.

Specified by:

getBoundingBox in interface GridHorizCoordinateSystem

getLatLon

public LatLonPoint getLatLon(int xindex,
                             int yindex)

Get the Lat/Lon coordinates of the midpoint of a grid cell, using the x,y indices

Parameters:

xindex - x index

yindex - y index

Returns:

lat/lon coordinate of the midpoint of the cell

findXYindexFromCoord

public Optional<GridHorizCoordinateSystem.CoordReturn> findXYindexFromCoord(double x,
                                                                            double y)

Description copied from interface: GridHorizCoordinateSystem

From the (x,y) projection point, find the indices and coordinates of the horizontal 2D grid.

Specified by:

findXYindexFromCoord in interface GridHorizCoordinateSystem

subset

public List<GridAxis> subset(GridSubset params,
                             Formatter errlog)

Description copied from interface: GridHorizCoordinateSystem

Subset both x and y axis based on the given parameters.

Specified by:

subset in interface GridHorizCoordinateSystem

getRangesFromLatLonRect

public List<Range> getRangesFromLatLonRect(LatLonRect rect)
                                    throws InvalidRangeException

Get Index Ranges for the given lat, lon bounding box. For projection, only an approximation based on latlon corners.

Parameters:

rect - the requested lat/lon bounding box

Returns:

list of 2 Range objects, first y then x.

Throws:

InvalidRangeException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object