Package 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".

Modified April 20, 2009 by sachin

See Also:

"https://www.myroms.org/wiki/index.php/Vertical_S-coordinate#Metadata_Considerations"

Field Summary

Fields

Modifier and Type	Field	Description
static String	A	The "a" variable name
static String	B	The "b" variable name
static String	DEPTH	The "depth" variable name identifier
static String	DEPTH_C	The "depth c" variable name identifier
static String	ETA	The eta variable name identifier
static String	S	The "s" variable name identifier

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

units

Constructor Summary

Constructors

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

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 the specified X,Y index for Lat-Lon 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

ETA

public static final String ETA

The eta variable name identifier

See Also:

Constant Field Values

S

public static final String S

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

DEPTH_C

public static final String DEPTH_C

The "depth c" variable name identifier

See Also:

Constant Field Values

A

public static final String A

The "a" variable name

See Also:

Constant Field Values

B

public static final String B

The "b" variable name

See Also:

Constant Field Values

Constructor Detail

OceanS

public OceanS(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_

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 the specified X,Y index for Lat-Lon 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_