ucar.unidata.geoloc.vertical

Class OceanSG2

java.lang.Object

ucar.unidata.geoloc.vertical.OceanSG2

All Implemented Interfaces:

VerticalTransform

@Immutable
public class OceanSG2
extends Object

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

See Also:

"http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#_ocean_s_coordinate_generic_form_2"

Field Summary

Fields

Modifier and Type	Field and Description
static String	C The "C" variable name identifier
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
protected String	units

Method Summary

Modifier and Type	Method and Description
static OceanSG2	create(NetcdfFile ds, Dimension timeDim, List<Parameter> params) Create a new vertical transform for Ocean_S_coordinate_g2
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.
protected Dimension	getTimeDimension() Get the time Dimension, if it exists
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.

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

C

public static final String C

The "C" variable name identifier

See Also:

Constant Field Values

units

protected final String units

Method Detail

create

public static OceanSG2 create(NetcdfFile ds,
                              Dimension timeDim,
                              List<Parameter> params)

Create a new vertical transform for Ocean_S_coordinate_g2

Parameters:

ds - dataset

timeDim - time dimension

params - list of transformation Parameters TODO: params will change to AttributeContainer in ver7.

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

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

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_

getUnitString

@Nullable
public String getUnitString()

Description copied from interface: VerticalTransform

Get the unit string for the vertical coordinate.

Specified by:

getUnitString in interface VerticalTransform

isTimeDependent

public boolean isTimeDependent()

Description copied from interface: VerticalTransform

Get whether this coordinate is time dependent.

Specified by:

isTimeDependent in interface VerticalTransform

getTimeDimension

protected Dimension getTimeDimension()

Get the time Dimension, if it exists

subset

public VerticalTransform subset(Range t_range,
                                Range z_range,
                                Range y_range,
                                Range x_range)

Description copied from interface: VerticalTransform

Create a VerticalTransform as a section of an existing VerticalTransform.

Specified by:

subset in interface 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