climpred.comparisons.Comparison

class climpred.comparisons.Comparison(name, function, hindcast, probabilistic, long_name=None)

Master class for all comparisons.

__init__(name, function, hindcast, probabilistic, long_name=None)

Comparison initialization.

Parameters:

• name (str) – name of comparison.
• function (function) – comparison function.
• hindcast (bool) – Can comparison be used in compute_hindcast? False means compute_perfect_model
• probabilistic (bool) – Can this comparison be used for probabilistic metrics also? Probabilistic metrics require multiple forecasts. False means that comparison is only deterministic. True means that comparison can be used both deterministic and probabilistic.
• long_name (str, optional) – longname of comparison. Defaults to None.

Returns:

comparison class Comparison.

Return type:

comparison

Methods

__init__(name, function, hindcast, probabilistic)

Comparison initialization.