OpenTSTOOL User Manual
Version 1.2 (2/2009)
Christian Merkwirth
Ulrich Parlitz
Immo Wedekind
David Engster
Werner Lauterborn
Drittes Physikalisches Institut
Universit¨at G¨ottingen
Contact: tstool@physik3.gwdg.de
2
Contents
1 At a gl ance 7
2 Download and Installati on 9
2.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.1.1 Installation methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.1.2 Global installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.1.3 Deinstalling TSTOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.2 First Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.3 Compiling mex files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.3.1 Problems with compiling mex files . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.4 Pitfalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.5 Copyright notice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3 First Steps 15
3.1 Example analysis of a time-series from a chaotic Colpitts oscillator . . . . . . . . . . . 15
4 Nearest Neighbors Searching 19
4.1 Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.2 Approximate nearest neighbors searching . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.3 Range searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.4 Matlab mex-functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.4.1 nn prepare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.4.2 nn search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.4.3 range search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.5 Example session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
5 Handling the Graphical User Interface 25
5.1 Filelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.2 Figure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
5.3 Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
5.3.1 Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3
5.3.2 Methods I . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.3.3 Methods II . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.3.4 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5.3.5 Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
5.3.6 Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
5.3.7 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
5.3.8 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
5.3.9 View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6 Mex-Function Reference 33
6.1 akimaspline - Cubic spline interpolation using Akima splines . . . . . . . . . . . . . . 33
6.2 amutual - compute auto mutual information function . . . . . . . . . . . . . . . . . . 34
6.3 baker - Generate Baker time-series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.4 boxcount - Classical boxcounting algorithm . . . . . . . . . . . . . . . . . . . . . . . . 35
6.5 cao - Determine minimum embedding dimension by Cao’s method . . . . . . . . . . . 35
6.6 chaosys - integrate dynamical system given by a set of ordinary differential equations 36
6.7 corrsum - Computation of the correlation sum . . . . . . . . . . . . . . . . . . . . . . 38
6.8 corrsum2 - Computation of the correlation sum . . . . . . . . . . . . . . . . . . . . . . 39
6.9 fnearneigh - Fast nearest neighbor search . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.10 gendimest - Estimate generalized dimension spe ctrum . . . . . . . . . . . . . . . . . . 41
6.11 henon - Generate henon time-series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.12 largelyap - Compute separation of nearby trajectories . . . . . . . . . . . . . . . . . 42
6.13 nn prepare - Do nearest neighbor preprocessing . . . . . . . . . . . . . . . . . . . . . 43
6.14 nn search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.15 predict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.16 range search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.17 return time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.18 takens estimator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.19 tentmap - Generate tentmap time-series . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.20 Class signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.20.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.20.2 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.20.3 Member functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.21 Class description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
6.21.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
6.21.2 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
6.21.3 Member functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
6.22 Class core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
4
6.22.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
6.22.2 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
6.22.3 Member functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
6.23 Class achse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
6.23.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
6.23.2 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
6.23.3 Member functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
6.24 Class unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
6.24.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
6.24.2 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
6.24.3 Member functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
6.25 Class list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
6.25.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
6.25.2 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
6.25.3 Member functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
7 Frequently asked questions 93
7.1 Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.2 Answers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
7.2.1 Introduction and general information . . . . . . . . . . . . . . . . . . . . . . . . 94
7.2.2 Installation of TSTOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
7.2.3 Working with TSTOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
7.2.4 Extending TSTOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.2.5 Miscellaneous questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.2.6 Frequently encountered errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
5
