SampleOddsRatio

class rojak.turbulence.analysis.SampleOddsRatio(this_feature, other_feature, sum_over_dims='time', use_log=True)

Sample odds ratio (see rojak.turbulence.metrics.sample_odds_ratio()) between two boolean features

Parameters:

• this_feature (DataArray)

• other_feature (DataArray)

• sum_over_dims (str | list[str] | None)

• use_log (bool)

__init__(this_feature, other_feature, sum_over_dims='time', use_log=True)

Parameters:

• this_feature (DataArray) – First binary variable

• other_feature (DataArray) – Second binary variable

• sum_over_dims (str | list[str] | None) – Dimension(s) to sum over when computing the contingency table. Defaults to "time".

• use_log (bool) – If True (default), computes the natural logarithm of the odds ratio.

Return type:

None

Methods

__init__(this_feature, other_feature[, ...])
execute()	Compute the (log) sample odds ratio between self._this_feature and self._other_feature