ucar.nc2.dataset

Class VerticalCT

java.lang.Object

ucar.nc2.dataset.CoordinateTransform

ucar.nc2.dataset.VerticalCT

All Implemented Interfaces:

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.

Constructor Summary

Constructors

Constructor and Description
VerticalCT(String name, String authority, VerticalCT.Type type, ucar.nc2.dataset.transform.VertTransformBuilderIF builder) Create a Vertical Coordinate Transform.
VerticalCT(VerticalCT from) Deprecated. use builder

Method Summary

Modifier and Type	Method and Description
static VerticalCT.Builder<?>	builder()
ucar.nc2.dataset.transform.VertTransformBuilderIF	getTransformBuilder() Deprecated. do not use
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()
String	toString()

Methods inherited from class ucar.nc2.dataset.CoordinateTransform

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VerticalCT

public VerticalCT(String name,
                  String authority,
                  VerticalCT.Type type,
                  ucar.nc2.dataset.transform.VertTransformBuilderIF 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

@Deprecated
public VerticalCT(VerticalCT from)

Deprecated. use builder

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 ucar.unidata.geoloc.vertical.VerticalTransform makeVerticalTransform(NetcdfDataset ds,
                                                                            Dimension timeDim)

Make the Vertical Transform function

Parameters:

ds - containing dataset

timeDim - time Dimension

Returns:

VerticalTransform

getTransformBuilder

@Deprecated
public ucar.nc2.dataset.transform.VertTransformBuilderIF getTransformBuilder()

Deprecated. do not use

get the CoordTransBuilderIF

Returns:

builder

toString

public String toString()

Overrides:

toString in class CoordinateTransform

toBuilder

public VerticalCT.Builder<?> toBuilder()

Overrides:

toBuilder in class CoordinateTransform

builder

public static VerticalCT.Builder<?> builder()