ucar.nc2.dataset
Class VerticalCT

java.lang.Object
  extended by ucar.nc2.dataset.CoordinateTransform
      extended by ucar.nc2.dataset.VerticalCT
All Implemented Interfaces:
java.lang.Comparable

@Immutable
public class VerticalCT
extends CoordinateTransform

A VerticalCT is a CoordinateTransform function CT: (GeoZ) -> Height or Pressure. Typically it may be dependent also on X,Y and/or Time. CT: (X,Y,GeoZ,Time) -> Height or Pressure. This class just records the transformation parameters. The mathematical transformation itself is delegated to a class implementing ucar.unidata.geoloc.vertical.VerticalTransform.

Author:
caron

Nested Class Summary
static class VerticalCT.Type
          Enumeration of known Vertical transformations.
 
Constructor Summary
VerticalCT(java.lang.String name, java.lang.String authority, VerticalCT.Type type, CoordTransBuilderIF builder)
          Create a Vertical Coordinate Transform.
VerticalCT(VerticalCT from)
          Copy Constructor
 
Method Summary
 CoordTransBuilderIF getBuilder()
          get the CoordTransBuilderIF
 VerticalCT.Type getVerticalTransformType()
          get the Vertical Transform type
 VerticalTransform makeVerticalTransform(NetcdfDataset ds, Dimension timeDim)
          Use the builder to make the Vertical Transform function
 java.lang.String toString()
           
 
Methods inherited from class ucar.nc2.dataset.CoordinateTransform
addParameter, compareTo, equals, findParameterIgnoreCase, getAuthority, getName, getParameters, getTransformType, hashCode
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VerticalCT

public VerticalCT(java.lang.String name,
                  java.lang.String authority,
                  VerticalCT.Type type,
                  CoordTransBuilderIF builder)
Create a Vertical Coordinate Transform.

Parameters:
name - name of transform, must be unique within the dataset.
authority - naming authority.
type - type of vertical transform
builder - creates the VerticalTransform

VerticalCT

public VerticalCT(VerticalCT from)
Copy Constructor

Parameters:
from - copy from this one
Method Detail

getVerticalTransformType

public VerticalCT.Type getVerticalTransformType()
get the Vertical Transform type

Returns:
the Vertical Transform Type

makeVerticalTransform

public VerticalTransform makeVerticalTransform(NetcdfDataset ds,
                                               Dimension timeDim)
Use the builder to make the Vertical Transform function

Parameters:
ds - containing dataset
timeDim - time Dimension
Returns:
VerticalTransform
See Also:
CoordTransBuilderIF.makeMathTransform(ucar.nc2.dataset.NetcdfDataset, ucar.nc2.Dimension, ucar.nc2.dataset.VerticalCT)

getBuilder

public CoordTransBuilderIF getBuilder()
get the CoordTransBuilderIF

Returns:
builder

toString

public java.lang.String toString()
Overrides:
toString in class CoordinateTransform