ucar.nc2.ft.cover

Interface Coverage

All Superinterfaces:

java.lang.Comparable<VariableSimpleIF>, IsMissingEvaluator, NamedObject, VariableSimpleIF

All Known Implementing Classes:

CoverageImpl

public interface Coverage
extends IsMissingEvaluator, VariableSimpleIF, NamedObject

Experimental Coverage feature type. Superclass of gridded data types Can we do this without indexed reads?

Since:

Jan 19, 2010

Method Summary

Modifier and Type	Method and Description
java.lang.String	findAttValueIgnoreCase(java.lang.String attName, java.lang.String defaultValue) Convenience function; lookup Attribute value by name.
CoverageCS	getCoordinateSystem() get the Coverage's Coordinate System.
java.util.List<Dimension>	getDimensions() Returns a List of Dimension containing the dimensions used by this Coverage.
java.lang.String	getInfo() human readable information about this Coverage.
boolean	hasMissing() true if there may be missing data
boolean	isMissing(double val) if val is missing data
Array	readData(CoverageCS.Subset subset) This reads an arbitrary data slice, returning the data in canonical order (rt-e-t-z-y-x).

Methods inherited from interface ucar.nc2.VariableSimpleIF

findAttributeIgnoreCase, getAttributes, getDataType, getDescription, getFullName, getName, getRank, getShape, getShortName, getUnitsString

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface ucar.nc2.util.NamedObject

getDescription, getName

Method Detail

findAttValueIgnoreCase

java.lang.String findAttValueIgnoreCase(java.lang.String attName,
                                        java.lang.String defaultValue)

Convenience function; lookup Attribute value by name. Must be String valued

Parameters:

attName - name of the attribute

defaultValue - if not found, use this as the default

Returns:

Attribute string value, or default if not found.

getDimensions

java.util.List<Dimension> getDimensions()

Returns a List of Dimension containing the dimensions used by this Coverage. The dimension are put into canonical order: (rt, e, t, z, y, x). Only the x and y are required. If the Horizontal axes are 2D, the x and y dimensions are arbitrarily chosen to be gcs.getXHorizAxis().getDimension(1), gcs.getXHorizAxis().getDimension(0), respectively.

Specified by:

getDimensions in interface VariableSimpleIF

Returns:

List with objects of type Dimension, in canonical order.

getCoordinateSystem

CoverageCS getCoordinateSystem()

get the Coverage's Coordinate System.

Returns:

the Coverage's Coordinate System.

hasMissing

boolean hasMissing()

true if there may be missing data

Specified by:

hasMissing in interface IsMissingEvaluator

Returns:

true if there may be missing data

isMissing

boolean isMissing(double val)

if val is missing data

Specified by:

isMissing in interface IsMissingEvaluator

Parameters:

val - test this value

Returns:

true if val is missing data

readData

Array readData(CoverageCS.Subset subset)
        throws java.io.IOException,
               InvalidRangeException

This reads an arbitrary data slice, returning the data in canonical order (rt-e-t-z-y-x). If any dimension does not exist, ignore it.

Parameters:

subset - subset that you want. Must be created through this.getCoordinateSystem().makeSubset()

Returns:

data[rt,e,t,z,y,x], eliminating missing or fixed dimension.

Throws:

java.io.IOException - on io error

InvalidRangeException

getInfo

java.lang.String getInfo()

human readable information about this Coverage.

Returns:

human readable information about this Coverage.