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 Vertical CoordinateTransform is a function CT: (GeoZ) -> Height or Pressure. 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 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

Modifier	Constructor and Description
protected	VerticalCT(String name, String authority, VerticalCT.Type type, AttributeContainer params)
protected	VerticalCT(VerticalCT.Builder<?> builder)

Method Summary

Modifier and Type	Method and Description
protected VerticalCT.Builder<?>	addLocalFieldsToBuilder(VerticalCT.Builder<? extends VerticalCT.Builder<?>> b)
static VerticalCT.Builder<?>	builder() Get a Builder for VerticalCT.
VerticalCT.Type	getVerticalTransformType() get the Vertical Transform type
VerticalTransform	makeVerticalTransform(NetcdfDataset ds, Dimension timeDim) Make the Vertical Transform function
VerticalCT.Builder<?>	toBuilder() Convert to the mutable Builder.
String	toString()

Methods inherited from class ucar.nc2.dataset.CoordinateTransform

addLocalFieldsToBuilder, compareTo, equals, findParameterIgnoreCase, getAuthority, getCtvAttributes, 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,
                     AttributeContainer params)

VerticalCT

protected VerticalCT(VerticalCT.Builder<?> builder)

Method Detail

getVerticalTransformType

public VerticalCT.Type getVerticalTransformType()

get 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

toString

public String toString()

Overrides:

toString in class CoordinateTransform

toBuilder

public VerticalCT.Builder<?> toBuilder()

Description copied from class: CoordinateTransform

Convert to the mutable Builder.

Specified by:

toBuilder in class CoordinateTransform

addLocalFieldsToBuilder

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

builder

public static VerticalCT.Builder<?> builder()

Get a Builder for VerticalCT.