Package noaa.coastwatch.io

Class CWHDFReader

java.lang.Object

noaa.coastwatch.io.EarthDataReader

noaa.coastwatch.io.HDFReader

noaa.coastwatch.io.CWHDFReader

All Implemented Interfaces:

HDFSD

public class CWHDFReader
extends HDFReader

A CWHDF reader is an earth data reader that reads CoastWatch HDF format files using the HDF library class.

Since:

3.1.0

Author:

Peter Hollemans

Field Summary

Fields

Modifier and Type	Field	Description
static final double	SWATH_POLY_SIZE	Swath maximum polynomial size in kilometers.

Fields inherited from class noaa.coastwatch.io.HDFReader

sdid

Fields inherited from class noaa.coastwatch.io.EarthDataReader

dataProjection, info, rawMetadataMap, variables

Constructor Summary

Constructors

Constructor	Description
CWHDFReader(String file)	Constructs a CWHDF reader from the specified file.
CWHDFReader(CWHDFWriter writer)	Constructs a CWHDF reader from the specified writer.

Method Summary

Modifier and Type	Method	Description
boolean	canUpdateNavigation()	Determines the ability of the file format to have its navigation updated.
String	getDataFormat()	Gets the data format description.
protected EarthDataInfo	getGlobalInfo()	Reads the earth data info metadata.
static double	getMetaVersion(int sdid)	Gets the CoastWatch HDF metadata version.
protected boolean	readAllMetadata()	Returns true so that the parent is instructed to read all global and variable attributes.
void	updateNavigation(List variableNames, AffineTransform affine)	Updates the navigation transform for the specified list of variables.

Methods inherited from class noaa.coastwatch.io.HDFReader

close, getAttribute, getAttribute, getAttributeAsArray, getAttributeAsArray, getAttributes, getAttributes, getChunkLengths, getChunkProducer, getClass, getFilename, getPreviewImpl, getSDID, getUnsigned, getVariable, getVariableDimensions, getVariableNames

Methods inherited from class noaa.coastwatch.io.EarthDataReader

containsVariable, finalize, getAllGrids, getAllVariables, getCoordinateSystems, getIndex, getInfo, getName, getPreview, getPreview, getRawMetadata, getRawMetadata, getSceneTime, getSource, getStatistics, getStatisticsVariables, getVariable, getVariables, getVariablesForSystem, putStatistics, setDataProjection, setUnitsMap

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SWATH_POLY_SIZE

public static final double SWATH_POLY_SIZE

Swath maximum polynomial size in kilometers.

See Also:

• Constant Field Values

Constructor Details

CWHDFReader

public CWHDFReader(CWHDFWriter writer)
            throws hdf.hdflib.HDFException,
IOException,
NoninvertibleTransformException,
ClassNotFoundException

Constructs a CWHDF reader from the specified writer.

Parameters:

writer - the writer to use for reading.

Throws:

hdf.hdflib.HDFException - if an error occurred in an HDF routine.

IOException - if an error occurred reading the file metadata.

NoninvertibleTransformException - if the earth transform object could not be initialized.

ClassNotFoundException - if the HDF attribute type is unknown.

CWHDFReader

public CWHDFReader(String file)
            throws hdf.hdflib.HDFException,
IOException,
NoninvertibleTransformException,
ClassNotFoundException

Constructs a CWHDF reader from the specified file.

Parameters:

file - the file name to read.

Throws:

hdf.hdflib.HDFException - if an error occurred in an HDF routine.

IOException - if an error occurred reading the file metadata.

NoninvertibleTransformException - if the earth transform object could not be initialized.

ClassNotFoundException - if the HDF attribute type is unknown.

Method Details

getDataFormat

public String getDataFormat()

Gets the data format description.

Specified by:

getDataFormat in class EarthDataReader

getMetaVersion

public static double getMetaVersion(int sdid)

Gets the CoastWatch HDF metadata version.

Parameters:

sdid - the HDF scientific dataset ID.

Returns:

the metadata version. If no metadata attribute can be found, the metadata version is assumed to be 2.3.

readAllMetadata

protected boolean readAllMetadata()

Returns true so that the parent is instructed to read all global and variable attributes.

Overrides:

readAllMetadata in class HDFReader

Returns:

true if full metadata should be read, or false if not.

getGlobalInfo

protected EarthDataInfo getGlobalInfo()
                               throws hdf.hdflib.HDFException,
IOException,
NoninvertibleTransformException,
ClassNotFoundException

Description copied from class: HDFReader

Reads the earth data info metadata.

Specified by:

getGlobalInfo in class HDFReader

Returns:

the earth data info object.

Throws:

hdf.hdflib.HDFException - if an error occurred in an HDF routine.

IOException - if an error occurred reading the file metadata.

NoninvertibleTransformException - if the earth transform object could not be initialized.

ClassNotFoundException - if the HDF attribute type is unknown.

canUpdateNavigation

public boolean canUpdateNavigation()

Description copied from class: EarthDataReader

Determines the ability of the file format to have its navigation updated. Classes that override EarthDataReader.updateNavigation(java.util.List, java.awt.geom.AffineTransform) should also override this method.

Overrides:

canUpdateNavigation in class EarthDataReader

Returns:

true if the navigation can be updated, or false if not.

See Also:

• EarthDataReader.updateNavigation(java.util.List, java.awt.geom.AffineTransform)

updateNavigation

public void updateNavigation(List variableNames,
 AffineTransform affine)
                      throws IOException

Updates the navigation transform for the specified list of variables.

Overrides:

updateNavigation in class EarthDataReader

Parameters:

variableNames - the list of variable names to update.

affine - the navigation transform to apply. If null, the navigation is reset to the identity.

Throws:

IOException - if an error occurred writing the file metadata.

See Also:

• EarthDataReader.canUpdateNavigation()