satellitetools.common.wrappers
==============================

.. py:module:: satellitetools.common.wrappers

.. autoapi-nested-parse::

   Wrapper functions for Sentinel-2 data retrieval.

   @author: Olli Nevalainen (Finnish Meteorological Institute)



Attributes
----------

.. autoapisummary::

   satellitetools.common.wrappers.logger


Functions
---------

.. autoapisummary::

   satellitetools.common.wrappers.get_s2_qi_and_data


Module Contents
---------------

.. py:data:: logger

.. py:function:: get_s2_qi_and_data(aoi: satellitetools.common.classes.AOI, req_params: satellitetools.common.sentinel2.Sentinel2RequestParams, qi_threshold: Optional[float] = 0.02, qi_filter: Optional[List[satellitetools.common.sentinel2.SCLClass]] = S2_FILTER1, multiprocessing: Optional[int] = None) -> Tuple[pandas.DataFrame, xarray.Dataset]

   Get Sentinel-2 quality information and data.

   Parameters:
   ----------------
   aoi: AOI
       Area of interest.
   req_params: Sentinel2RequestParams
       Request parameters.
   qi_threshold: Optional[float]
       Quality information threshold.
   qi_filter: Optional[List[SCLClass]]
       Sentinel-2 scene classification filter.
   multiprocessing: Optional[int]
       Number of parallel downloads used with AWS data source.

   Returns:
   ----------------
   Tuple[pd.DataFrame, xr.Dataset]
       Tuple of quality information DataFrame and xarray Dataset.