ucar.unidata.geoloc.vertical
Class OceanSigma

java.lang.Object
  extended by ucar.unidata.geoloc.vertical.VerticalTransformImpl
      extended by ucar.unidata.geoloc.vertical.OceanSigma
All Implemented Interfaces:
VerticalTransform

public class OceanSigma
extends VerticalTransformImpl

Create a 3D height(z,y,x) array using the CF formula for "ocean sigma vertical coordinate".

Author:
caron
See Also:
http://cf-pcmdi.llnl.gov/

Field Summary
static String DEPTH
          The "depth" variable name identifier
static String ETA
          The eta variable name identifier
static String SIGMA
          The "s" variable name identifier
 
Fields inherited from class ucar.unidata.geoloc.vertical.VerticalTransformImpl
units
 
Constructor Summary
OceanSigma(NetcdfFile ds, Dimension timeDim, List<Parameter> params)
          Create a new vertical transform for Ocean S coordinates
 
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
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

ETA

public static final String ETA
The eta variable name identifier

See Also:
Constant Field Values

SIGMA

public static final String SIGMA
The "s" variable name identifier

See Also:
Constant Field Values

DEPTH

public static final String DEPTH
The "depth" variable name identifier

See Also:
Constant Field Values
Constructor Detail

OceanSigma

public OceanSigma(NetcdfFile ds,
                  Dimension timeDim,
                  List<Parameter> params)
Create a new vertical transform for Ocean S coordinates

Parameters:
ds - 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 - _more_


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