org.geotools.coverage.io.netcdf

Class NetCDFReader

Object

AbstractGridCoverage2DReader

NetCDFReader

All Implemented Interfaces:

GridCoverage2DReader, StructuredGridCoverage2DReader, GridCoverageReader

public class NetCDFReader
extends AbstractGridCoverage2DReader
implements StructuredGridCoverage2DReader

A NetCDF Reader implementation

Author:

Daniele Romagnoli, GeoSolutions SAS

Field Summary

Fields inherited from class AbstractGridCoverage2DReader

closeMe, coverageFactory, coverageName, crs, dtLayout, EPS, gzipped, highestRes, hints, inStream, inStreamSPI, numOverviews, offsets, originalEnvelope, originalGridRange, overViewResolutions, raster2Model, scales, source

Fields inherited from interface GridCoverage2DReader

ELEVATION_DOMAIN, ELEVATION_DOMAIN_MAXIMUM, ELEVATION_DOMAIN_MINIMUM, ELEVATION_DOMAIN_RESOLUTION, FILE_SOURCE_PROPERTY, HAS_ELEVATION_DOMAIN, HAS_TIME_DOMAIN, MULTICRS_READER, REPROJECTING_READER, SOURCE_URL_PROPERTY, TIME_DOMAIN, TIME_DOMAIN_MAXIMUM, TIME_DOMAIN_MINIMUM, TIME_DOMAIN_RESOLUTION

Constructor Summary

Constructors

Constructor and Description
NetCDFReader(Object input, Hints uHints)

Method Summary

Modifier and Type	Method and Description
void	createCoverage(String coverageName, SimpleFeatureType schema) Creates a granule store for a new coverage with the given feature type
void	delete(boolean deleteData) delete all stuff (database content, indexer files, property files, associated auxiliary files and so on).
void	dispose() Disposes this reader.
CoordinateReferenceSystem	getCoordinateReferenceSystem() Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.
CoordinateReferenceSystem	getCoordinateReferenceSystem(String coverageName) Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.
List<DimensionDescriptor>	getDimensionDescriptors(String coverageName) Describes the dimensions supported by the specified coverage, if any.
Set<ParameterDescriptor<List>>	getDynamicParameters(String coverageName) Return the set of dynamic parameterDescriptors (the ones related to domains) for this reader.
Format	getFormat() Returns the format handled by this GridCoverageReader.
GranuleSource	getGranules(String coverageName, boolean readOnly) Returns the granule source for the specified coverage (might be null, if there is only one supported coverage)
int	getGridCoverageCount() Retrieve the number of coverages contained within the input source.
String[]	getGridCoverageNames() Retrieve the list of coverages contained within the input source.
ImageLayout	getImageLayout() Retrieve the ImageLayout for the default coverage.
ImageLayout	getImageLayout(String coverageName) Retrieve the ImageLayout for the specified coverage.
ResourceInfo	getInfo(String coverageName) Default implementation returns a FileResourceInfo containing same fileGroup list contained in the ServiceInfo object.
String[]	getMetadataNames(String coverageName) Returns the list of metadata keywords associated with a specific gridCoverage referred by name.
String	getMetadataValue(String coverageName, String name) Retrieve the metadata value for a given metadata name for a specified coverage.
GeneralEnvelope	getOriginalEnvelope() Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.
GeneralEnvelope	getOriginalEnvelope(String coverageName) Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.
GridEnvelope	getOriginalGridRange() Retrieves the GeneralGridEnvelope that represents the raster grid dimensions of the highest resolution level in this dataset.
GridEnvelope	getOriginalGridRange(String coverageName) Retrieves the GeneralGridEnvelope that represents the raster grid dimensions of the highest resolution level in this dataset.
MathTransform	getOriginalGridToWorld(PixelInCell pixInCell) Retrieves the original grid to world transformation for this AbstractGridCoverage2DReader.
MathTransform	getOriginalGridToWorld(String coverageName, PixelInCell pixInCell) Retrieves the original grid to world transformation for this AbstractGridCoverage2DReader.
double[]	getReadingResolutions(OverviewPolicy policy, double[] requestedResolution) Returns the actual resolution used to read the data given the specified target resolution and the specified overview policy
double[]	getReadingResolutions(String coverageName, OverviewPolicy policy, double[] requestedResolution) Returns the actual resolution used to read the data given the specified target resolution and the specified overview policy
double[][]	getResolutionLevels() Retrieve the resolution levels for the default coverage.
double[][]	getResolutionLevels(String coverageName) Retrieve the resolution levels for the specified coverage.
List<HarvestedSource>	harvest(String defaultCoverage, Object source, Hints hints) Harvests the specified source into the reader.
boolean	isReadOnly() Return whether this reader can modify the granule source
GridCoverage2D	read(GeneralParameterValue[] parameters) Read a GridCoverage2D base on the specified read parameters.
GridCoverage2D	read(String coverageName, GeneralParameterValue[] parameters) Retrieves the GridEnvelope associated to the specified coverageName for this GridCoverage2DReader.
boolean	removeCoverage(String coverageName, boolean forceDelete) removes a granule store for the specified coverageName

Methods inherited from class AbstractGridCoverage2DReader

addAllSiblings, addSiblings, checkName, collectScaleOffset, createImageCoverage, createImageCoverage, createImageCoverage, createImageCoverage, decimationOnReadingControl, finalize, getDatasetLayout, getDatasetLayout, getDynamicParameters, getFiles, getGroundControlPoints, getGroundControlPoints, getHighestRes, getInfo, getMetadataNames, getMetadataValue, getMultiLevelROIProvider, getOverviewGridEnvelope, getOverviewGridEnvelope, getRescaledRasterToModel, getResolution, getSibling, getSource, getSourceAsFile, setlayout, setLayout, setReadParams, setReadParams

Methods inherited from class Object

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

Methods inherited from interface GridCoverage2DReader

getDatasetLayout, getDatasetLayout, getDynamicParameters, getInfo

Methods inherited from interface GridCoverageReader

getMetadataNames, getMetadataValue, getSource

Constructor Detail

NetCDFReader

public NetCDFReader(Object input,
                    Hints uHints)
             throws DataSourceException

Throws:

DataSourceException

Method Detail

getFormat

public Format getFormat()

Description copied from interface: GridCoverageReader

Returns the format handled by this GridCoverageReader.

Specified by:

getFormat in interface GridCoverageReader

getMetadataNames

public String[] getMetadataNames(String coverageName)

Description copied from interface: GridCoverageReader

Returns the list of metadata keywords associated with a specific gridCoverage referred by name. If no metadata is available, the array will be empty.

Specified by:

getMetadataNames in interface GridCoverageReader

Overrides:

getMetadataNames in class AbstractGridCoverage2DReader

Returns:

The list of metadata keywords for the input source.

getMetadataValue

public String getMetadataValue(String coverageName,
                               String name)

Description copied from interface: GridCoverageReader

Retrieve the metadata value for a given metadata name for a specified coverage.

Specified by:

getMetadataValue in interface GridCoverageReader

Overrides:

getMetadataValue in class AbstractGridCoverage2DReader

name - Metadata keyword for which to retrieve metadata.

Returns:

The metadata value for the given metadata name. Should be one of the name returned by GridCoverageReader.getMetadataNames().

getGridCoverageNames

public String[] getGridCoverageNames()

Description copied from interface: GridCoverageReader

Retrieve the list of coverages contained within the input source. Each grid can have a different coordinate system, number of dimensions and grid geometry. For example, a HDF-EOS file (GRID.HDF) contains 6 grid coverages each having a different projection. An empty array will be returned if no sub names exist.

Specified by:

getGridCoverageNames in interface GridCoverageReader

Overrides:

getGridCoverageNames in class AbstractGridCoverage2DReader

Returns:

The list of grid coverages contained within the input source.

getDynamicParameters

public Set<ParameterDescriptor<List>> getDynamicParameters(String coverageName)
                                                    throws IOException

Description copied from class: AbstractGridCoverage2DReader

Return the set of dynamic parameterDescriptors (the ones related to domains) for this reader. Default implementation returns an empty set of parameters

Specified by:

getDynamicParameters in interface GridCoverage2DReader

Overrides:

getDynamicParameters in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage to work with

Returns:

the Set of dynamic read parameters supported by this GridCoverage2DReader.

Throws:

IOException - in case an error occurs while creating the Set of dynamic parameters.

getGridCoverageCount

public int getGridCoverageCount()

Description copied from interface: GridCoverageReader

Retrieve the number of coverages contained within the input source.

Specified by:

getGridCoverageCount in interface GridCoverageReader

Overrides:

getGridCoverageCount in class AbstractGridCoverage2DReader

Returns:

The number of coverages contained within the input source.

See Also:

GridCoverageReader.getGridCoverageCount()

read

public GridCoverage2D read(String coverageName,
                           GeneralParameterValue[] parameters)
                    throws IllegalArgumentException,
                           IOException

Description copied from interface: GridCoverage2DReader

Retrieves the GridEnvelope associated to the specified coverageName for this GridCoverage2DReader.

Specified by:

read in interface GridCoverage2DReader

Specified by:

read in interface GridCoverageReader

Overrides:

read in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage to work with

parameters - an array of GeneralParameterValue that uses a subset of the available read params for this GridCoverage2DReader as specified by the Format

Returns:

a GridCoverage2D for the underlying default coverage for this GridCoverage2DReader or null in case no GridCoverage2D can be read for the provided parameters.

Throws:

IllegalArgumentException - if the specified coverageName does not exist

IOException - if a read operation failed for some other input/output reason, including FileNotFoundException if no file with the given name can be found, or IIOException if an error was thrown by the underlying image library.

read

public GridCoverage2D read(GeneralParameterValue[] parameters)
                    throws IllegalArgumentException,
                           IOException

Read a GridCoverage2D base on the specified read parameters.

Specified by:

read in interface GridCoverage2DReader

Specified by:

read in interface GridCoverageReader

Specified by:

read in class AbstractGridCoverage2DReader

Parameters:

parameters - Optional parameters matching Format.getReadParameters().

Returns:

a grid coverage from the input source.

Throws:

InvalidParameterNameException - if a parameter in parameters doesn't have a recognized name.

InvalidParameterValueException - if a parameter in parameters doesn't have a valid value.

ParameterNotFoundException - if a parameter was required for the operation but was not provided in the parameters list.

IOException - if a read operation failed for some other input/output reason, including FileNotFoundException if no file with the given name can be found, or IIOException if an error was thrown by the underlying image library.

IllegalArgumentException

dispose

public void dispose()

Description copied from class: AbstractGridCoverage2DReader

Disposes this reader.

This method just tries to close the underlying ImageInputStream.

Specified by:

dispose in interface GridCoverageReader

Overrides:

dispose in class AbstractGridCoverage2DReader

getOriginalEnvelope

public GeneralEnvelope getOriginalEnvelope()

Description copied from class: AbstractGridCoverage2DReader

Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.

Specified by:

getOriginalEnvelope in interface GridCoverage2DReader

Overrides:

getOriginalEnvelope in class AbstractGridCoverage2DReader

Returns:

the GeneralEnvelope for this AbstractGridCoverage2DReader.

getOriginalEnvelope

public GeneralEnvelope getOriginalEnvelope(String coverageName)

Description copied from class: AbstractGridCoverage2DReader

Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.

Specified by:

getOriginalEnvelope in interface GridCoverage2DReader

Overrides:

getOriginalEnvelope in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage to work on.

Returns:

the GeneralEnvelope for this AbstractGridCoverage2DReader.

getOriginalGridRange

public GridEnvelope getOriginalGridRange()

Description copied from class: AbstractGridCoverage2DReader

Retrieves the GeneralGridEnvelope that represents the raster grid dimensions of the highest resolution level in this dataset.

Specified by:

getOriginalGridRange in interface GridCoverage2DReader

Overrides:

getOriginalGridRange in class AbstractGridCoverage2DReader

Returns:

the GeneralGridEnvelope that represents the raster grid dimensions of the highest resolution level in this dataset.

getOriginalGridRange

public GridEnvelope getOriginalGridRange(String coverageName)

Description copied from class: AbstractGridCoverage2DReader

Retrieves the GeneralGridEnvelope that represents the raster grid dimensions of the highest resolution level in this dataset.

Specified by:

getOriginalGridRange in interface GridCoverage2DReader

Overrides:

getOriginalGridRange in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage to work with

Returns:

the GeneralGridEnvelope that represents the raster grid dimensions of the highest resolution level in this dataset.

getReadingResolutions

public double[] getReadingResolutions(OverviewPolicy policy,
                                      double[] requestedResolution)

Description copied from class: AbstractGridCoverage2DReader

Returns the actual resolution used to read the data given the specified target resolution and the specified overview policy

Specified by:

getReadingResolutions in interface GridCoverage2DReader

Overrides:

getReadingResolutions in class AbstractGridCoverage2DReader

Parameters:

policy - the OverviewPolicy to use during evaluation.

requestedResolution - the requested resolution

Returns:

an array of 2 double with the resolution of the selected overview.

getReadingResolutions

public double[] getReadingResolutions(String coverageName,
                                      OverviewPolicy policy,
                                      double[] requestedResolution)
                               throws IOException

Description copied from class: AbstractGridCoverage2DReader

Returns the actual resolution used to read the data given the specified target resolution and the specified overview policy

Specified by:

getReadingResolutions in interface GridCoverage2DReader

Overrides:

getReadingResolutions in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage to work on.

policy - the OverviewPolicy to use during evaluation.

requestedResolution - the requested resolution

Returns:

an array of 2 double with the resolution of the selected overview.

Throws:

IOException - in case an error occurs.

getResolutionLevels

public double[][] getResolutionLevels()
                               throws IOException

Description copied from interface: GridCoverage2DReader

Retrieve the resolution levels for the default coverage.

Throw an IllegalArgumentException in case the name is wrong and/or no such a coverage exists.

Specified by:

getResolutionLevels in interface GridCoverage2DReader

Overrides:

getResolutionLevels in class AbstractGridCoverage2DReader

Returns:

the resolution levels for the default coverage.

Throws:

IOException

getResolutionLevels

public double[][] getResolutionLevels(String coverageName)
                               throws IOException

Description copied from interface: GridCoverage2DReader

Retrieve the resolution levels for the specified coverage.

Throw an IllegalArgumentException in case the name is wrong and/or no such a coverage exists.

Specified by:

getResolutionLevels in interface GridCoverage2DReader

Overrides:

getResolutionLevels in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage for which we want to know the resolution levels.

Returns:

the resolution levels for the specified coverage.

Throws:

IOException

getImageLayout

public ImageLayout getImageLayout()
                           throws IOException

Description copied from interface: GridCoverage2DReader

Retrieve the ImageLayout for the default coverage.

Throw an IllegalArgumentException in case the name is wrong and/or no such a coverage exists.

Specified by:

getImageLayout in interface GridCoverage2DReader

Overrides:

getImageLayout in class AbstractGridCoverage2DReader

Returns:

an ImageLayout that is useful for actually knowing the ColorModel, the SampleModel as well as the tile grid for the default coverage.

Throws:

IOException

getImageLayout

public ImageLayout getImageLayout(String coverageName)
                           throws IOException

Description copied from interface: GridCoverage2DReader

Retrieve the ImageLayout for the specified coverage.

Throw an IllegalArgumentException in case the name is wrong and/or no such a coverage exists.

Specified by:

getImageLayout in interface GridCoverage2DReader

Overrides:

getImageLayout in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage for which we want to know the GridEnvelope.

Returns:

an ImageLayout that is useful for actually knowing the ColorModel, the SampleModel as well as the tile grid for a certain coverage.

Throws:

IOException

getCoordinateReferenceSystem

public CoordinateReferenceSystem getCoordinateReferenceSystem()

Description copied from class: AbstractGridCoverage2DReader

Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.

Specified by:

getCoordinateReferenceSystem in interface GridCoverage2DReader

Overrides:

getCoordinateReferenceSystem in class AbstractGridCoverage2DReader

Returns:

the GeneralEnvelope for this AbstractGridCoverage2DReader.

getCoordinateReferenceSystem

public CoordinateReferenceSystem getCoordinateReferenceSystem(String coverageName)

Description copied from class: AbstractGridCoverage2DReader

Retrieves the GeneralEnvelope for this AbstractGridCoverage2DReader.

Specified by:

getCoordinateReferenceSystem in interface GridCoverage2DReader

Overrides:

getCoordinateReferenceSystem in class AbstractGridCoverage2DReader

Returns:

the GeneralEnvelope for this AbstractGridCoverage2DReader.

getOriginalGridToWorld

public MathTransform getOriginalGridToWorld(PixelInCell pixInCell)

Description copied from class: AbstractGridCoverage2DReader

Retrieves the original grid to world transformation for this AbstractGridCoverage2DReader.

Specified by:

getOriginalGridToWorld in interface GridCoverage2DReader

Overrides:

getOriginalGridToWorld in class AbstractGridCoverage2DReader

Parameters:

pixInCell - specifies the datum of the transformation we want.

Returns:

the original grid to world transformation for this AbstractGridCoverage2DReader.

getOriginalGridToWorld

public MathTransform getOriginalGridToWorld(String coverageName,
                                            PixelInCell pixInCell)

Description copied from class: AbstractGridCoverage2DReader

Retrieves the original grid to world transformation for this AbstractGridCoverage2DReader.

Specified by:

getOriginalGridToWorld in interface GridCoverage2DReader

Overrides:

getOriginalGridToWorld in class AbstractGridCoverage2DReader

Parameters:

coverageName - the name of the coverage to work with

pixInCell - specifies the datum of the transformation we want.

Returns:

the original grid to world transformation for this AbstractGridCoverage2DReader.

getGranules

public GranuleSource getGranules(String coverageName,
                                 boolean readOnly)
                          throws IOException,
                                 UnsupportedOperationException

Description copied from interface: StructuredGridCoverage2DReader

Returns the granule source for the specified coverage (might be null, if there is only one supported coverage)

Specified by:

getGranules in interface StructuredGridCoverage2DReader

Parameters:

coverageName - the name of the specified coverage

readOnly - a boolean indicating whether we may want modify the GranuleSource

Returns:

the requested GranuleSource

Throws:

IOException

UnsupportedOperationException

isReadOnly

public boolean isReadOnly()

Description copied from interface: StructuredGridCoverage2DReader

Return whether this reader can modify the granule source

Specified by:

isReadOnly in interface StructuredGridCoverage2DReader

Returns:

createCoverage

public void createCoverage(String coverageName,
                           SimpleFeatureType schema)
                    throws IOException,
                           UnsupportedOperationException

Description copied from interface: StructuredGridCoverage2DReader

Creates a granule store for a new coverage with the given feature type

Specified by:

createCoverage in interface StructuredGridCoverage2DReader

Throws:

IOException

UnsupportedOperationException

harvest

public List<HarvestedSource> harvest(String defaultCoverage,
                                     Object source,
                                     Hints hints)
                              throws IOException,
                                     UnsupportedOperationException

Description copied from interface: StructuredGridCoverage2DReader

Harvests the specified source into the reader. Depending on the implementation, the original source is harvested in place (e.g., image mosaic), or might be copied into the reader persistent storage (e.g., database raster handling)

Specified by:

harvest in interface StructuredGridCoverage2DReader

Parameters:

defaultCoverage - Default target coverage, to be used in case the sources being harvested are not structured ones. The parameter is optional, in case it's missing the reader will use the first coverage as the default target.

source - The source can be any kind of object, it's up to the reader implementation to understand and use it. Commons source types could be a single file, or a folder.

hints - Used to provide implementation specific hints on how to harvest the sources

Throws:

IOException

UnsupportedOperationException

getDimensionDescriptors

public List<DimensionDescriptor> getDimensionDescriptors(String coverageName)
                                                  throws IOException

Description copied from interface: StructuredGridCoverage2DReader

Describes the dimensions supported by the specified coverage, if any. (coverageName might be null, if there is only one supported coverage)

Specified by:

getDimensionDescriptors in interface StructuredGridCoverage2DReader

Throws:

IOException

removeCoverage

public boolean removeCoverage(String coverageName,
                              boolean forceDelete)
                       throws IOException,
                              UnsupportedOperationException

Description copied from interface: StructuredGridCoverage2DReader

removes a granule store for the specified coverageName

Specified by:

removeCoverage in interface StructuredGridCoverage2DReader

Throws:

IOException

UnsupportedOperationException

delete

public void delete(boolean deleteData)
            throws IOException

Description copied from interface: StructuredGridCoverage2DReader

delete all stuff (database content, indexer files, property files, associated auxiliary files and so on).

Specified by:

delete in interface StructuredGridCoverage2DReader

Parameters:

deleteData - specifies whether data (granules) should be deleted too.

Throws:

IOException

getInfo

public ResourceInfo getInfo(String coverageName)

Description copied from class: AbstractGridCoverage2DReader

Default implementation returns a FileResourceInfo containing same fileGroup list contained in the ServiceInfo object.

Specified by:

getInfo in interface GridCoverage2DReader

Overrides:

getInfo in class AbstractGridCoverage2DReader

Returns:

ResourceInfo describing a specific coverage.