climpred.metrics.Metric

class climpred.metrics.Metric(name, function, positive, probabilistic, unit_power, long_name=None, aliases=None, minimum=None, maximum=None, perfect=None)

Master class for all metrics.

__init__(name, function, positive, probabilistic, unit_power, long_name=None, aliases=None, minimum=None, maximum=None, perfect=None)

Metric initialization.

Parameters:

• name (str) – name of metric.
• function (function) – metric function.
• positive (bool) – Is metric positively oriented? Higher metric values means higher skill.
• probabilistic (bool) – Is metric probabilistic? False means deterministic.
• unit_power (float, int) – Power of the unit of skill based on unit of input, e.g. input unit [m]: skill unit [(m)**unit_power]
• long_name (str, optional) – long_name of metric. Defaults to None.
• aliases (list of str, optional) – Allowed aliases for this metric. Defaults to None.
• min (float, optional) – Minimum skill for metric. Defaults to None.
• max (float, optional) – Maxmimum skill for metric. Defaults to None.
• perfect (float, optional) – Perfect skill for metric. Defaults to None.

Returns:

metric class Metric.

Return type:

Metric

Methods

__init__(name, function, positive, …[, …])

Metric initialization.