Package ucar.nc2.grid

Class GridCoordinateSystem

java.lang.Object

ucar.nc2.grid.GridCoordinateSystem

public class GridCoordinateSystem
extends Object

A Coordinate System for gridded data, consisting of orthogonal 1D GridAxes. In some cases, the shape is an approximation, so that when reading data, the returned Array in MaterializedCoordinateSyste will have a different shape, reflecting the actual data.

Constructor Summary

Constructors

Constructor	Description
GridCoordinateSystem(List<GridAxis<?>> axes, GridTimeCoordinateSystem tcs, VerticalTransform verticalTransform, GridHorizCoordinateSystem hcs)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<GridAxis<?>>	findAxis(String axisName)	Find the named axis.
GridAxis<?>	findCoordAxisByType(AxisType... axisType)	Find the first axis having one of the given AxisTypes.
GridAxisPoint	getEnsembleAxis()	Get the ensemble axis, if any.
FeatureType	getFeatureType()	Always GRID or CURVILINEAR.
List<GridAxis<?>>	getGridAxes()	The GridAxes that constitute this Coordinate System.
GridHorizCoordinateSystem	getHorizCoordinateSystem()	Get the Horizontal CoordinateSystem.
String	getName()	The name of the Grid Coordinate System.
List<Integer>	getNominalShape()	Nominal shape, may differ from materialized shape.
GridTimeCoordinateSystem	getTimeCoordinateSystem()	Get the Time CoordinateSystem.
GridAxis<?>	getVerticalAxis()	Get the Z axis (GeoZ, Height, Pressure), if any.
VerticalTransform	getVerticalTransform()	Get the vertical transform, if any.
GridAxisPoint	getXHorizAxis()	Get the X axis (either GeoX or Lon).
GridAxisPoint	getYHorizAxis()	Get the Y axis (either GeoY or Lat).
int	hashCode()
boolean	isZPositive()	True if increasing z coordinate values means "up" in altitude
String	showFnSummary()	Function description, eg GRID(T,Z,Y,Z):R
Optional<MaterializedCoordinateSystem>	subset(GridSubset params, Formatter errlog)	Create a MaterializedCoordinateSystem based on the supplied subset parameters.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GridCoordinateSystem

public GridCoordinateSystem(List<GridAxis<?>> axes,
                            @Nullable
                            GridTimeCoordinateSystem tcs,
                            @Nullable
                            VerticalTransform verticalTransform,
                            GridHorizCoordinateSystem hcs)

Method Detail

getName

public String getName()

The name of the Grid Coordinate System.

getFeatureType

public FeatureType getFeatureType()

Always GRID or CURVILINEAR.

getGridAxes

public List<GridAxis<?>> getGridAxes()

The GridAxes that constitute this Coordinate System.

findAxis

public Optional<GridAxis<?>> findAxis(String axisName)

Find the named axis.

findCoordAxisByType

@Nullable
public GridAxis<?> findCoordAxisByType(AxisType... axisType)

Find the first axis having one of the given AxisTypes. Search in order given.

getTimeCoordinateSystem

public GridTimeCoordinateSystem getTimeCoordinateSystem()

Get the Time CoordinateSystem. Null if there are no time coordinates.

getEnsembleAxis

@Nullable
public GridAxisPoint getEnsembleAxis()

Get the ensemble axis, if any.

getVerticalAxis

@Nullable
public GridAxis<?> getVerticalAxis()

Get the Z axis (GeoZ, Height, Pressure), if any.

getVerticalTransform

@Nullable
public VerticalTransform getVerticalTransform()

Get the vertical transform, if any.

isZPositive

public boolean isZPositive()

True if increasing z coordinate values means "up" in altitude

getXHorizAxis

public GridAxisPoint getXHorizAxis()

Get the X axis (either GeoX or Lon).

getYHorizAxis

public GridAxisPoint getYHorizAxis()

Get the Y axis (either GeoY or Lat).

getHorizCoordinateSystem

public GridHorizCoordinateSystem getHorizCoordinateSystem()

Get the Horizontal CoordinateSystem.

getNominalShape

public List<Integer> getNominalShape()

Nominal shape, may differ from materialized shape.

subset

public Optional<MaterializedCoordinateSystem> subset(GridSubset params,
                                                     Formatter errlog)

Create a MaterializedCoordinateSystem based on the supplied subset parameters.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

showFnSummary

public String showFnSummary()

Function description, eg GRID(T,Z,Y,Z):R