MatthewsCorrelationOnDataset#

class rojak.turbulence.analysis.MatthewsCorrelationOnDataset(is_dataset, with_vars, /)[source]#

Computes the Matthew’s Correlation Coefficient between every pair of boolean DataArrays within a Dataset

See rojak.turbulence.metrics.matthews_corr_coeff().

Parameters:
__init__(is_dataset, with_vars, /)[source]#

Class computes the Matthew’s Correlation Coefficient between DataArrays within a Dataset. Thus, it requires the data to be booleans

Parameters:
  • is_dataset (Dataset) – Dataset containing boolean data

  • with_vars (str) – Name of variables in the dataset, e.g. diagnostic

Return type:

None

Methods

__init__(is_dataset, with_vars, /)

Class computes the Matthew's Correlation Coefficient between DataArrays within a Dataset.

execute()

Compute the Matthew's Correlation Coefficient between every pair of DataArrays in self._is_dataset