earthkit.meteo.stats.array.GumbelDistribution
=============================================

.. py:class:: earthkit.meteo.stats.array.GumbelDistribution(mu, sigma, freq=None)

   Gumbel distribution for extreme value statistics.

   :param mu: Offset parameter.
   :type mu: :class:`Number | array_like`
   :param sigma: Scale parameter.
   :type sigma: :class:`Number | array_like`
   :param freq: Temporal frequency (duration between values, technically the inverse
                frequency) of the represented data. Provides additional context, e.g.,
                to scale return periods computed from the distribution.
   :type freq: :class:`None | Number | timedelta`


   .. py:method:: cdf(x)

      Evaluate the cumulative distribution function (CDF).

      :param x: Input value.
      :type x: :class:`Number | array_like`

      :returns: The probability that a random variable X from the distribution is
                less than or equal to the input x.
      :rtype: :class:`Number | array_like`



   .. py:method:: fit(sample, axis=0, freq=None)
      :classmethod:


      Gumbel distribution with parameters fitted to a sample of values.

      Results derived from the fitted distribution will only be meaningful
      if it is representative of the sample statistics.

      :param sample: Sample values.
      :type sample: :class:`numpy.ndarray`
      :param axis: The axis along which to compute the parameters.
      :type axis: :class:`int`
      :param freq: Temporal frequency (duration between values) of the sample.
      :type freq: :class:`None | Number | timedelta`



   .. py:attribute:: freq
      :value: None



   .. py:property:: ndim

      Number of dimensions.


   .. py:method:: ppf(p)

      Evaluate the percent point function (PPF; inverse CDF).

      :param p: Probability in interval [0, 1].
      :type p: :class:`Number | array_like`

      :returns: x such that the probability of a random variable from the
                distribution taking a value less than or equal to x is p.
      :rtype: :class:`Number | array_like`



   .. py:property:: shape

      Tuple of dimensions.