satellitetools.common.classes
=============================

.. py:module:: satellitetools.common.classes

.. autoapi-nested-parse::

   Common classes for gee and aws_cog process.

   @author: Olli Nevalainen (Finnish Meteorological Institute)



Attributes
----------

.. autoapisummary::

   satellitetools.common.classes.logger


Classes
-------

.. autoapisummary::

   satellitetools.common.classes.StrEnum
   satellitetools.common.classes.DataSource
   satellitetools.common.classes.AOI
   satellitetools.common.classes.RequestParams


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

.. py:class:: StrEnum

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


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.

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


.. py:data:: logger

.. 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:: 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:: RequestParams(*args, **kwargs)