sentinelhub.api.fis

Module for working with Sentinel Hub FIS service

class sentinelhub.api.fis.HistogramType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Enum class for types of histogram supported by Sentinel Hub FIS service

Supported histogram types are EQUALFREQUENCY, EQUIDISTANT and STREAMING

EQUALFREQUENCY = 'equalfrequency'
EQUIDISTANT = 'equidistant'
STREAMING = 'streaming'
class sentinelhub.api.fis.FisRequest(layer, time, geometry_list, *, resolution='10m', bins=None, histogram_type=None, **kwargs)[source]

Bases: OgcRequest

Deprecated - use Statistical API instead!

The class for interacting with Feature Info Service.

For more info check FIS documentation.

Parameters:

  • layer (str) – An ID of a layer configured in Sentinel Hub Dashboard. It has to be configured for the same instance ID which will be used for this request. The satellite collection of the layer in Dashboard must also match the one given by data_collection parameter.

  • time (RawTimeType | RawTimeIntervalType) – time or time range for which to return the results, in ISO8601 format (year-month-date, for example: 2016-01-01, or year-month-dateThours:minutes:seconds format, i.e. 2016-01-01T16:31:21). Examples: '2016-01-01', or ('2016-01-01', ' 2016-01-31') (datetime.datetime, datetime.datetime)

  • geometry_list (list[Geometry | BBox]) – A WKT representation of a geometry describing the region of interest. Note that WCS 1.1.1 standard is used here, so for EPSG:4326 coordinates should be in latitude/longitude order.

  • resolution (str) – Specifies the spatial resolution, in meters per pixel, of the image from which the statistics are to be estimated. When using CRS=EPSG:4326 one has to add the “m” suffix to enforce resolution in meters per pixel (e.g. RESOLUTION=10m).

  • bins (str | None) – The number of bins (a positive integer) in the histogram. If this parameter is absent no histogram is computed.

  • histogram_type (HistogramType | None) – type of histogram

  • data_collection – A collection of requested satellite data. It has to be the same as defined in Sentinel Hub Dashboard for the given layer. Default is Sentinel-2 L1C.

  • maxcc – maximum accepted cloud coverage of an image. Float between 0.0 and 1.0. Default is 1.0.

  • custom_url_params – Dictionary of CustomUrlParameters and their values supported by Sentinel Hub’s WMS and WCS services. All available parameters are described in documentation. Note: in case of constants.CustomUrlParam.EVALSCRIPT the dictionary value must be a string of Javascript code that is not encoded into base64.

  • data_folder – location of the directory where the fetched data will be saved.

  • config – A custom instance of config class to override parameters from the saved configuration.

  • kwargs (Any) –

DEPRECATION_MESSAGE = 'Fis service is being deprecated in favour of SentinelHubStatistical. Although no immediate action is needed as FIS is still supported, consider switching to Statistical API because it provides additional functionalities.'
create_request()[source]

Set download requests

Create a list of DownloadRequests for all Sentinel-2 acquisitions within request’s time interval and acceptable cloud coverage.

Return type:

None

get_dates()[source]

This method is not supported for FIS request

Return type:

list[datetime.datetime | None]

get_tiles()[source]

This method is not supported for FIS request

Return type:

WebFeatureService | None