climpred.prediction.compute_uninitialized¶
-
climpred.prediction.
compute_uninitialized
(uninit, reference, metric='pearson_r', comparison='e2r', dim='time', add_attrs=True, **metric_kwargs)[source]¶ Compute a predictability score between an uninitialized ensemble and a reference.
Note
Based on Decadal Prediction protocol, this should only be computed for the first lag and then projected out to any further lags being analyzed.
Parameters: - uninit (xarray object) – uninitialized ensemble.
- reference (xarray object) – reference output/data over same time period.
- metric (str) – Metric used in comparing the uninitialized ensemble with the reference.
- comparison (str) –
- How to compare the uninitialized ensemble to the reference:
- e2r : ensemble mean to reference (Default)
- m2r : each member to the reference
- add_attrs (bool) – write climpred compute args to attrs. default: True
- metric_kwargs (**) – additional keywords to be passed to metric
Returns: Results from comparison at the first lag.
Return type: u (xarray object)