ucar.nc2.dataset

Class VerticalCT

java.lang.Object

ucar.nc2.dataset.CoordinateTransform

ucar.nc2.dataset.VerticalCT

All Implemented Interfaces:

java.lang.Comparable<CoordinateTransform>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VerticalCT.Builder<T extends VerticalCT.Builder<T>>
static class	VerticalCT.Type Enumeration of known Vertical transformations.

Method Summary

Modifier and Type	Method and Description
static VerticalCT.Builder<?>	builder()
VerticalCT.Type	getVerticalTransformType() get the Vertical Transform type
ucar.unidata.geoloc.vertical.VerticalTransform	makeVerticalTransform(NetcdfDataset ds, Dimension timeDim) Make the Vertical Transform function
VerticalCT.Builder<?>	toBuilder()
java.lang.String	toString()

Methods inherited from class ucar.nc2.dataset.CoordinateTransform

compareTo, equals, findParameterIgnoreCase, getAttributeContainer, getAuthority, getName, getParameters, getTransformType, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static VerticalCT.Builder<?> builder()

getVerticalTransformType

public VerticalCT.Type getVerticalTransformType()

get the Vertical Transform type

Returns:

the Vertical Transform Type

makeVerticalTransform

public ucar.unidata.geoloc.vertical.VerticalTransform makeVerticalTransform(NetcdfDataset ds,
                                                                            Dimension timeDim)

Make the Vertical Transform function

Parameters:

ds - containing dataset

timeDim - time Dimension

Returns:

VerticalTransform

toBuilder

public VerticalCT.Builder<?> toBuilder()

Overrides:

toBuilder in class CoordinateTransform

toString

public java.lang.String toString()

Overrides:

toString in class CoordinateTransform