ucar.unidata.geoloc.vertical
Class VTfromExistingData

java.lang.Object
  extended by ucar.unidata.geoloc.vertical.VerticalTransformImpl
      extended by 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.

Author:
john

Field Summary
static java.lang.String existingDataField
          The name of the Parameter whose value is the variable that contains the 2D Height or Pressure field
 
Constructor Summary
VTfromExistingData(NetcdfFile ds, Dimension timeDim, java.util.List<Parameter> params)
          Constructor.
 
Method Summary
 ArrayDouble.D3 getCoordinateArray(int timeIndex)
          Get the 3D vertical coordinate array for this time step.
 
Methods inherited from class ucar.unidata.geoloc.vertical.VerticalTransformImpl
getUnitString, isTimeDependent, subset
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

existingDataField

public static final java.lang.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,
                          java.util.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 java.io.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:
java.io.IOException - problem reading the data
InvalidRangeException - _more_