Package 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	Description
static class	VerticalCT.Builder<T extends VerticalCT.Builder<T>>
static class	VerticalCT.Type	Enumeration of known Vertical transformations.

Field Summary

Fields inherited from class ucar.nc2.dataset.CoordinateTransform

authority, name, params, transformType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VerticalCT(String name, String authority, VerticalCT.Type type, List<Parameter> params)
	VerticalCT(String name, String authority, VerticalCT.Type type, VertTransformBuilderIF builder)	Deprecated. use builder
	VerticalCT(VerticalCT from)	Deprecated. use builder
protected	VerticalCT(VerticalCT.Builder<?> builder, NetcdfDataset ncd)

Method Summary

Modifier and Type	Method	Description
protected VerticalCT.Builder<?>	addLocalFieldsToBuilder(VerticalCT.Builder<? extends VerticalCT.Builder<?>> b)
static VerticalCT.Builder<?>	builder()
VertTransformBuilderIF	getTransformBuilder()	Deprecated. do not use
VerticalCT.Type	getVerticalTransformType()	get the Vertical Transform type
VerticalTransform	makeVerticalTransform(NetcdfDataset ds, Dimension timeDim)	Make the Vertical Transform function
VerticalCT.Builder<?>	toBuilder()
String	toString()

Methods inherited from class ucar.nc2.dataset.CoordinateTransform

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VerticalCT

protected VerticalCT(String name,
                     String authority,
                     VerticalCT.Type type,
                     List<Parameter> params)

VerticalCT

@Deprecated
public VerticalCT(String name,
                  String authority,
                  VerticalCT.Type type,
                  VertTransformBuilderIF builder)

Deprecated.

use 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

VerticalCT

protected VerticalCT(VerticalCT.Builder<?> builder,
                     NetcdfDataset ncd)

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)

Make the Vertical Transform function

Parameters:

ds - containing dataset

timeDim - time Dimension

Returns:

VerticalTransform

getTransformBuilder

@Deprecated
public 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

addLocalFieldsToBuilder

protected VerticalCT.Builder<?> addLocalFieldsToBuilder(VerticalCT.Builder<? extends VerticalCT.Builder<?>> b)

builder

public static VerticalCT.Builder<?> builder()