:py:mod:`ecoscope.analysis.percentile`
======================================

.. py:module:: ecoscope.analysis.percentile


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

.. py:class:: PercentileAreaProfile


   .. py:attribute:: input_raster
      :type: Union[str, bytes, os.PathLike]

      

   .. py:attribute:: percentile_levels
      :type: List

      

   .. py:attribute:: subject_id
      :type: str
      :value: ''

      


.. py:class:: PercentileArea


   .. py:method:: _multipolygon(shapes, percentile)
      :staticmethod:


   .. py:method:: calculate_percentile_area(profile)
      :classmethod:

      :param profile: dataclass object with information for percentile-area calculation
      :type profile: PercentileAreaProfile

      :rtype: GeodataFrame



.. py:function:: get_percentile_area(percentile_levels, raster_path, subject_id = '')

   :param percentile_levels: list of k-th percentile scores.
   :type percentile_levels: Typing.List[Int]
   :param raster_path: file path to where the raster is stored.
   :type raster_path: str or os.PathLike
   :param subject_id: unique identifier for the subject
   :type subject_id: str

   :rtype: GeoDataFrame