Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
dim (list of str or str): corrected dimension to apply metric to.
"""
# check kind allowed
is_in_list(kind, ['hindcast', 'PM'], 'kind')
# set default dim
if dim is None:
dim = 'init' if kind == 'hindcast' else ['init', 'member']
# check allowed dims
if kind == 'hindcast':
is_in_list(dim, ['member', 'init'], 'dim')
elif kind == 'PM':
is_in_list(dim, ['member', 'init', ['init', 'member']], 'dim')
# get metric and comparison strings incorporating alias
metric = METRIC_ALIASES.get(metric, metric)
comparison = COMPARISON_ALIASES.get(comparison, comparison)
METRICS = HINDCAST_METRICS if kind == 'hindcast' else PM_METRICS
COMPARISONS = HINDCAST_COMPARISONS if kind == 'hindcast' else PM_COMPARISONS
metric = get_metric_class(metric, METRICS)
comparison = get_comparison_class(comparison, COMPARISONS)
# check whether combination of metric and comparison works
PROBABILISTIC_COMPARISONS = (
PROBABILISTIC_HINDCAST_COMPARISONS
if kind == 'hindcast'
else PROBABILISTIC_PM_COMPARISONS
)
if metric.probabilistic:
if not comparison.probabilistic:
raise ValueError(
f'Probabilistic metric `{metric.name}` requires comparison '
add_attrs (bool): write climpred compute args to attrs. default: True
** metric_kwargs (dict): additional keywords to be passed to metric
Returns:
u (xarray object): Results from comparison at the first lag.
"""
# Check that init is int, cftime, or datetime; convert ints or cftime to datetime.
hind = convert_time_index(hind, 'init', 'hind[init]')
uninit = convert_time_index(uninit, 'time', 'uninit[time]')
verif = convert_time_index(verif, 'time', 'verif[time]')
has_valid_lead_units(hind)
# get metric/comparison function name, not the alias
metric = METRIC_ALIASES.get(metric, metric)
comparison = COMPARISON_ALIASES.get(comparison, comparison)
comparison = get_comparison_class(comparison, HINDCAST_COMPARISONS)
metric = get_metric_class(metric, DETERMINISTIC_HINDCAST_METRICS)
forecast, verif = comparison.function(uninit, verif, metric=metric)
hind = hind.rename({'init': 'time'})
_, verif_dates = return_inits_and_verif_dates(hind, verif, alignment=alignment)
plag = []
# TODO: Refactor this, getting rid of `compute_uninitialized` completely.
# `same_verifs` does not need to go through the loop, since it's a fixed
# skill over all leads.
for i in hind['lead'].values:
# Ensure that the uninitialized reference has all of the
# dates for alignment.
* e2o: Compare the ensemble mean to the verification data.
* m2o: Compare each ensemble member to the verification data.
Args:
comparison (str): name of comparison.
Returns:
comparison (Comparison): comparison class.
"""
if isinstance(comparison, comparisons.Comparison):
return comparison
elif isinstance(comparison, str):
# check if comparison allowed
is_in_list(comparison, list_, 'comparison')
comparison = COMPARISON_ALIASES.get(comparison, comparison)
return getattr(comparisons, '__' + comparison)
else:
is_in_list(comparison, list_, 'comparison')
return getattr(comparisons, '__' + comparison)