diagnostic.diagnostic.Ensemble2Self#

class Ensemble2Self(diagnostic_function, plotting_function, name=None, description=None, iterative_plotting=False)[source]#

A class representing a diagnostic that compares an ensemble to itself.

__init__(diagnostic_function, plotting_function, name=None, description=None, iterative_plotting=False)[source]#: Initialize the Ensemble2Self diagnostic.

Methods

`__init__`(diagnostic_function, plotting_function)	Initialize the Ensemble2Self diagnostic.
`apply`(dt[, mask])	Apply the diagnostic to the data.
`plot`(result[, variables, title, facetted])	Plot the diagnostic.

Attributes

Generate the docstring for the diagnostic.

apply(dt: DataTree, mask=None, **kwargs)[source]#

Apply the diagnostic to the data.

Parameters:: dt (DataTree) – The data to apply the diagnostic to.
Returns:: The data after applying the diagnostic as a DataTree or a dictionary of results with the tree nodes as keys.
Return type:: DataTree or dict

plot(result, variables=None, title=None, facetted=None, **kwargs)[source]#

Plot the diagnostic.

If facetted multiple plots on different axes are created. If not facetted, the plots are created on the same axis.

Parameters:: result (DataTree) – The result of applying the ensemble diagnostic to a DataTree.
Returns:: The figure representing the diagnostic.
Return type:: Figure