.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/ex_descriptive_statistics.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_ex_descriptive_statistics.py>`
        to download the full example code. or to run this example in your browser via Binder

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_ex_descriptive_statistics.py:


**********************
Descriptive Statistics
**********************

Numpy offers many statistical functions, but if you want to obtain several
statistical variables from the same array, it's necessary to process the data
several times to calculate the various parameters. This example shows how to use
the DescriptiveStatistics class to obtain several statistical variables with a
single calculation. Also, the calculation algorithm is incremental and is more
numerically stable.

.. note::

    Pébay, P., Terriberry, T.B., Kolla, H. et al.
    Numerically stable, scalable formulas for parallel and online
    computation of higher-order multivariate central moments
    with arbitrary weights.
    Comput Stat 31, 1305-1325,
    2016,
    https://doi.org/10.1007/s00180-015-0637-z

.. GENERATED FROM PYTHON SOURCE LINES 24-29

.. code-block:: Python

    import dask.array
    import numpy

    import pyinterp








.. GENERATED FROM PYTHON SOURCE LINES 30-31

Create a random array

.. GENERATED FROM PYTHON SOURCE LINES 31-34

.. code-block:: Python

    generator = numpy.random.Generator(numpy.random.PCG64(0))
    values = generator.random((2, 4, 6, 8))








.. GENERATED FROM PYTHON SOURCE LINES 35-36

Create a DescriptiveStatistics object.

.. GENERATED FROM PYTHON SOURCE LINES 36-38

.. code-block:: Python

    ds = pyinterp.DescriptiveStatistics(values)








.. GENERATED FROM PYTHON SOURCE LINES 39-53

The constructor will calculate the statistical variables on the provided data.
The calculated variables are stored in the instance and can be accessed using
different methods:

* mean
* var
* std
* skewness
* kurtosis
* min
* max
* sum
* sum_of_weights
* count

.. GENERATED FROM PYTHON SOURCE LINES 53-55

.. code-block:: Python

    ds.count()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([384], dtype=uint64)



.. GENERATED FROM PYTHON SOURCE LINES 56-58

.. code-block:: Python

    ds.mean()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([0.52703051])



.. GENERATED FROM PYTHON SOURCE LINES 59-61

It's possible to get a structured numpy array containing the different
statistical variables calculated.

.. GENERATED FROM PYTHON SOURCE LINES 61-63

.. code-block:: Python

    ds.array()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([(384, -1.20728744, 0.99720994, 0.52703051, 0.00030069, -0.12457213, 384., 202.37971539, 0.08762152)],
          dtype=[('count', '<u8'), ('kurtosis', '<f8'), ('max', '<f8'), ('mean', '<f8'), ('min', '<f8'), ('skewness', '<f8'), ('sum_of_weights', '<f8'), ('sum', '<f8'), ('var', '<f8')])



.. GENERATED FROM PYTHON SOURCE LINES 64-65

Like numpy, it's possible to compute statistics along axis.

.. GENERATED FROM PYTHON SOURCE LINES 65-68

.. code-block:: Python

    ds = pyinterp.DescriptiveStatistics(values, axis=(1, 2))
    ds.mean()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([[0.46094551, 0.58985662, 0.56335527, 0.59960438, 0.53755935,
            0.46486889, 0.59151122, 0.50117507],
           [0.5223734 , 0.50646854, 0.56639677, 0.43645944, 0.53861813,
            0.48949667, 0.52384772, 0.53995116]])



.. GENERATED FROM PYTHON SOURCE LINES 69-71

The class can also process a dask array. In this case, the call to the
constructor triggers the calculation.

.. GENERATED FROM PYTHON SOURCE LINES 71-76

.. code-block:: Python

    ds = pyinterp.DescriptiveStatistics(dask.array.from_array(values,
                                                              chunks=(2, 2, 2, 2)),
                                        axis=(1, 2))
    ds.mean()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([[0.46094551, 0.58985662, 0.56335527, 0.59960438, 0.53755935,
            0.46486889, 0.59151122, 0.50117507],
           [0.5223734 , 0.50646854, 0.56639677, 0.43645944, 0.53861813,
            0.48949667, 0.52384772, 0.53995116]])



.. GENERATED FROM PYTHON SOURCE LINES 77-78

Finally, it's possible to calculate weighted statistics.

.. GENERATED FROM PYTHON SOURCE LINES 78-81

.. code-block:: Python

    weights = generator.random((2, 4, 6, 8))
    ds = pyinterp.DescriptiveStatistics(values, weights=weights, axis=(1, 2))
    ds.mean()




.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([[0.44437477, 0.59020081, 0.52588079, 0.62338788, 0.52285862,
            0.44453644, 0.63767415, 0.4967181 ],
           [0.51336212, 0.46654736, 0.6201174 , 0.45925923, 0.53653586,
            0.4910487 , 0.5093799 , 0.55740906]])




.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.074 seconds)


.. _sphx_glr_download_auto_examples_ex_descriptive_statistics.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: binder-badge

      .. image:: images/binder_badge_logo.svg
        :target: https://mybinder.org/v2/gh/CNES/pangeo-pyinterp/master?urlpath=lab/tree/notebooks/auto_examples/ex_descriptive_statistics.ipynb
        :alt: Launch binder
        :width: 150 px

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: ex_descriptive_statistics.ipynb <ex_descriptive_statistics.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: ex_descriptive_statistics.py <ex_descriptive_statistics.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: ex_descriptive_statistics.zip <ex_descriptive_statistics.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_