earthkit.meteo.stats.array.GumbelDistribution¶

class earthkit.meteo.stats.array.GumbelDistribution(mu, sigma, dims=None, coords=None)¶

Gumbel distribution for extreme value statistics.

Warning

Experimental API. This class may change or be removed without notice.

Parameters:

mu (array_like) – Offset parameter.
sigma (array_like) – Scale parameter.
dims (tuple[str], optional) – Ordered sequence of dimension labels. To be used by metadata-aware functions working with the distribution.
coords (dict[str,Any], optional) – Coordinates corresponding to the labelled dimensions provided in dims. To be used by metadata-aware functions working with the distribution.

cdf(x)¶

Evaluate the cumulative distribution function (CDF).

Parameters:: x (array_like) – Input value.
Returns:: The probability that a random variable X from the distribution is less than or equal to the input x.
Return type:: array_like

property dims: None | tuple[str]¶

property ndim: int¶

Number of dimensions.

ppf(p)¶

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

Parameters:: p (array_like) – Probability in interval [0, 1].
Returns:: x such that the probability of a random variable from the distribution taking a value less than or equal to x is p.
Return type:: array_like

property shape: tuple[int]¶

Tuple of dimensions.