ucar.nc2.internal.dataset.conv

Class CF1Convention

java.lang.Object

ucar.nc2.internal.dataset.CoordSystemBuilder

ucar.nc2.internal.dataset.conv.CF1Convention

Direct Known Subclasses:

CEDRICRadarConvention

public class CF1Convention
extends CoordSystemBuilder

CF-1 Convention. see http://www.cgd.ucar.edu/cms/eaton/cf-metadata/index.html

"The CF conventions for climate and forecast metadata are designed to promote the processing and sharing of files created with the netCDF API. The conventions define metadata that provide a definitive description of what the data in each variable represents, and of the spatial and temporal properties of the data. This enables users of data from different sources to decide which quantities are comparable, and facilitates building applications with powerful extraction, regridding, and display capabilities."

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CF1Convention.Factory

Nested classes/interfaces inherited from class ucar.nc2.internal.dataset.CoordSystemBuilder

CoordSystemBuilder.VarProcess

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	checkForMeter

Fields inherited from class ucar.nc2.internal.dataset.CoordSystemBuilder

conventionName, coords, coordVarsForDimension, datasetBuilder, debug, log, parseInfo, rootGroup, userAdvice, varList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CF1Convention(NetcdfDataset.Builder datasetBuilder)

Method Summary

Modifier and Type	Method and Description
protected void	augmentDataset(CancelTask cancelTask)
protected void	augmentGroup(Group.Builder gb, CancelTask cancelTask)
protected void	augmentGroups(Group.Builder gb, CancelTask cancelTask)
AxisType	getAxisType(VariableDS.Builder vb) Augment COARDS axis type identification with Standard names (including dimensionless vertical coordinates) and CF.AXIS attributes
static int	getVersion(java.lang.String hasConvName) Get which CF version this is, ie CF-1.x
static java.lang.String	getZisPositive(java.lang.String zaxisName, java.lang.String vertCoordUnits) Guess the value of ZisPositive based on z axis name and units
protected void	identifyCoordinateAxes() Everything named in the coordinateAxes or coordinates attribute are Coordinate axes.

Methods inherited from class ucar.nc2.internal.dataset.CoordSystemBuilder

addUserAdvice, assignCoordinateSystemsExplicit, assignCoordinateTransforms, buildCoordinateSystems, countDomainSize, findCoordinateAxis, findVarProcess, getConventionUsed, getParseInfo, getUserAdvice, identifyCoordinateSystems, identifyCoordinateTransforms, isCoordinateAxisForVariable, isCoordinateVariable, makeCoordinateAxes, makeCoordinateSystems, makeCoordinateSystemsImplicit, makeCoordinateTransform, makeCoordinateTransforms, makeCoordinateTransformVariable, setConventionUsed

Methods inherited from class java.lang.Object

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

Field Detail

checkForMeter

protected boolean checkForMeter

Constructor Detail

CF1Convention

protected CF1Convention(NetcdfDataset.Builder datasetBuilder)

Method Detail

getVersion

public static int getVersion(java.lang.String hasConvName)

Get which CF version this is, ie CF-1.x

Parameters:

hasConvName - extract from convention name or list of names

Returns:

version, or -1 if not CF

getZisPositive

public static java.lang.String getZisPositive(java.lang.String zaxisName,
                                              java.lang.String vertCoordUnits)

Guess the value of ZisPositive based on z axis name and units

Parameters:

zaxisName - z coordinate axis name

vertCoordUnits - z coordinate axis name

Returns:

CF.POSITIVE_UP or CF.POSITIVE_DOWN

augmentDataset

protected void augmentDataset(CancelTask cancelTask)
                       throws java.io.IOException

Throws:

java.io.IOException

augmentGroups

protected void augmentGroups(Group.Builder gb,
                             CancelTask cancelTask)
                      throws java.io.IOException

Throws:

java.io.IOException

augmentGroup

protected void augmentGroup(Group.Builder gb,
                            CancelTask cancelTask)
                     throws java.io.IOException

Throws:

java.io.IOException

getAxisType

public AxisType getAxisType(VariableDS.Builder vb)

Augment COARDS axis type identification with Standard names (including dimensionless vertical coordinates) and CF.AXIS attributes

Parameters:

vb - a variable already identified as a Coordinate Axis

Returns:

AxisType or null if unknown.

identifyCoordinateAxes

protected void identifyCoordinateAxes()

Description copied from class: CoordSystemBuilder

Everything named in the coordinateAxes or coordinates attribute are Coordinate axes.

Overrides:

identifyCoordinateAxes in class CoordSystemBuilder