geoprob_pipe.utils.statistics
=============================

.. py:module:: geoprob_pipe.utils.statistics


Functions
---------

.. autoapisummary::

   geoprob_pipe.utils.statistics.calc_kar_waarde_lognormal
   geoprob_pipe.utils.statistics.calc_kar_waarde_normal
   geoprob_pipe.utils.statistics.convert_failure_probability_to_beta


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

.. py:function:: calc_kar_waarde_lognormal(mean, percentiel, sd = None, vc = None, shift = 0.0)

   Berekening van de percentiel waarde van een lognormale verdeling met standaarddeviatie/variatie coëfficient
   en verschuiving.

   # TODO: Bron naar documentatie van deze methodiek.

   :param mean: verwachtingswaarde van de lognormale verdeling
   :type mean: float
   :param sd: standaarddeviatie van de lognormale verdeling, verplicht indien vc niet gegeven
   :type sd: float
   :param vc: variatie coëfficient van de lognormale verdeling, verplicht indien sd niet gegeven
   :type vc: float
   :param percentiel: percentiel waarvoor de waarde van de lognormale verdeling wordt berekend. Waarde tussen 0.0 en 1.0.
   :type percentiel: float
   :param shift: verschuiving. Defaults to 0.0.
   :type shift: float, optional

   :returns: percentiel waarde van de lognormale verdeling
   :rtype: float


.. py:function:: calc_kar_waarde_normal(mean, std, percentiel)

   Berekening van de percentiel waarde van een normale verdeling

   :param mean: verwachtingswaarde van de normale verdeling
   :type mean: float
   :param std: standaarddeviatie van de normale verdeling
   :type std: float
   :param percentiel: percentiel waarvoor de waarde van de normale verdeling wordt berekend
   :type percentiel: float

   :returns: percentiel waarde van de normale verdeling
   :rtype: float


.. py:function:: convert_failure_probability_to_beta(failure_probability)

   Converts failure probability (Pf) to the reliability index (β).

   The reliability index is the negative inverse of the standard normal
   cumulative distribution function (Φ) applied to the failure probability.

   β = -1 * Φ⁻¹(Pf)

   :param failure_probability: failure probability (Pf)
   :type failure_probability: float

   :returns: reliability index (β)
   :rtype: float