VerticalTransform (NetCDF-Java Public API v8.0.0-SNAPSHOT)

All Known Implementing Classes:

AtmosHybridSigmaPressure, AtmosSigma, ExistingFieldVerticalTransform, OceanS, OceanSG1, OceanSG2, OceanSigma, WrfEta
```
public interface VerticalTransform
```
A transformation to a vertical reference coordinate system, such as height or pressure.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface VerticalTransform.Builder
A Builder of VerticalTransforms.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Array<Number>`	`getCoordinateArray1D(int timeIndex, int xIndex, int yIndex)`	Get the 1D vertical coordinate array for this time step and point
`Array<Number>`	`getCoordinateArray3D(int timeIndex)`	Get the 3D vertical coordinate array for this time step.
`String`	`getCtvName()`	The name of the Coordinate Variable Transform container.
`String`	`getName()`	The name of the Vertical Transform.
`String`	`getUnitString()`	The unit string for the vertical coordinate.

- Method Detail
  - getName
```
String getName()
```
    The name of the Vertical Transform.
  - getCtvName
```
String getCtvName()
```
    The name of the Coordinate Variable Transform container.
  - getUnitString
```
@Nullable
String getUnitString()
```
    The unit string for the vertical coordinate.
  - getCoordinateArray3D
```
Array<Number> getCoordinateArray3D(int timeIndex)
                            throws IOException,
                                   InvalidRangeException
```
    Get the 3D vertical coordinate array for this time step. Must be in "canonical order" : z, y, x.
    
    Parameters:
    
    timeIndex - the time index. Ignored if !isTimeDependent().
    
    Returns:
    
    3D vertical coordinate array, for the given t.
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - getCoordinateArray1D
```
Array<Number> getCoordinateArray1D(int timeIndex,
                                   int xIndex,
                                   int yIndex)
                            throws IOException,
                                   InvalidRangeException
```
    Get the 1D vertical coordinate array for this time step and point
    
    Parameters:
    
    timeIndex - the time index. Ignored if !isTimeDependent().
    
    xIndex - the x index
    
    yIndex - the y index
    
    Returns:
    
    vertical coordinate array
    
    Throws:
    
    IOException
    
    InvalidRangeException