Package ucar.unidata.geoloc.vertical

Class VTfromExistingData

java.lang.Object

ucar.unidata.geoloc.vertical.VerticalTransformImpl

ucar.unidata.geoloc.vertical.VTfromExistingData

All Implemented Interfaces:

VerticalTransform

public class VTfromExistingData
extends VerticalTransformImpl

This implements a VerticalTransform using an existing 3D variable. This is a common case when the 3D pressure or height field is stored in the file.

Field Summary

Fields

Modifier and Type	Field	Description
static String	existingDataField	The name of the Parameter whose value is the variable that contains the 2D Height or Pressure field

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

units

Constructor Summary

Constructors

Constructor	Description
VTfromExistingData(NetcdfFile ds, Dimension timeDim, List<Parameter> params)	Constructor.

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

existingDataField

public static final String existingDataField

The name of the Parameter whose value is the variable that contains the 2D Height or Pressure field

See Also:

Constant Field Values

Constructor Detail

VTfromExistingData

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

Constructor.

Parameters:

ds - containing Dataset

timeDim - time Dimension

params - list of transformation Parameters

Method Detail

getCoordinateArray

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

Description copied from class: VerticalTransformImpl

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 the data

InvalidRangeException - _more_

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_