MatthewsCorrelationOnDataset#

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

Bases: PostProcessor[DataArray]

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

__init__(is_dataset: Dataset, with_vars: str, /) → None[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()