CorrelationDimension

class eyefeatures.features.measures.CorrelationDimension(m=2, tau=1, r=0.5, x=None, y=None, aoi=None, pk=None, return_df=True, ignore_errors=False)[source]

Bases: MeasureTransformer

Correlation Dimension.

A measure of the dimensionality of the space occupied by a set of random points (the attractor of the dynamical system). It is related to the fractal dimension but calculated based on the correlation sum (fraction of pairs of points closer than distance r). It provides a lower bound for the fractal dimension.

Parameters:

  • m (int) – embedding dimension.

  • tau (int) – time delay for phase space reconstruction.

  • r (float) – radius threshold for correlation sum.

  • x (str) – X coordinate column name.

  • y (str) – Y coordinate column name.

  • aoi (str) – Area Of Interest column name(-s).

  • pk (list[str]) – primary key.

  • return_df (bool) – whether to return output as DataFrame or numpy array.

  • ignore_errors (bool) – If True, return NaN when feature computation fails; otherwise raise.