climpred.comparisons.Comparison#

class climpred.comparisons.Comparison(name: str, function: Callable[[Any, Any, Any], Tuple[Dataset, Dataset]], hindcast: bool, probabilistic: bool, long_name: Union[None, str] = None, aliases: Optional[List[str]] = None)[source]#

Master class for all comparisons. See Comparisons.

__init__(name: str, function: Callable[[Any, Any, Any], Tuple[Dataset, Dataset]], hindcast: bool, probabilistic: bool, long_name: Union[None, str] = None, aliases: Optional[List[str]] = None) None[source]#

Comparison initialization See Comparisons.

Parameters:
  • name – name of comparison.

  • function – comparison function.

  • hindcast – Can comparison be used in HindcastEnsemble? False means only PerfectModelEnsemble

  • probabilistic – 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 – longname of comparison.

  • aliases – Allowed aliases for this comparison.

Methods

__init__(name, function, hindcast, probabilistic)

Comparison initialization See Comparisons.