pandora2d.statistics
====================

.. py:module:: pandora2d.statistics

.. autoapi-nested-parse::

   Functions to compute statistics on results.



Classes
-------

.. autoapisummary::

   pandora2d.statistics.Quantiles
   pandora2d.statistics.Statistics


Functions
---------

.. autoapisummary::

   pandora2d.statistics.compute_statistics


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

.. py:class:: Quantiles

   Quantiles.


   .. py:attribute:: p10
      :type:  float | numpy.floating


   .. py:attribute:: p25
      :type:  float | numpy.floating


   .. py:attribute:: p50
      :type:  float | numpy.floating


   .. py:attribute:: p75
      :type:  float | numpy.floating


   .. py:attribute:: p90
      :type:  float | numpy.floating


.. py:class:: Statistics

   Group various statistics.


   .. py:attribute:: mean
      :type:  float | numpy.floating


   .. py:attribute:: std
      :type:  float | numpy.floating


   .. py:attribute:: quantiles
      :type:  Quantiles


   .. py:attribute:: minimal_valid_pixel_ratio
      :type:  float | numpy.floating
      :value: 1.0



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


   .. py:method:: to_dict() -> dict

      Convert statistics into a dictionary.



.. py:function:: compute_statistics(data: numpy.ndarray, invalid_values: numpy.floating | numpy.integer = None) -> Statistics

   Compute statistics of a dataArray.

   :param data: data to compute statistics from.
   :param invalid_values: value to exclude from computation
   :return: computed statistics