"""
Data request interface for Geopedia services
"""
from __future__ import annotations
from abc import abstractmethod
from typing import Any
from ..base import DataRequest
from ..constants import CRS, MimeType, ServiceType
from ..download import DownloadClient
from ..geometry import BBox
from .core import GeopediaFeatureIterator, GeopediaImageService, GeopediaSession, GeopediaWmsService
[docs]class GeopediaRequest(DataRequest):
"""The base class for Geopedia requests where all common parameters are defined."""
def __init__(
self,
layer: str | int,
service_type: ServiceType,
*,
bbox: BBox,
theme: str | None = None,
image_format: MimeType = MimeType.PNG,
**kwargs: Any,
):
"""
:param layer: Geopedia layer which contains requested data
:param service_type: Type of the service, supported are ``ServiceType.WMS`` and ``ServiceType.IMAGE``
:param bbox: Bounding box of the requested data
:param theme: Geopedia's theme endpoint string for which the layer is defined. Only required by WMS service.
:param image_format: Format of the returned image by the Sentinel Hub's WMS getMap service. Default is
``constants.MimeType.PNG``.
:param data_folder: Location of the directory where the fetched data will be saved.
:param config: A custom instance of config class to override parameters from the saved configuration.
"""
self.layer = layer
self.service_type = service_type
self.bbox = bbox
if bbox.crs is not CRS.POP_WEB:
raise ValueError(
f"Geopedia Request at the moment supports only bounding boxes with coordinates in {CRS.POP_WEB}"
)
self.theme = theme
self.image_format = MimeType(image_format)
super().__init__(DownloadClient, **kwargs)
[docs] @abstractmethod
def create_request(self) -> None:
raise NotImplementedError
[docs]class GeopediaWmsRequest(GeopediaRequest):
"""Web Map Service request class for Geopedia
Creates an instance of Geopedia's WMS (Web Map Service) GetMap request, which provides access to WMS layers in
Geopedia.
"""
def __init__(
self,
layer: str | int,
theme: str,
bbox: BBox,
*,
width: int | None = None,
height: int | None = None,
**kwargs: Any,
):
"""
:param layer: Geopedia layer which contains requested data
:param theme: Geopedia's theme endpoint string for which the layer is defined.
:param bbox: Bounding box of the requested data
:param width: width (number of columns) of the returned image (array)
:param height: height (number of rows) of the returned image (array)
:param image_format: Format of the returned image by the Sentinel Hub's WMS getMap service. Default is
``constants.MimeType.PNG``.
:param data_folder: Location of the directory where the fetched data will be saved.
:param config: A custom instance of config class to override parameters from the saved configuration.
"""
self.size_x = width
self.size_y = height
super().__init__(layer=layer, theme=theme, bbox=bbox, service_type=ServiceType.WMS, **kwargs)
[docs] def create_request(self) -> None:
"""Set download requests
Create a list of DownloadRequests for all Sentinel-2 acquisitions within request's time interval and
acceptable cloud coverage.
"""
gpd_service = GeopediaWmsService(config=self.config)
self.download_list = gpd_service.get_request(self) # type: ignore[arg-type]
[docs]class GeopediaImageRequest(GeopediaRequest):
"""Request to access data in a Geopedia vector / raster layer."""
def __init__(
self,
*,
image_field_name: str,
keep_image_names: bool = True,
gpd_session: GeopediaSession | None = None,
**kwargs: Any,
):
"""
:param image_field_name: Name of the field in the data table which holds images
:param keep_image_names: If `True` images will be saved with the same names as in Geopedia otherwise Geopedia
hashes will be used as names. If there are multiple images with the same names in the Geopedia layer this
parameter should be set to `False` to prevent images being overwritten.
:param layer: Geopedia layer which contains requested data
:param bbox: Bounding box of the requested data
:param image_format: Format of the returned image by the Sentinel Hub's WMS getMap service. Default is
``constants.MimeType.PNG``.
:param gpd_session: Optional parameter for specifying a custom Geopedia session, which can also contain login
credentials. This can be used for accessing private Geopedia layers. By default, it is set to `None` and a
basic Geopedia session without credentials will be created.
:param data_folder: Location of the directory where the fetched data will be saved.
:param config: A custom instance of config class to override parameters from the saved configuration.
"""
self.image_field_name = image_field_name
self.keep_image_names = keep_image_names
self.gpd_session = gpd_session
self.gpd_iterator: GeopediaFeatureIterator | None = None
super().__init__(service_type=ServiceType.IMAGE, **kwargs)
[docs] def create_request(self, reset_gpd_iterator: bool = False) -> None:
"""Set a list of download requests
Set a list of DownloadRequests for all images that are under the
given property of the Geopedia's Vector layer.
:param reset_gpd_iterator: When re-running the method this flag is used to reset/keep existing ``gpd_iterator``
(i.e. instance of ``GeopediaFeatureIterator`` class). If the iterator is not reset you don't have to
repeat a service call but tiles and dates will stay the same.
"""
if reset_gpd_iterator:
self.gpd_iterator = None
gpd_service = GeopediaImageService(config=self.config)
self.download_list = gpd_service.get_request(self)
self.gpd_iterator = gpd_service.get_gpd_iterator()
[docs] def get_items(self) -> GeopediaFeatureIterator | None:
"""Returns iterator over info about data used for this request
:return: Iterator of dictionaries containing info about data used in
this request.
"""
return self.gpd_iterator