ucar.nc2.dataset.conv
Class CF1Convention

java.lang.Object
  ucar.nc2.dataset.CoordSysBuilder
      ucar.nc2.dataset.conv.COARDSConvention
          ucar.nc2.dataset.conv.CSMConvention
              ucar.nc2.dataset.conv.CF1Convention

All Implemented Interfaces:

CoordSysBuilderIF

public class CF1Convention
extends CSMConvention

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."

Author:

caron

Nested Class Summary

Nested classes/interfaces inherited from class ucar.nc2.dataset.CoordSysBuilder

CoordSysBuilder.VarProcess

Field Summary

Fields inherited from class ucar.nc2.dataset.conv.CSMConvention

ctHash

Fields inherited from class ucar.nc2.dataset.CoordSysBuilder

conventionName, coordVarMap, debug, log, parseInfo, resourcesDir, showRejects, userAdvice, varList

Constructor Summary

CF1Convention()

Method Summary

void	augmentDataset(NetcdfDataset ds, CancelTask cancelTask) This is where subclasses make changes to the dataset, like adding new variables, attribuites, etc.
protected AxisType	getAxisType(NetcdfDataset ncDataset, VariableEnhanced v) Augment CSM axis type identification with "projection_x_coordinate", "projection_y_coordinate" and the various dimensionless vertical coordinates

Methods inherited from class ucar.nc2.dataset.conv.CSMConvention

addParameter2, findCoordinateAxes, makeCoordinateTransform

Methods inherited from class ucar.nc2.dataset.CoordSysBuilder

addCoordinateSystems, addCoordinateVariable, addUserAdvice, assignCoordinateTransforms, assignExplicitCoordinateSystems, buildCoordinateSystems, findCoordinateAxis, findCoordinateSystems, findCoordinateTransforms, findVarProcess, getConventionUsed, getParseInfo, getUseMaximalCoordSys, getUserAdvice, hasXY, isCoordinateAxisForVariable, makeCoordinateAxes, makeCoordinateSystems, makeCoordinateSystemsImplicit, makeCoordinateSystemsMaximal, makeCoordinateTransforms, makeCoordinateTransformVariable, makeDummyTransformVariable, registerConvention, registerConvention, registerNcML, setConventionUsed, setUseMaximalCoordSys

Methods inherited from class java.lang.Object

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

Constructor Detail

CF1Convention

public CF1Convention()

Method Detail

augmentDataset

public void augmentDataset(NetcdfDataset ds,
                           CancelTask cancelTask)

Description copied from class: CoordSysBuilder

This is where subclasses make changes to the dataset, like adding new variables, attribuites, etc.

Specified by:

augmentDataset in interface CoordSysBuilderIF

Overrides:

augmentDataset in class CSMConvention

Parameters:

ds - modify this dataset

cancelTask - give user a chance to bail out

getAxisType

protected AxisType getAxisType(NetcdfDataset ncDataset,
                               VariableEnhanced v)

Augment CSM axis type identification with "projection_x_coordinate", "projection_y_coordinate" and the various dimensionless vertical coordinates

Overrides:

getAxisType in class COARDSConvention

Parameters:

ncDataset - for this dataset

v - a variable alreaddy identified as a Coodinate Axis

Returns:

AxisType or null if unknown.