skdh.features.PermutationEntropy#

class skdh.features.PermutationEntropy(order=3, delay=1, normalize=False)#

A meausure of the signal complexity. Based on how the temporal signal behaves according to a series of ordinal patterns.

Parameters:
orderint, optional

Order (length of sub-signals) to use in the computation. Default is 3

delayint, optional

Time-delay to use in computing the sub-signals. Default is 1 sample.

normalizebool, optional

Normalize the output between 0 and 1. Default is False.

Attributes:
delay
normalize
order

Methods

compute(signal, *[, axis])

Compute the permutation entropy

compute(signal, *, axis=-1)#

Compute the permutation entropy

Parameters:
signalarray-like

Array-like containing values to compute the signal entropy for.

axisint, optional

Axis along which the signal entropy will be computed. Ignored if signal is a pandas.DataFrame. Default is last (-1).

Returns:
perm_ennumpy.ndarray

Computed permutation entropy.