- The function input is a position valid in the coverage domain. In the particular case of
GridCoverage, the domain is described by a grid geometry.
- The function output is a record of values in the coverage range. In the particular case of
GridCoverage, the range is described by a list of sample dimensions.
Aggregateif a single file can provide many rasters.
Defined in the
Method SummaryModifier and TypeMethodDescriptionReturns the valid extent of grid coordinates together with the conversion from those grid coordinates to real world coordinates.
default RasterLoadingStrategyReturns an indication about when the "physical" loading of raster data will happen.Returns the ranges of sample values together with the conversion from samples to real values.Loads a subset of the grid coverage represented by this resource.
default booleanSets the preferred strategy about when to do the "physical" loading of raster data.
default GridCoverageResourceRequests a subset of the coverage.
getGridGeometryReturns the valid extent of grid coordinates together with the conversion from those grid coordinates to real world coordinates. A grid geometry contains the following information:
- The minimum and maximum grid coordinates as integers (the Grid Extent). The minimum coordinates are typically (0,0, …, 0) but not necessarily.
- The minimum and maximum "real world" coordinates (the Envelope). Those coordinates are typically, but not necessarily, latitudes and longitudes or projected coordinates, together with altitudes and dates.
- A description of the datum and axes of above "real world" coordinates (the Coordinate Reference System).
- The conversion from grid coordinates to "real world" coordinates. This conversion is often, but not necessarily, a linear relationship. Axis order or direction may be changed by the conversion. For example row indices may be increasing toward down while latitude coordinates are increasing toward up.
- An estimation of grid resolution for each "real world" axis.
read(null).getGridGeometry(). However the grid geometry returned by this method is allowed to be only approximate if computing accurate information would be prohibitively expensive, or if the grid geometry depends on the exact argument value given to the
read(…)method. At least, the number of dimensions should match.
getSampleDimensionsReturns the ranges of sample values together with the conversion from samples to real values. Sample dimensions contain the following information:
- The range of valid sample values, typically but not necessarily as positive integers.
- A transfer function for converting sample values to real values, for example measurements of a geophysics phenomenon. The transfer function is typically defined by a scale factor and an offset, but is not restricted to such linear equations.
- The units of measurement of "real world" values after their conversions from sample values.
- The sample values reserved for missing values.
The list returned by this method should be equal to the list returned by
read(null).getSampleDimensions(). However the sample dimensions returned by this method is allowed to be only approximate if computing accurate information would be prohibitively expensive, or if the sample dimensions depend on the
domainargument (area of interest) given to the
read(…)method. At least, the number of sample dimensions should match.
subsetdefault GridCoverageResource subset
(Query query) throws UnsupportedQueryException, DataStoreExceptionRequests a subset of the coverage. The filtering can be applied in two aspects:
- The returned
GridCoverageResourcemay contain a smaller domain (grid extent).
- The returned
GridCoverageResourcemay contain a smaller range (less sample dimensions).
The returned subset may be a view of this set, i.e. changes in this
GridCoverageResourcemay be reflected immediately on the returned subset (and conversely), but not necessarily. However the returned subset may not have the same capabilities as this
GridCoverageResource. In particular, write operations may become unsupported after complex queries.
The default implementation throws
query- definition of domain (grid extent) and range (sample dimensions) filtering applied at reading time.
- resulting coverage resource (never
UnsupportedQueryException- if this
GridCoverageResourcecan not execute the given query. This includes query validation errors.
DataStoreException- if another error occurred while processing the query.
- The returned
readLoads a subset of the grid coverage represented by this resource. If a non-null grid geometry is specified, then this method will try to return a grid coverage matching the given grid geometry on a best-effort basis; the coverage actually returned may have a different resolution, cover a different area in a different CRS, etc. The general contract is that the returned coverage should not contain less data than a coverage matching exactly the given geometry.
The returned coverage shall contain the exact set of sample dimensions specified by the
rangeargument, in the specified order (the "best-effort basis" flexibility applies only to the grid geometry, not to the range). All
rangevalues shall be between 0 inclusive and
getSampleDimensions().size()exclusive, without duplicated values.
While this method name suggests an immediate reading, some implementations may defer the actual reading at a later stage.
domain- desired grid extent and resolution, or
nullfor reading the whole domain.
range- 0-based indices of sample dimensions to read, or
nullor an empty sequence for reading them all.
- the grid coverage for the specified domain and range.
DataStoreException- if an error occurred while reading the grid coverage data.
getLoadingStrategydefault RasterLoadingStrategy getLoadingStrategy()Returns an indication about when the "physical" loading of raster data will happen. This is the strategy actually applied by this resource implementation, not necessarily the strategy given in the last call to
The default strategy is to load raster data at
read(…)method invocation time.
- current raster data loading strategy for this resource.
setLoadingStrategydefault boolean setLoadingStrategy
(RasterLoadingStrategy strategy)Sets the preferred strategy about when to do the "physical" loading of raster data. Implementations are free to ignore this parameter or to replace the given strategy by the closest alternative that this resource can support.
strategy- the desired strategy for loading raster data.
trueif the given strategy has been accepted, or
falseif this implementation replaced the given strategy by an alternative.