Package ucar.unidata.geoloc.vertical

Class HybridHeight

java.lang.Object

ucar.unidata.geoloc.vertical.VerticalTransformImpl

ucar.unidata.geoloc.vertical.HybridHeight

All Implemented Interfaces:

VerticalTransform

public class HybridHeight
extends VerticalTransformImpl

Create a 3D height(z,y,x) array using the netCDF CF convention formula for "Atmospheric Hybrid Height".

height(x,y,z) = a(z) + b(z)*orog(x,y)

See Also:

http://cf-pcmdi.llnl.gov/

Field Summary

Fields

Modifier and Type	Field	Description
static String	A	The "a" variable name identifier
static String	B	The "b" variable name identifier
static String	OROG	Surface pressure name identifier

Fields inherited from class ucar.unidata.geoloc.vertical.VerticalTransformImpl

units

Constructor Summary

Constructors

Constructor	Description
HybridHeight(NetcdfFile ds, Dimension timeDim, List<Parameter> params)	Construct a coordinate transform for hybrid height

Method Summary

Modifier and Type	Method	Description
ArrayDouble.D3	getCoordinateArray(int timeIndex)	Get the 3D vertical coordinate array for this time step.
ArrayDouble.D1	getCoordinateArray1D(int timeIndex, int xIndex, int yIndex)	Get the 1D vertical coordinate array for this time step and point

Methods inherited from class ucar.unidata.geoloc.vertical.VerticalTransformImpl

getParameterBooleanValue, getParameterStringValue, getTimeDimension, getUnitString, isTimeDependent, readArray, subset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OROG

public static final String OROG

Surface pressure name identifier

See Also:

Constant Field Values

A

public static final String A

The "a" variable name identifier

See Also:

Constant Field Values

B

public static final String B

The "b" variable name identifier

See Also:

Constant Field Values

Constructor Detail

HybridHeight

public HybridHeight(NetcdfFile ds,
                    Dimension timeDim,
                    List<Parameter> params)

Construct a coordinate transform for hybrid height

Parameters:

ds - netCDF dataset

timeDim - time dimension

params - list of transformation Parameters

Method Detail

getCoordinateArray

public ArrayDouble.D3 getCoordinateArray(int timeIndex)
                                  throws IOException,
                                         InvalidRangeException

Get the 3D vertical coordinate array for this time step.

Specified by:

getCoordinateArray in interface VerticalTransform

Specified by:

getCoordinateArray in class VerticalTransformImpl

Parameters:

timeIndex - the time index. Ignored if !isTimeDependent().

Returns:

vertical coordinate array

Throws:

IOException - problem reading data

InvalidRangeException - not a valid time range

getCoordinateArray1D

public ArrayDouble.D1 getCoordinateArray1D(int timeIndex,
                                           int xIndex,
                                           int yIndex)
                                    throws IOException,
                                           InvalidRangeException

Get the 1D vertical coordinate array for this time step and point

Specified by:

getCoordinateArray1D in interface VerticalTransform

Specified by:

getCoordinateArray1D in class VerticalTransformImpl

Parameters:

timeIndex - the time index. Ignored if !isTimeDependent().

xIndex - the x index

yIndex - the y index

Returns:

vertical coordinate array

Throws:

IOException - problem reading data

InvalidRangeException - _more_