public interface GridCoverage2DReader extends GridCoverageReader
Data access method take a coverageName
supplied by GridCoverageReader.getGridCoverageNames()
allowing each data GridCoverage2D to be accessed
independently.
In addition static keywords for use with GridCoverageReader.getMetadataNames(String
coverageName)
have been provided.
Modifier and Type | Field and Description |
---|---|
static String |
ELEVATION_DOMAIN
Elevation domain (comma separated list of values)
|
static String |
ELEVATION_DOMAIN_MAXIMUM
Elevation domain maximum value
|
static String |
ELEVATION_DOMAIN_MINIMUM
Elevation domain minimum value
|
static String |
ELEVATION_DOMAIN_RESOLUTION
Elevation domain resolution
|
static String |
FILE_SOURCE_PROPERTY
If a coverage has this property is means it been read straight out of a file without any
sub-setting, it means the coverage represents the full contents of the file.
|
static String |
HAS_ELEVATION_DOMAIN
Whether the elevation is expressed as a full domain or min/max/resolution (true if domain
list available)
|
static String |
HAS_TIME_DOMAIN
If the time domain is available (or if a min/max/resolution approach has been chosen)
|
static String |
MULTICRS_READER
This property is present, and evaluates to "true", if the reader internally has multiple CRS
elements, even if it advertises a single CRS in output (e.g., it won't perform a general
reprojection for us, but generate and output in its declared CRS)
|
static String |
REPROJECTING_READER
This property is present, and evaluates to "true", if the reader can do reprojection on its
own (that is, it is not backed by actual data, but by a remote service that can perform
reprojection for us).
|
static String |
SOURCE_URL_PROPERTY
Name of a
GridCoverage2D property that is a URL for the original source of
the coverage. |
static String |
TIME_DOMAIN
The time domain (comma separated list of values)
|
static String |
TIME_DOMAIN_MAXIMUM
The time domain max value
|
static String |
TIME_DOMAIN_MINIMUM
The time domain min value
|
static String |
TIME_DOMAIN_RESOLUTION
Time domain resolution (when using min/max/resolution)
|
Modifier and Type | Method and Description |
---|---|
CoordinateReferenceSystem |
getCoordinateReferenceSystem()
Retrieves the
CoordinateReferenceSystem associated to the default coverage for this
GridCoverage2DReader . |
CoordinateReferenceSystem |
getCoordinateReferenceSystem(String coverageName)
Retrieves the
CoordinateReferenceSystem associated to this GridCoverage2DReader for the specified coverageName. |
DatasetLayout |
getDatasetLayout()
Returns the
DatasetLayout for the coverage. |
DatasetLayout |
getDatasetLayout(String coverageName)
Returns the
DatasetLayout for the specified coverage. |
Set<ParameterDescriptor<List>> |
getDynamicParameters()
Return the
Set of dynamic read parameters supported by this GridCoverage2DReader for the default coverage. |
Set<ParameterDescriptor<List>> |
getDynamicParameters(String coverageName)
Return the
Set of dynamic read parameters supported by this GridCoverage2DReader for the specified coverage. |
ImageLayout |
getImageLayout()
Retrieve the
ImageLayout for the default coverage. |
ImageLayout |
getImageLayout(String coverageName)
Retrieve the
ImageLayout for the specified coverage. |
ServiceInfo |
getInfo()
Information about the store.
|
ResourceInfo |
getInfo(String coverageName)
Information about a specific resource.
|
int |
getNumOverviews()
Deprecated.
It should be used getDatasetLayout().getNumInternalOverviews() instead
|
int |
getNumOverviews(String coverageName)
Deprecated.
It should be used getDatasetLayout().getNumInternalOverviews() instead
|
GeneralEnvelope |
getOriginalEnvelope()
Return the original
GeneralEnvelope for the default coverage served by the underlying
store. |
GeneralEnvelope |
getOriginalEnvelope(String coverageName)
Return the original
GeneralEnvelope for the specified coverageName. |
GridEnvelope |
getOriginalGridRange()
Retrieves the
GridEnvelope associated to the default coverage for this GridCoverage2DReader . |
GridEnvelope |
getOriginalGridRange(String coverageName)
Retrieves the
GridEnvelope associated to the specified coverageName for this GridCoverage2DReader . |
MathTransform |
getOriginalGridToWorld(PixelInCell pixInCell)
Retrieves the
MathTransform associated to the default coverage for this GridCoverage2DReader . |
MathTransform |
getOriginalGridToWorld(String coverageName,
PixelInCell pixInCell)
Retrieves the
MathTransform associated to the requested coverageName for this GridCoverage2DReader . |
double[] |
getReadingResolutions(OverviewPolicy policy,
double[] requestedResolution)
Return the resolution of the overview which would be picked out for the provided requested
resolution using the provided
OverviewPolicy . |
double[] |
getReadingResolutions(String coverageName,
OverviewPolicy policy,
double[] requestedResolution)
Return the resolution of the overview which would be picked out for the provided requested
resolution using the provided
OverviewPolicy . |
double[][] |
getResolutionLevels()
Retrieve the resolution levels for the default coverage.
|
double[][] |
getResolutionLevels(String coverageName)
Retrieve the resolution levels for the specified coverage.
|
GridCoverage2D |
read(GeneralParameterValue[] parameters)
Created a
GridCoverage2D out of this GridCoverage2DReader for the default
coverage. |
GridCoverage2D |
read(String coverageName,
GeneralParameterValue[] parameters)
Retrieves the
GridEnvelope associated to the specified coverageName for this GridCoverage2DReader . |
dispose, getCurrentSubname, getFormat, getGridCoverageCount, getGridCoverageNames, getMetadataNames, getMetadataNames, getMetadataValue, getMetadataValue, getSource, hasMoreGridCoverages, listSubNames, skip
static final String TIME_DOMAIN
static final String TIME_DOMAIN_RESOLUTION
static final String HAS_TIME_DOMAIN
static final String TIME_DOMAIN_MAXIMUM
static final String TIME_DOMAIN_MINIMUM
static final String HAS_ELEVATION_DOMAIN
static final String ELEVATION_DOMAIN
static final String ELEVATION_DOMAIN_MAXIMUM
static final String ELEVATION_DOMAIN_MINIMUM
static final String ELEVATION_DOMAIN_RESOLUTION
static final String FILE_SOURCE_PROPERTY
static final String SOURCE_URL_PROPERTY
GridCoverage2D
property that is a URL
for the original source of
the coverage. This URL
might be used to obtain further information on the coverage
that is not otherwise available through the GridCoverage2D
API.static final String REPROJECTING_READER
static final String MULTICRS_READER
GeneralEnvelope getOriginalEnvelope()
GeneralEnvelope
for the default coverage served by the underlying
store.GeneralEnvelope
for the default coverage served by the
underlying store.GeneralEnvelope getOriginalEnvelope(String coverageName)
GeneralEnvelope
for the specified coverageName.coverageName
- the name of the coverage to work on.GeneralEnvelope
for the specified coverageName.NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existCoordinateReferenceSystem getCoordinateReferenceSystem()
CoordinateReferenceSystem
associated to the default coverage for this
GridCoverage2DReader
.
CoordinateReferenceSystem
mapped to the specified coverageName, or null
if the provided coverageName does not map to a real coverage.NullPointerException
- if the specified coverageName is null
CoordinateReferenceSystem getCoordinateReferenceSystem(String coverageName)
CoordinateReferenceSystem
associated to this GridCoverage2DReader
for the specified coverageName.
CoordinateReferenceSystem
mapped to the specified coverageNameNullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existGridEnvelope getOriginalGridRange()
GridEnvelope
associated to the default coverage for this GridCoverage2DReader
.
The GridEnvelope
describes the raster area (in pixels) covered by the coverage.
CoordinateReferenceSystem
mapped to the default coverageNameGridEnvelope getOriginalGridRange(String coverageName)
GridEnvelope
associated to the specified coverageName for this GridCoverage2DReader
.
The GridEnvelope
describes the raster area (in pixels) covered by the coverage.
coverageName
- the name of the coverage to work withGridEnvelope
mapped to the specified coverageNameNullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existMathTransform getOriginalGridToWorld(PixelInCell pixInCell)
MathTransform
associated to the default coverage for this GridCoverage2DReader
.
CoordinateReferenceSystem
mapped to the default coverageNameMathTransform getOriginalGridToWorld(String coverageName, PixelInCell pixInCell)
MathTransform
associated to the requested coverageName for this GridCoverage2DReader
.coverageName
- the name of the coverage to work withMathTransform
mapped to the specified coverageNameNullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existGridCoverage2D read(GeneralParameterValue[] parameters) throws IOException
GridCoverage2D
out of this GridCoverage2DReader
for the default
coverage.read
in interface GridCoverageReader
parameters
- an array of GeneralParameterValue
that uses a subset of the
available read params for this GridCoverage2DReader
as specified by the Format
GridCoverage2D
for the underlying default coverage for this GridCoverage2DReader
or null
in case no GridCoverage2D
can be read
for the provided parameters.IOException
- in case an error happen during read time.GridCoverage2D read(String coverageName, GeneralParameterValue[] parameters) throws IOException
GridEnvelope
associated to the specified coverageName for this GridCoverage2DReader
.read
in interface GridCoverageReader
coverageName
- the name of the coverage to work withparameters
- an array of GeneralParameterValue
that uses a subset of the
available read params for this GridCoverage2DReader
as specified by the Format
GridCoverage2D
for the underlying default coverage for this GridCoverage2DReader
or null
in case no GridCoverage2D
can be read
for the provided parameters.NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existIOException
- 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.Set<ParameterDescriptor<List>> getDynamicParameters() throws IOException
Set
of dynamic read parameters supported by this GridCoverage2DReader
for the default coverage.Set
of dynamic read parameters supported by this GridCoverage2DReader
.IOException
- in case an error occurs while creating the Set
of dynamic
parameters.Set<ParameterDescriptor<List>> getDynamicParameters(String coverageName) throws IOException
Set
of dynamic read parameters supported by this GridCoverage2DReader
for the specified coverage.coverageName
- the name of the coverage to work withSet
of dynamic read parameters supported by this GridCoverage2DReader
.IOException
- in case an error occurs while creating the Set
of dynamic
parameters.NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existdouble[] getReadingResolutions(OverviewPolicy policy, double[] requestedResolution) throws IOException
OverviewPolicy
. This method works on the default
coverage for this GridCoverage2DReader
.policy
- the OverviewPolicy
to use during evaluation.requestedResolution
- the requested resolutionIOException
- in case an error occurs.double[] getReadingResolutions(String coverageName, OverviewPolicy policy, double[] requestedResolution) throws IOException
OverviewPolicy
. This method works on the specified
coverage for this GridCoverage2DReader
.coverageName
- the name of the coverage to work on.policy
- the OverviewPolicy
to use during evaluation.requestedResolution
- the requested resolutionIOException
- in case an error occurs.NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existint getNumOverviews()
int getNumOverviews(String coverageName)
coverageName
- the name of the coverage for which we do want to get the number of
overviews.NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existDatasetLayout getDatasetLayout()
DatasetLayout
for the coverage.DatasetLayout
object containing info about Overview number and Image masks.DatasetLayout getDatasetLayout(String coverageName)
DatasetLayout
for the specified coverage.coverageName
- the name of the coverage for which we do want to get the DatasetLayout
DatasetLayout
object containing info about Overview number and Image masks.ImageLayout getImageLayout() throws IOException
ImageLayout
for the default coverage.
Throw an IllegalArgumentException
in case the name is wrong and/or no such a
coverage exists.
ImageLayout
that is useful for actually knowing the ColorModel
,
the SampleModel
as well as the tile grid for the default coverage.IOException
ImageLayout getImageLayout(String coverageName) throws IOException
ImageLayout
for the specified coverage.
Throw an IllegalArgumentException
in case the name is wrong and/or no such a
coverage exists.
coverageName
- the name of the coverage for which we want to know the GridEnvelope
.ImageLayout
that is useful for actually knowing the ColorModel
,
the SampleModel
as well as the tile grid for a certain coverage.NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existIOException
double[][] getResolutionLevels() throws IOException
Throw an IllegalArgumentException
in case the name is wrong and/or no such a
coverage exists.
NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existIOException
double[][] getResolutionLevels(String coverageName) throws IOException
Throw an IllegalArgumentException
in case the name is wrong and/or no such a
coverage exists.
coverageName
- the name of the coverage for which we want to know the resolution levels.NullPointerException
- if the specified coverageName is null
IllegalArgumentException
- if the specified coverageName does not existIOException
ServiceInfo getInfo()
ResourceInfo getInfo(String coverageName)
Copyright © 1996–2019 Geotools. All rights reserved.