CoordinateSystem (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.nc2.dataset.CoordinateSystem

Direct Known Subclasses:

GridCoordSys
```
public class CoordinateSystem
extends Object
```
Specifies the coordinates of a Variable's values.
```
 Mathematically it is a vector function F from index space to Sn:
  F(i,j,k,...) -> (S1, S2, ...Sn)
  where i,j,k are integers, and S is the set of reals (R) or Strings.
 
```
The components of F are just its coordinate axes:
```
  F = (A1, A2, ...An)
    A1(i,j,k,...) -> S1
    A2(i,j,k,...) -> S2
    An(i,j,k,...) -> Sn
 
```
Concretely, a CoordinateSystem is a set of coordinate axes, and an optional set of coordinate transforms. The domain rank of F is the number of dimensions it is a function of. The range rank is the number of coordinate axes.
An important class of CoordinateSystems are georeferencing Coordinate Systems, that locate a Variable's values in space and time. A CoordinateSystem that has a Lat and Lon axis, or a GeoX and GeoY axis and a Projection CoordinateTransform will have isGeoReferencing() true. A CoordinateSystem that has a Height, Pressure, or GeoZ axis will have hasVerticalAxis() true.
Further CoordinateSystems specialization is done by "data type specific" classes such as ucar.nc2.ft2.coverage.grid.GridCoordSys.
See Also:

Coordinate System Object Model TODO: make Immutable in ver7.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CoordinateSystem.Builder<T extends CoordinateSystem.Builder<T>>

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected CoordinateAxis`	`aziAxis`
`protected List<CoordinateAxis>`	`coordAxes`
`protected List<CoordinateTransform>`	`coordTrans`
`protected String`	`dataType`
`protected Set<Dimension>`	`domain`
`protected NetcdfDataset`	`ds`
`protected CoordinateAxis`	`elevAxis`
`protected CoordinateAxis`	`ensAxis`
`protected CoordinateAxis`	`hAxis`
`protected boolean`	`isImplicit`
`protected CoordinateAxis`	`latAxis`
`protected CoordinateAxis`	`lonAxis`
`protected String`	`name`
`protected CoordinateAxis`	`pAxis`
`protected CoordinateAxis`	`radialAxis`
`protected CoordinateAxis`	`tAxis`
`protected CoordinateAxis`	`xAxis`
`protected CoordinateAxis`	`yAxis`
`protected CoordinateAxis`	`zAxis`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CoordinateSystem()` Deprecated. Use CoordinateSystem.builder().
`protected`	`CoordinateSystem(CoordinateSystem.Builder<?> builder, NetcdfDataset ncd, List<CoordinateAxis> axesAll, List<CoordinateTransform> allTransforms)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected CoordinateSystem.Builder<?>`	`addLocalFieldsToBuilder(CoordinateSystem.Builder<? extends CoordinateSystem.Builder<?>> b)`
`static CoordinateSystem.Builder<?>`	`builder()` Get a Builder of CoordinateSystem
`boolean`	`containsAxes(List<CoordinateAxis> wantAxes)` Deprecated. do not use
`boolean`	`containsAxis(String axisFullName)` Deprecated. do not use
`boolean`	`containsAxisType(AxisType wantAxisType)` Deprecated. use findAxis(...) != null
`boolean`	`containsAxisTypes(List<AxisType> wantAxes)` Deprecated. use findAxis(...)
`boolean`	`containsDomain(List<Dimension> wantDimensions)` Deprecated. do not use
`static int`	`countDomain(Variable[] axes)` Deprecated. use Dimensions.makeDomain().size()
`boolean`	`equals(Object o)`
`CoordinateAxis`	`findAxis(AxisType... axisType)` Find CoordinateAxis of one of the given types, in the order given.
`CoordinateAxis`	`findAxis(AxisType type)` Find the CoordinateAxis that has the given AxisType.
`CoordinateAxis`	`getAzimuthAxis()` Deprecated. use findAxis(AxisType.RadialAzimuth)
`com.google.common.collect.ImmutableList<CoordinateAxis>`	`getCoordinateAxes()` Get the List of CoordinateAxes
`com.google.common.collect.ImmutableList<CoordinateTransform>`	`getCoordinateTransforms()` Deprecated. use getProjection() or getVerticalCT()
`com.google.common.collect.ImmutableCollection<Dimension>`	`getDomain()` Get the Collection of Dimensions used by any of the CoordinateAxes.
`CoordinateAxis`	`getElevationAxis()` Deprecated. use findAxis(AxisType.RadialElevation)
`CoordinateAxis`	`getEnsembleAxis()` Deprecated. use findAxis(AxisType.Ensemble)
`CoordinateAxis`	`getHeightAxis()` Deprecated. use findAxis(AxisType.Height)
`CoordinateAxis`	`getLatAxis()` Deprecated. use findAxis(AxisType.Lat)
`CoordinateAxis`	`getLonAxis()` Deprecated. use findAxis(AxisType.Lon)
`String`	`getName()` Get the name of the Coordinate System
`NetcdfDataset`	`getNetcdfDataset()` Deprecated. do not use
`CoordinateAxis`	`getPressureAxis()` Deprecated. use findAxis(AxisType.Pressure)
`Projection`	`getProjection()` Get the Projection for this coordinate system.
`ProjectionCT`	`getProjectionCT()` Deprecated. use getProjection()
`CoordinateAxis`	`getRadialAxis()` Deprecated. use findAxis(AxisType.RadialDistance)
`int`	`getRankDomain()` Deprecated. use getDomain().size();
`int`	`getRankRange()` Deprecated. use getCoordinateAxes().size();
`CoordinateAxis`	`getTaxis()` Deprecated. use findAxis(AxisType.Time)
`VerticalCT`	`getVerticalCT()` Get the Vertical Transform for this coordinate system, if any.
`CoordinateAxis`	`getXaxis()` Deprecated. use findAxis(AxisType.GeoX)
`CoordinateAxis`	`getYaxis()` Deprecated. use findAxis(AxisType.GeoY)
`CoordinateAxis`	`getZaxis()` Deprecated. use findAxis(AxisType.GeoZ)
`int`	`hashCode()`
`boolean`	`hasTimeAxis()` Deprecated. use findAxis(...)
`boolean`	`hasVerticalAxis()` Deprecated. use findAxis(...)
`static boolean`	`isComplete(Collection<Dimension> variableDomain, Collection<Dimension> csysDomain)` True if all variableDomain dimensions are contained in csysDomain, or have length < 2.
`boolean`	`isComplete(Variable v)` Check if this Coordinate System is complete for v, ie if all v's dimensions are used by the Coordinate System.
`boolean`	`isCoordinateSystemFor(Variable v)` Check if this Coordinate System can be used for the given variable, by checking if each CoordinateAxis can be used for the Variable.
`boolean`	`isGeoReferencing()` true if isGeoXY or isLatLon
`boolean`	`isGeoXY()` true if it has X and Y CoordinateAxis, and a CoordTransform Projection
`boolean`	`isImplicit()` Implicit Coordinate System are constructed based on which Coordinate Variables exist for the Dimensions of the Variable.
`boolean`	`isLatLon()` true if it has Lat and Lon CoordinateAxis
`boolean`	`isProductSet()` Deprecated. use GridCoordinateSystem.isProductSet()
`boolean`	`isRadial()` true if it has radial distance and azimuth CoordinateAxis
`boolean`	`isRegular()` Deprecated. do not use
`static boolean`	`isSubset(Collection<Dimension> subset, Collection<Dimension> set)` Deprecated. use Dimensions.isSubset()
`static boolean`	`isSubset(Set<String> subset, Set<String> set)` Deprecated. use Dimensions.isSubset()
`static Set<Dimension>`	`makeDomain(Iterable<? extends Variable> axes)` Deprecated. use `Dimensions.makeDomain(java.lang.Iterable<? extends ucar.nc2.Variable>, boolean)`
`static String`	`makeName(List<CoordinateAxis> axes)` Create standard name from list of axes.
`CoordinateSystem.Builder<?>`	`toBuilder()` Convert to a mutable Builder.
`String`	`toString()`

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

- Field Detail
  - ds
```
protected NetcdfDataset ds
```
  - coordAxes
```
protected List<CoordinateAxis> coordAxes
```
  - coordTrans
```
protected List<CoordinateTransform> coordTrans
```
  - name
```
protected String name
```
  - domain
```
protected Set<Dimension> domain
```
  - xAxis
```
protected CoordinateAxis xAxis
```
  - yAxis
```
protected CoordinateAxis yAxis
```
  - zAxis
```
protected CoordinateAxis zAxis
```
  - tAxis
```
protected CoordinateAxis tAxis
```
  - latAxis
```
protected CoordinateAxis latAxis
```
  - lonAxis
```
protected CoordinateAxis lonAxis
```
  - hAxis
```
protected CoordinateAxis hAxis
```
  - pAxis
```
protected CoordinateAxis pAxis
```
  - ensAxis
```
protected CoordinateAxis ensAxis
```
  - aziAxis
```
protected CoordinateAxis aziAxis
```
  - elevAxis
```
protected CoordinateAxis elevAxis
```
  - radialAxis
```
protected CoordinateAxis radialAxis
```
  - isImplicit
```
protected boolean isImplicit
```
  - dataType
```
protected String dataType
```
- Constructor Detail
  - CoordinateSystem
```
@Deprecated
protected CoordinateSystem()
```
    Deprecated. Use CoordinateSystem.builder().
    
    TODO needed for GridCoordSys, remove in ver7
  - CoordinateSystem
```
protected CoordinateSystem(CoordinateSystem.Builder<?> builder,
                           NetcdfDataset ncd,
                           List<CoordinateAxis> axesAll,
                           List<CoordinateTransform> allTransforms)
```
- Method Detail
  - makeName
```
public static String makeName(List<CoordinateAxis> axes)
```
    Create standard name from list of axes. Sort the axes first
    
    Parameters:
    
    axes - list of CoordinateAxis
    
    Returns:
    
    CoordinateSystem name, created from axes names
  - getCoordinateAxes
```
public com.google.common.collect.ImmutableList<CoordinateAxis> getCoordinateAxes()
```
    Get the List of CoordinateAxes
  - getCoordinateTransforms
```
@Deprecated
public com.google.common.collect.ImmutableList<CoordinateTransform> getCoordinateTransforms()
```
    Deprecated. use getProjection() or getVerticalCT()
    
    Get the List of CoordinateTransforms.
  - getName
```
public String getName()
```
    Get the name of the Coordinate System
  - getNetcdfDataset
```
@Deprecated
public NetcdfDataset getNetcdfDataset()
```
    Deprecated. do not use
    
    Get the underlying NetcdfDataset
  - getDomain
```
public com.google.common.collect.ImmutableCollection<Dimension> getDomain()
```
    Get the Collection of Dimensions used by any of the CoordinateAxes.
  - getRankDomain
```
@Deprecated
public int getRankDomain()
```
    Deprecated. use getDomain().size();
    
    Get the domain rank of the coordinate system = number of dimensions it is a function of.
    
    Returns:
    
    domain.size()
  - getRankRange
```
@Deprecated
public int getRankRange()
```
    Deprecated. use getCoordinateAxes().size();
    
    Get the range rank of the coordinate system = number of coordinate axes.
    
    Returns:
    
    coordAxes.size()
  - findAxis
```
@Nullable
public CoordinateAxis findAxis(AxisType type)
```
    Find the CoordinateAxis that has the given AxisType. If more than one, return the one with lesser rank.
    
    Parameters:
    
    type - look for this axisType
    
    Returns:
    
    CoordinateAxis of the given AxisType, else null.
  - findAxis
```
@Nullable
public CoordinateAxis findAxis(AxisType... axisType)
```
    Find CoordinateAxis of one of the given types, in the order given.
  - getXaxis
```
@Deprecated
public CoordinateAxis getXaxis()
```
    Deprecated. use findAxis(AxisType.GeoX)
    
    get the CoordinateAxis with AxisType.GeoX, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.GeoX, or null if none
  - getYaxis
```
@Deprecated
public CoordinateAxis getYaxis()
```
    Deprecated. use findAxis(AxisType.GeoY)
    
    get the CoordinateAxis with AxisType.GeoY, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.GeoY, or null if none
  - getZaxis
```
@Deprecated
public CoordinateAxis getZaxis()
```
    Deprecated. use findAxis(AxisType.GeoZ)
    
    get the CoordinateAxis with AxisType.GeoZ, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.GeoZ, or null if none
  - getTaxis
```
@Deprecated
public CoordinateAxis getTaxis()
```
    Deprecated. use findAxis(AxisType.Time)
    
    get the CoordinateAxis with AxisType.Time, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.Time, or null if none
  - getLatAxis
```
@Deprecated
public CoordinateAxis getLatAxis()
```
    Deprecated. use findAxis(AxisType.Lat)
    
    get the CoordinateAxis with AxisType.Lat, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.Lat, or null if none
  - getLonAxis
```
@Deprecated
public CoordinateAxis getLonAxis()
```
    Deprecated. use findAxis(AxisType.Lon)
    
    get the CoordinateAxis with AxisType.Lon, or null if none. if more than one, choose one with smallest rank *
    
    Returns:
    
    axis of type AxisType.Lon, or null if none
  - getHeightAxis
```
@Deprecated
public CoordinateAxis getHeightAxis()
```
    Deprecated. use findAxis(AxisType.Height)
    
    get the CoordinateAxis with AxisType.Height, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.Height, or null if none
  - getPressureAxis
```
@Deprecated
public CoordinateAxis getPressureAxis()
```
    Deprecated. use findAxis(AxisType.Pressure)
    
    get the CoordinateAxis with AxisType.Pressure, or null if none. if more than one, choose one with smallest rank.
    
    Returns:
    
    axis of type AxisType.Pressure, or null if none
  - getEnsembleAxis
```
@Deprecated
public CoordinateAxis getEnsembleAxis()
```
    Deprecated. use findAxis(AxisType.Ensemble)
    
    get the CoordinateAxis with AxisType.Ensemble, or null if none. if more than one, choose one with smallest rank.
    
    Returns:
    
    axis of type AxisType.Ensemble, or null if none
  - getAzimuthAxis
```
@Deprecated
public CoordinateAxis getAzimuthAxis()
```
    Deprecated. use findAxis(AxisType.RadialAzimuth)
    
    get the CoordinateAxis with AxisType.RadialAzimuth, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.RadialAzimuth, or null if none
  - getRadialAxis
```
@Deprecated
public CoordinateAxis getRadialAxis()
```
    Deprecated. use findAxis(AxisType.RadialDistance)
    
    get the CoordinateAxis with AxisType.RadialDistance, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.RadialDistance, or null if none
  - getElevationAxis
```
@Deprecated
public CoordinateAxis getElevationAxis()
```
    Deprecated. use findAxis(AxisType.RadialElevation)
    
    get the CoordinateAxis with AxisType.RadialElevation, or null if none. if more than one, choose one with smallest rank
    
    Returns:
    
    axis of type AxisType.RadialElevation, or null if none
  - getProjectionCT
```
@Deprecated
public ProjectionCT getProjectionCT()
```
    Deprecated. use getProjection()
    
    Find the first ProjectionCT from the list of CoordinateTransforms.
    
    Returns:
    
    ProjectionCT or null if none.
  - getProjection
```
@Nullable
public Projection getProjection()
```
    Get the Projection for this coordinate system. If isLatLon(), then returns a LatLonProjection. Otherwise, extracts the projection from any ProjectionCT CoordinateTransform.
    
    Returns:
    
    Projection or null if none.
  - getVerticalCT
```
@Nullable
public VerticalCT getVerticalCT()
```
    Get the Vertical Transform for this coordinate system, if any.
  - isGeoXY
```
public boolean isGeoXY()
```
    true if it has X and Y CoordinateAxis, and a CoordTransform Projection
    
    Returns:
    
    true if it has X and Y CoordinateAxis, and a CoordTransform Projection
  - isLatLon
```
public boolean isLatLon()
```
    true if it has Lat and Lon CoordinateAxis
    
    Returns:
    
    true if it has Lat and Lon CoordinateAxis
  - isRadial
```
public boolean isRadial()
```
    true if it has radial distance and azimuth CoordinateAxis
    
    Returns:
    
    true if it has radial distance and azimuth CoordinateAxis
  - isGeoReferencing
```
public boolean isGeoReferencing()
```
    true if isGeoXY or isLatLon
    
    Returns:
    
    true if isGeoXY or isLatLon
  - isProductSet
```
@Deprecated
public boolean isProductSet()
```
    Deprecated. use GridCoordinateSystem.isProductSet()
    
    true if all axes are CoordinateAxis1D
    
    Returns:
    
    true if all axes are CoordinateAxis1D
  - isRegular
```
@Deprecated
public boolean isRegular()
```
    Deprecated. do not use
    
    true if all axes are CoordinateAxis1D and are regular
    
    Returns:
    
    true if all axes are CoordinateAxis1D and are regular
  - isComplete
```
public boolean isComplete(Variable v)
```
    Check if this Coordinate System is complete for v, ie if all v's dimensions are used by the Coordinate System. Exclude dimensions with length < 2.
  - isComplete
```
public static boolean isComplete(Collection<Dimension> variableDomain,
                                 Collection<Dimension> csysDomain)
```
    True if all variableDomain dimensions are contained in csysDomain, or have length < 2.
  - isCoordinateSystemFor
```
public boolean isCoordinateSystemFor(Variable v)
```
    Check if this Coordinate System can be used for the given variable, by checking if each CoordinateAxis can be used for the Variable. A CoordinateAxis can only be used if the CoordinateAxis' set of Dimensions is a subset of the Variable's set of Dimensions.
  - isSubset
```
@Deprecated
public static boolean isSubset(Collection<Dimension> subset,
                                            Collection<Dimension> set)
```
    Deprecated. use Dimensions.isSubset()
    
    Test if all the Dimensions in subset are in set
    
    Parameters:
    
    subset - is this a subset
    
    set - of this?
    
    Returns:
    
    true if all the Dimensions in subset are in set
  - isSubset
```
@Deprecated
public static boolean isSubset(Set<String> subset,
                                            Set<String> set)
```
    Deprecated. use Dimensions.isSubset()
  - makeDomain
```
@Deprecated
public static Set<Dimension> makeDomain(Iterable<? extends Variable> axes)
```
    Deprecated. use Dimensions.makeDomain(java.lang.Iterable<? extends ucar.nc2.Variable>, boolean)
  - countDomain
```
@Deprecated
public static int countDomain(Variable[] axes)
```
    Deprecated. use Dimensions.makeDomain().size()
  - isImplicit
```
public boolean isImplicit()
```
    Implicit Coordinate System are constructed based on which Coordinate Variables exist for the Dimensions of the Variable. This is in contrast to a Coordinate System that is explicitly specified in the file.
  - hasVerticalAxis
```
@Deprecated
public boolean hasVerticalAxis()
```
    Deprecated. use findAxis(...)
    
    true if has Height, Pressure, or GeoZ axis
    
    Returns:
    
    true if has a vertical axis
  - hasTimeAxis
```
@Deprecated
public boolean hasTimeAxis()
```
    Deprecated. use findAxis(...)
    
    true if has Time axis
    
    Returns:
    
    true if has Time axis
  - containsAxes
```
@Deprecated
public boolean containsAxes(List<CoordinateAxis> wantAxes)
```
    Deprecated. do not use
    
    Do we have all the axes in wantAxes, matching on full name.
  - containsAxis
```
@Deprecated
public boolean containsAxis(String axisFullName)
```
    Deprecated. do not use
    
    Do we have the named axis?
    
    Parameters:
    
    axisFullName - (full unescaped) name of axis
    
    Returns:
    
    true if we have an axis of that name
  - containsDomain
```
@Deprecated
public boolean containsDomain(List<Dimension> wantDimensions)
```
    Deprecated. do not use
    
    Do we have all the dimensions in wantDimensions?
  - containsAxisTypes
```
@Deprecated
public boolean containsAxisTypes(List<AxisType> wantAxes)
```
    Deprecated. use findAxis(...)
    
    Do we have all the axes types in wantAxes?
  - containsAxisType
```
@Deprecated
public boolean containsAxisType(AxisType wantAxisType)
```
    Deprecated. use findAxis(...) != null
    
    Do we have an axis of the given type?
    
    Parameters:
    
    wantAxisType - want this AxisType
    
    Returns:
    
    true if we have at least one axis of that type.
  - 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
  - toBuilder
```
public CoordinateSystem.Builder<?> toBuilder()
```
    Convert to a mutable Builder.
  - addLocalFieldsToBuilder
```
protected CoordinateSystem.Builder<?> addLocalFieldsToBuilder(CoordinateSystem.Builder<? extends CoordinateSystem.Builder<?>> b)
```
  - builder
```
public static CoordinateSystem.Builder<?> builder()
```
    Get a Builder of CoordinateSystem

Class CoordinateSystem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ds

coordAxes

coordTrans

name

domain

xAxis

yAxis

zAxis

tAxis

latAxis

lonAxis

hAxis

pAxis

ensAxis

aziAxis

elevAxis

radialAxis

isImplicit

dataType

Constructor Detail

CoordinateSystem

CoordinateSystem

Method Detail

makeName

getCoordinateAxes

getCoordinateTransforms

getName

getNetcdfDataset

getDomain

getRankDomain

getRankRange

findAxis

findAxis

getXaxis

getYaxis

getZaxis

getTaxis

getLatAxis

getLonAxis

getHeightAxis

getPressureAxis

getEnsembleAxis

getAzimuthAxis

getRadialAxis

getElevationAxis

getProjectionCT

getProjection

getVerticalCT

isGeoXY

isLatLon

isRadial

isGeoReferencing

isProductSet

isRegular

isComplete

isComplete

isCoordinateSystemFor

isSubset

isSubset

makeDomain

countDomain

isImplicit

hasVerticalAxis

hasTimeAxis

containsAxes

containsAxis

containsDomain

containsAxisTypes

containsAxisType

equals

hashCode

toString

toBuilder