pyhctsa.operations.entropy.rpde

pyhctsa.operations.entropy.rpde(y, m=2, tau=1, epsilon=0.12, t_max=-1)

Recurrence period density entropy (RPDE).

Fast RPDE analysis on an input signal to obtain an estimate of the normalized entropy (H_norm) and other related statistics. Based on Max Little’s original rpde code [1].

References

Parameters:
y : array-like

Input signal (must be a 1D array or list).

m : int, optional

Embedding dimension. Default is 2.

tau : int or str, optional

Embedding time delay. Default is 1.

epsilon : float, optional

Recurrence neighbourhood radius. Default is 0.12.

t_max : int, optional

Maximum recurrence time. If not specified, all recurrence times are returned. Default is -1.

Returns:

Dictionary containing:

  • ’H_norm’: Estimated normalized RPDE value.

  • ’H’: Unnormalized entropy.

  • ’rpd’: Recurrence period density (probability distribution).

  • ’propNonZero’: Proportion of non-zero entries in rpd.

  • ’meanNonZero’: Mean value of non-zero rpd entries (rescaled by N).

  • ’maxRPD’: Maximum value of rpd (rescaled by N).

Return type:

dict