ucar.unidata.geoloc.vertical
Class OceanS

java.lang.Object
  ucar.unidata.geoloc.vertical.VerticalTransformImpl
      ucar.unidata.geoloc.vertical.OceanS

All Implemented Interfaces:

VerticalTransform

public class OceanS
extends VerticalTransformImpl

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

Author:

caron

Field Summary

static java.lang.String	A The "a" variable name
static java.lang.String	B The "b" variable name
static java.lang.String	DEPTH The "depth" variable name identifier
static java.lang.String	DEPTH_C The "depth c" variable name identifier
static java.lang.String	ETA The eta variable name identifier
static java.lang.String	S The "s" variable name identifier

Constructor Summary

OceanS(NetcdfDataset ds, Dimension timeDim, VerticalCT vCT)
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

getUnitString, isTimeDependent, subset

Methods inherited from class java.lang.Object

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

Field Detail

ETA

public static final java.lang.String ETA

The eta variable name identifier

See Also:

Constant Field Values

S

public static final java.lang.String S

The "s" variable name identifier

See Also:

Constant Field Values

DEPTH

public static final java.lang.String DEPTH

The "depth" variable name identifier

See Also:

Constant Field Values

DEPTH_C

public static final java.lang.String DEPTH_C

The "depth c" variable name identifier

See Also:

Constant Field Values

A

public static final java.lang.String A

The "a" variable name

See Also:

Constant Field Values

B

public static final java.lang.String B

The "b" variable name

See Also:

Constant Field Values

Constructor Detail

OceanS

public OceanS(NetcdfDataset ds,
              Dimension timeDim,
              VerticalCT vCT)

Create a new vertical transform for Ocean S coordinates

Parameters:

ds - dataset

timeDim - time dimension

vCT - vertical coordinate transform

Method Detail

getCoordinateArray

public ArrayDouble.D3 getCoordinateArray(int timeIndex)
                                  throws java.io.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:

java.io.IOException - problem reading data

InvalidRangeException - timeIndex out of bounds