DispEn: Dispersion Entropy

Description Usage Arguments Value References Examples

View source: R/DispEn.R

Description

This function calculates dispersion entropy of a univariate signal x, using different mapping approaches (MA)

Usage

1
DispEn(x, ma = "NCDF", m = 3, nc = 6, tau = 1, mu, sigma)

Arguments

x

a univariate signal (vector)

ma

the mapping approach, possible values are:

  • LM: linear mapping

  • NCDF: normal cumulative distribution function (default)

  • LOGSIG: logarithm sigmoid

  • TANSIG: tangent sigmoid

  • SORT: sorting method

m

the embedding dimension

nc

the number of classes (it is usually equal to a number between 3 and 9, we use 6 by default)

tau

the time lag (it is usually equal to 1)

mu

an optional defined mean (the observed mean by default)

sigma

an option defined std-deviation (the observed std-deviation by default)

Value

a named list:

References

  1. Azami H, Entropy JE, (2018) "Amplitude-and Fluctuation-Based Dispersion Entropy". Entropy 20:210.

  2. Rostaghi M, Letters HAISP, (2016) "Dispersion entropy: A measure for time-series analysis". IEEE Signal Processing Letters. vol. 23, n. 5, pp. 610-614, 2016.

Examples

1
2

jcaude/MSEntropy documentation built on May 21, 2021, 7:31 p.m.