ucar.unidata.geoloc.vertical
Interface VerticalTransform

All Known Implementing Classes:
AtmosLnPressure, AtmosSigma, HybridHeight, HybridSigmaPressure, OceanS, OceanSG1, OceanSG2, OceanSigma, VerticalTransformImpl, VerticalTransformSubset, VTfromExistingData, WRFEta

public interface VerticalTransform

A transformation to a vertical reference coordinate system, such as height or pressure.

Author:
Unidata Development Team

Method Summary
 ArrayDouble.D3 getCoordinateArray(int timeIndex)
          Get the 3D vertical coordinate array for this time step.
 String getUnitString()
          Get the unit string for the vertical coordinate.
 boolean isTimeDependent()
          Get whether this coordinate is time dependent.
 VerticalTransform subset(Range t_range, Range z_range, Range y_range, Range x_range)
          Create a VerticalTransform as a section of an existing VerticalTransform.
 

Method Detail

getCoordinateArray

ArrayDouble.D3 getCoordinateArray(int timeIndex)
                                  throws IOException,
                                         InvalidRangeException
Get the 3D vertical coordinate array for this time step. Must be in "canonical order" : z, y, x.

Parameters:
timeIndex - the time index. Ignored if !isTimeDependent().
Returns:
vertical coordinate array
Throws:
IOException - problem reading the data
InvalidRangeException - timeIndex out of bounds

getUnitString

String getUnitString()
Get the unit string for the vertical coordinate.

Returns:
unit string

isTimeDependent

boolean isTimeDependent()
Get whether this coordinate is time dependent.

Returns:
true if time dependent

subset

VerticalTransform subset(Range t_range,
                         Range z_range,
                         Range y_range,
                         Range x_range)
                         throws InvalidRangeException
Create a VerticalTransform as a section of an existing VerticalTransform.

Parameters:
t_range - subset the time dimension, or null if you want all of it
z_range - subset the vertical dimension, or null if you want all of it
y_range - subset the y dimension, or null if you want all of it
x_range - subset the x dimension, or null if you want all of it
Returns:
a new VerticalTransform for the given subset
Throws:
InvalidRangeException - if any Range is incompatible with the existing VerticalTransform


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.