Package ucar.nc2.dataset.transform

Class CFOceanSigma

java.lang.Object

ucar.nc2.dataset.transform.AbstractTransformBuilder

ucar.nc2.dataset.transform.CFOceanSigma

All Implemented Interfaces:

VertTransformBuilderIF

public class CFOceanSigma
extends AbstractTransformBuilder
implements VertTransformBuilderIF

Create a ocean_sigma_coordinate Vertical Transform from the information in the Coordinate Transform Variable.

Field Summary

Fields inherited from class ucar.nc2.dataset.transform.AbstractTransformBuilder

earth, earth_radius, false_easting, false_northing, lat0, lon0

Constructor Summary

Constructors

Constructor	Description
CFOceanSigma()

Method Summary

Modifier and Type	Method	Description
String	getTransformName()	Get the Transform name.
VerticalCT	makeCoordinateTransform(NetcdfDataset ds, AttributeContainer ctv)	Make a vertical CoordinateTransform from a Coordinate Transform Variable.
VerticalTransform	makeMathTransform(NetcdfDataset ds, Dimension timeDim, VerticalCT vCT)	Make a VerticalTransform.
String	toString()

Methods inherited from class ucar.nc2.dataset.transform.AbstractTransformBuilder

addParameter, getFalseEastingScaleFactor, getFalseEastingScaleFactor, getGeoCoordinateUnits, getGeoCoordinateUnits, readAttributeDouble, setErrorBuffer

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.nc2.dataset.transform.VertTransformBuilderIF

setErrorBuffer

Constructor Detail

CFOceanSigma

public CFOceanSigma()

Method Detail

getTransformName

public String getTransformName()

Description copied from interface: VertTransformBuilderIF

Get the Transform name. Typically this is matched on by an attribute in the dataset.

Specified by:

getTransformName in interface VertTransformBuilderIF

Specified by:

getTransformName in class AbstractTransformBuilder

Returns:

name of the transform.

makeCoordinateTransform

public VerticalCT makeCoordinateTransform(NetcdfDataset ds,
                                          AttributeContainer ctv)

Description copied from interface: VertTransformBuilderIF

Make a vertical CoordinateTransform from a Coordinate Transform Variable. A VerticalCT is just a container for the metadata, the real work is in the VerticalTransform

Specified by:

makeCoordinateTransform in interface VertTransformBuilderIF

Parameters:

ds - the containing dataset

ctv - the coordinate transform variable.

Returns:

CoordinateTransform

toString

public String toString()

Overrides:

toString in class Object

makeMathTransform

public VerticalTransform makeMathTransform(NetcdfDataset ds,
                                           Dimension timeDim,
                                           VerticalCT vCT)

Description copied from interface: VertTransformBuilderIF

Make a VerticalTransform. We need to defer making the transform until we've identified the time coordinate dimension.

Specified by:

makeMathTransform in interface VertTransformBuilderIF

Parameters:

ds - the dataset

timeDim - the time dimension

vCT - the vertical coordinate transform

Returns:

ucar.unidata.geoloc.vertical.VerticalTransform math transform