ucar.unidata.geoloc.vertical
Class OceanSG1

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

public class OceanSG1
extends VerticalTransformImpl

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

Author:
Sachin (skbhate@ngi.msstate.edu)
See Also:
http://cf-pcmdi.llnl.gov/, https://www.myroms.org/wiki/index.php/Vertical_S-coordinate#Metadata_Considerations

Field Summary
static java.lang.String C
          The "C" variable name identifier
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
OceanSG1(NetcdfFile ds, Dimension timeDim, java.util.List<Parameter> params)
          Create a new vertical transform for Ocean_S_coordinate_g1
 
Method Summary
 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
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

C

public static final java.lang.String C
The "C" variable name identifier

See Also:
Constant Field Values
Constructor Detail

OceanSG1

public OceanSG1(NetcdfFile ds,
                Dimension timeDim,
                java.util.List<Parameter> params)
Create a new vertical transform for Ocean_S_coordinate_g1

Parameters:
ds - dataset
timeDim - time dimension
params - list of transformation Parameters
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 - _more_

getCoordinateArray1D

public ArrayDouble.D1 getCoordinateArray1D(int timeIndex,
                                           int xIndex,
                                           int yIndex)
                                    throws java.io.IOException,
                                           InvalidRangeException
Get the 1D vertical coordinate array for this time step and the specified X,Y index for Lat-Lon point.

Parameters:
timeIndex - the time index. Ignored if !isTimeDependent().
xIndex - the x index
yIndex - the y index
Returns:
vertical coordinate array
Throws:
java.io.IOException - problem reading data
InvalidRangeException - _more_