Package noaa.coastwatch.io

Interface EarthGridSet

public interface EarthGridSet

An EarthGridSet provides an interface for data to be modelled as a set of 2D Grid objects, where each grid can be selected by specifying its unique position on a set of axes in a higher dimensional space. As an example, suppose that there are two axes that represent time and height, and that the time axis has 6 possible values:

  • [0] = Jan 1, 2015
  • [1] = Feb 1, 2015
  • [2] = Mar 1, 2015
  • [3] = Apr 1, 2015
  • [4] = May 1, 2015
  • [5] = Jun 1, 2015

and the height axis has 20 values:

  • [0] = 0 feet
  • [1] = 50 feet
  • [2] = 100 feet
  • ...
  • [18] = 900 feet
  • [19] = 1000 feet

To select the 2D grid for May 1, 2015 on the time axis and 100 feet on the height axis, the axis position would be time=2, height=2.

Since:
4.0.1
Author:
Peter Hollemans

  • Method Details

    • getVariables

      List<String> getVariables()
      Gets a list of all grid variable names in this set.
      Returns:
      the variable names.

    • getAxes

      List<EarthGridSet.Axis> getAxes(String varName)
      Gets a list of axes used to specify the version of a grid needed from the accessGrid(java.lang.String, java.util.List<java.lang.Integer>) method.
      Parameters:
      varName - the variable name for the axes.
      Returns:
      the list of axes, possibly empty if the variable is just a single grid and has no axes.

    • accessGrid

      Grid accessGrid(String varName, List<Integer> axisIndexList)
      Gets a version of a grid specified by a set of axes.
      Parameters:
      varName - the variable name for the grid.
      axisIndexList - the list of axis indicies, one for each axis, that specifies which grid to retrieve. The list may be empty if the variable has no axes.
      Returns:
      the grid corresponding to the variable name and axes specified.

    • accessGridSubset

      default Grid accessGridSubset(String varName, List<Integer> axisIndexList, int[] start, int[] stride, int[] length)
      Gets a version of a grid specified by a set of axes and a subset specification.
      Parameters:
      varName - the variable name for the grid.
      axisIndexList - the list of axis indicies, one for each axis, that specifies which grid to retrieve. The list may be empty if the variable has no axes.
      start - the starting spatial data coordinates.
      stride - the spatial data stride.
      length - the total number of values to access in each spatial dimension.
      Returns:
      the grid corresponding to the variable name, axes, and subset specified.
      Since:
      4.1.0

    • gridSubsetSupported

      default boolean gridSubsetSupported()
      Returns the status of support for calling the accessGridSubset(java.lang.String, java.util.List<java.lang.Integer>, int[], int[], int[]) method.
      Since:
      4.1.0

    • releaseGrid

      void releaseGrid(Grid grid)
      Releases the resources used by a grid accessed by this set.
      Parameters:
      grid - the grid to release.

    • getTransform

      EarthTransform2D getTransform(String varName)
      Gets the 2D earth transform for the grids in a variable.
      Parameters:
      varName - the variable name for the earth transform.
      Returns:
      the earth transform.

    • getOrigin

      String getOrigin()
      Gets the institute/origin of the data in the dataset.
      Returns:
      the data institute/origin.

    • getSource

      String getSource()
      Gets the source/platform of the data in the dataset.
      Returns:
      the data source/platform.

    • dispose

      void dispose()
      Disposes of the resources used by this grid set.