satellitetools
==============

.. py:module:: satellitetools


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/satellitetools/aws/index
   /autoapi/satellitetools/biophys/index
   /autoapi/satellitetools/common/index
   /autoapi/satellitetools/gee/index


Classes
-------

.. autoapisummary::

   satellitetools.AOI
   satellitetools.DataSource
   satellitetools.S2Band
   satellitetools.SCLClass
   satellitetools.Sentinel2RequestParams


Package Contents
----------------

.. py:class:: AOI(name: str, geometry: Union[str, shapely.geometry.Polygon, shapely.geometry.MultiPolygon], geometry_crs: str, tile: str = None)

   Area of interest (AOI) class.

   Attributes:
   name: str
       Name of the AOI.
   geometry: Union[str, Polygon]
       Geometry of the AOI. Can be either a WKT string or a shapely Polygon.
   geometry_crs: str
       Coordinate reference system of the geometry.
   tile: str
       Sentinel-2 tile ID.


   Initialize the AOI class.

   Parameters:
   name: str
       Name of the AOI.
   geometry: Union[str, Polygon]
       Geometry of the AOI. Can be either a WKT string or a shapely Polygon.
   geometry_crs: str
       Coordinate reference system of the geometry.
   tile: str
       Sentinel-2 tile ID.


   .. py:attribute:: name


   .. py:attribute:: geometry


   .. py:attribute:: geometry_crs


   .. py:attribute:: tile
      :value: None



   .. py:method:: __repr__() -> str


.. py:class:: DataSource

   Bases: :py:obj:`enum.StrEnum`


   Data source for the data request.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: GEE
      :value: 'gee'



   .. py:attribute:: AWS
      :value: 'aws_cog'



.. py:class:: S2Band

   Bases: :py:obj:`enum.StrEnum`


   Sentinel-2 bands.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: B1
      :value: 'B1'



   .. py:attribute:: B2
      :value: 'B2'



   .. py:attribute:: B3
      :value: 'B3'



   .. py:attribute:: B4
      :value: 'B4'



   .. py:attribute:: B5
      :value: 'B5'



   .. py:attribute:: B6
      :value: 'B6'



   .. py:attribute:: B7
      :value: 'B7'



   .. py:attribute:: B8
      :value: 'B8'



   .. py:attribute:: B8A
      :value: 'B8A'



   .. py:attribute:: B9
      :value: 'B9'



   .. py:attribute:: B11
      :value: 'B11'



   .. py:attribute:: B12
      :value: 'B12'



   .. py:attribute:: AOT
      :value: 'AOT'



   .. py:attribute:: WVP
      :value: 'WVP'



   .. py:attribute:: SCL
      :value: 'SCL'



   .. py:method:: to_aws() -> str

      Convert band name to AWS band name.
      Returns:
      ----------------
      str
          Band name in AWS.




   .. py:method:: to_gee() -> str

      Convert band name to GEE band name.

      Returns:
      ----------------
      str
          Band name in GEE.




   .. py:method:: get_10m_to_20m_bands() -> List[S2Band]
      :classmethod:


      Get 10-20 m bands for the band.

      Returns:
      ----------------
      List[S2Band]
          List of 10-20 m bands.




   .. py:method:: get_all_bands() -> List[S2Band]
      :classmethod:


      Get all bands for the band.

      Returns:
      ----------------
      List[S2Band]
          List of all bands.




.. py:class:: SCLClass(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Sentinel-2 Scene Classification Layer (SCL) classes.


   .. py:attribute:: NODATA
      :value: 0



   .. py:attribute:: SATURATED_DEFECTIVE
      :value: 1



   .. py:attribute:: DARK_FEATURE_SHADOW
      :value: 2



   .. py:attribute:: CLOUD_SHADOW
      :value: 3



   .. py:attribute:: VEGETATION
      :value: 4



   .. py:attribute:: NOT_VEGETATED
      :value: 5



   .. py:attribute:: WATER
      :value: 6



   .. py:attribute:: UNCLASSIFIED
      :value: 7



   .. py:attribute:: CLOUD_MEDIUM_PROBA
      :value: 8



   .. py:attribute:: CLOUD_HIGH_PROBA
      :value: 9



   .. py:attribute:: THIN_CIRRUS
      :value: 10



   .. py:attribute:: SNOW_ICE
      :value: 11



.. py:class:: Sentinel2RequestParams(datestart: str, dateend: str, datasource: satellitetools.common.classes.DataSource, bands: List[S2Band] = None, target_gsd: float = 20, qi_evaluation_scale: float = 20)

   S2 data request paramaters.

   Attributes:
   ----------------
   datestart : str
       Start date of the data request.
   dateend : str
       End date of the data request.
   datasource : DataSource
       Data source for the request.
   bands : List[S2Band]
       List of Sentinel-2 bands to request.
   target_gsd : float
       Target ground sampling distance (GSD) in meters.
   qi_evaluation_scale : float
       Quality indicator evaluation scale.


   Initialize the Sentinel2RequestParams class.

   Parameters:
   ----------------
   datestart : str
       Start date of the data request.
   dateend : str
       End date of the data request.
   datasource : DataSource
       Data source for the request.
   bands : List[S2Band]
       List of Sentinel-2 bands to request.
   target_gsd : float
       Target ground sampling distance (GSD) in meters.
   qi_evaluation_scale : float
       Quality indicator evaluation scale.


   .. py:attribute:: datestart


   .. py:attribute:: dateend


   .. py:attribute:: datasource


   .. py:attribute:: target_gsd
      :value: 20



   .. py:attribute:: qi_evaluation_scale
      :value: 20



   .. py:method:: __repr__() -> str