climpred.comparisons.Comparison.__init__#
- Comparison.__init__(name: str, function: Callable[[Any, Any, Any], Tuple[Dataset, Dataset]], hindcast: bool, probabilistic: bool, long_name: str | None = None, aliases: List[str] | None = None) None [source]#
Comparison initialization See Comparisons.
- Parameters:
name – name of comparison.
function – comparison function.
hindcast – Can comparison be used in
HindcastEnsemble
?False
means onlyPerfectModelEnsemble
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.