jaccard_index_multidim#

rojak.turbulence.metrics.jaccard_index_multidim(first_var: DataArray, second_var: DataArray, sum_over: str | list[str] | None) → DataArray[source]#

Jaccard Index or Critical Success Index for multidimensional data

From Wikipedia Jaccard Index is defined as,

\[J(A, B) = \frac{|A \cap B|}{|A \cup B|}\]
Parameters:

  • first_var (DataArray) – First binary variable

  • second_var (DataArray) – Second binary variable

  • sum_over (str | list[str] | None) – Dimension to sum over to compute the number of observations

Returns:

Array containing Jaccard Index or Critical Success Index

Return type:

DataArray