Class MultilevelTiledRasterModelBuilder
- All Implemented Interfaces:
AutoCloseable
The multi-level tile structure is defined by a reference and a number of levels where each level has a bounds and a number of columns and rows. The structure of the tiles is organized as follows:
- Level 0 is the least detailed level.
- The tile coordinate
(N,0,0)
on levelN
is the top-left tile.
The IMultilevelTiledRasterDataRetriever
interface allows to load the tile data, or it allows to indicate that there is no data available for a tile. The latter for example allows to create low resolution overlays on high resolution data.
The following figure shows how such a multi-level tile structure looks like.
This builder supports either imagery (RGBA) data or elevation data. The latter can be enabled by calling MultilevelTiledRasterModelBuilder#elevation
.
This article gives an example of how to use this class.
- Tile Matrix Set limitations.
- The tiles of detail levels should overlap with tiles of the parent level. If this is not the case such tiles are not painted on the map.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddLevel
(long tileWidthPixels, long tileHeightPixels, long columnCount, long rowCount, Bounds bounds) Adds a level of detail to the raster data structure.attributionProvider
(IMultilevelTiledAttributionProvider attributionProvider) Sets the attribution provider for this model.build()
Creates the raster model.void
close()
dataBounds
(Bounds bounds) Defines the extent of where actual data is a available.dataRetriever
(IMultilevelTiledRasterDataRetriever dataRetriever) Defines the implementation to be used to retrieve the raster tile data.Marks this model as an elevation model.elevationNoDataValue
(float noDataValue) Sets a no-data value for elevation data.Allows to create a raster model which can be invalidated.protected void
finalize()
modelMetadata
(ModelMetadata modelMetadata) Defines the model metadata.Creates the builder class to create a raster model.reference
(CoordinateReference modelReference) Defines the reference in which the raster data is defined.samplingMode
(RasterSamplingMode samplingMode) Defines the sampling mode of the data.
-
Constructor Details
-
Method Details
-
finalize
protected void finalize() -
close
public void close()- Specified by:
close
in interfaceAutoCloseable
-
newBuilder
Creates the builder class to create a raster model.- Returns:
- the builder class for creation of a 'basic'
IRasterModel
.
-
reference
@NotNull public MultilevelTiledRasterModelBuilder reference(@NotNull CoordinateReference modelReference) Defines the reference in which the raster data is defined.This information is mandatory.
- Parameters:
modelReference
- the reference for the raster data. Cannot benull
.- Returns:
- this builder.
-
addLevel
@NotNull public MultilevelTiledRasterModelBuilder addLevel(long tileWidthPixels, long tileHeightPixels, long columnCount, long rowCount, @NotNull Bounds bounds) Adds a level of detail to the raster data structure.At least 1 level must be created.
The order in which this method is called matters: it determines which level is added. The first call is for level 0 (the least detailed level), the second call for level 1, and so on..
All levels must be defined in the same reference.
- Parameters:
tileWidthPixels
- the width, in pixels, for a tile within the tiled structure.tileHeightPixels
- the height, in pixels, for a tile within the tiled structure.columnCount
- the number of columns within the tiled structure.rowCount
- the number of rows within the tiled structure.bounds
- the extent of the tiled structure.- Returns:
- this builder.
-
dataBounds
Defines the extent of where actual data is a available.This information is optional. If not defined the extent of the data is assumed to be based the entire structure.
- Parameters:
bounds
- the extent of the 'actual' data.- Returns:
- this builder.
-
samplingMode
@NotNull public MultilevelTiledRasterModelBuilder samplingMode(@NotNull RasterSamplingMode samplingMode) Defines the sampling mode of the data.This information is optional. The default value is
Area
.- Parameters:
samplingMode
- the sampling mode of the data.- Returns:
- this builder.
-
modelMetadata
@NotNull public MultilevelTiledRasterModelBuilder modelMetadata(@NotNull ModelMetadata modelMetadata) Defines the model metadata.This information is mandatory.
- Parameters:
modelMetadata
- the model metadata.- Returns:
- this builder.
-
elevation
Marks this model as an elevation model.If this method is called, the
configured
IMultilevelTiledRasterDataRetriever
must return elevation data as well. SeeIMultilevelTiledRasterDataRetrieverCallback#onDataAvailable
andIMultilevelTiledRasterDataRetrieverCallback#onImageAvailable
for more information.- Returns:
- this builder
-
elevationNoDataValue
Sets a no-data value for elevation data.When the provided elevation data in
IMultilevelTiledRasterDataRetrieverCallback
contains this value, it is interpreted as a no-data value. This means that consumers of the data will have information that no data is available at that location, and that they can choose an appropriate fallback. For example when terrain is visualized, it can decide to fall back on other elevation data when it encounters a no-data elevation value.This method is optional.
This method must only be called when the
elevation
method is also called. If not, thebuild
method will throw an exception.- Parameters:
noDataValue
- the no-data value to use for elevation- Returns:
- this builder
- Since:
- 2023.0
-
dataRetriever
@NotNull public MultilevelTiledRasterModelBuilder dataRetriever(@NotNull IMultilevelTiledRasterDataRetriever dataRetriever) Defines the implementation to be used to retrieve the raster tile data.This information is mandatory. A user implementation must be provided.
- Parameters:
dataRetriever
- the interface that is called to retrieve the raster tile data. Cannot benull
.- Returns:
- this builder.
-
attributionProvider
@NotNull public MultilevelTiledRasterModelBuilder attributionProvider(@NotNull IMultilevelTiledAttributionProvider attributionProvider) Sets the attribution provider for this model.By default, no attribution provider is set.
- Parameters:
attributionProvider
- the attribution provider for the model. Can benull
.- Returns:
- this builder.
- Since:
- 2024.0
-
enableInvalidation
Allows to create a raster model which can be invalidated.By default raster models are created without invalidation.
Call this method when you need a raster model for which the content can change. Then a
IRasterModel
is created that returnstrue
forIRasterModel#canInvalidate
and for which you can call the methodIRasterModel#invalidate
to indicate the content of the raster model has changed.- Returns:
- this builder.
-
build
Creates the raster model.Mandatory information:
- the reference of the raster data
- at least one level of detail
- all levels are defined in the same reference
- model metadata
- data retriever
When calling the method
MultilevelTiledRasterModelBuilder#dataBounds
the bounds must be contained within the bounds for every defined level.- Returns:
- the raster model, or a
java.lang.IllegalStateException
when the conditions to build the raster model are not met.
-