Changes

Jump to navigation Jump to search

User:Josiah425:TISEAN Package:Table of functions

6,349 bytes added, 07:30, 11 August 2015
added legend
== Table of functions ==In reference to the TISEAN library alphabetical order of programs which is located [http://www.mpipks-dresden.mpg.de/~tisean/Tisean_3.0.1/docs/alphabetical.html| here].
The choice whether a program exist in Octave is based only on comparing package/octave documentation with the TISEAN documentation. As of now I have not compared any code, nor checked if any sample data gives the same results from both functions (the octave ones and the TISEAN ones).
 
The legend to understand the table is as follows:
{| class="wikitable"
|-style="background: LightGreen"
|Green means the function is ported, tested or is not needed
|-style="background: LightSalmon"
|Red means the function was thought to have been similar but isn't
|-style="background: Yellow"
|Yellow means that the correlation between the TISEAN and Octave function needs to be verified
|-
! Program Name !! Program Description !! Corresponding Octave Function !! Comments|-| arima-model || Fit and possibly iterate an ARIMA model || There is 'aar' in TSA but cannot determine if No color means that nothing about this is different or not || This is a c-file that can be wrapped in C++/mfile/octfile code|-|ar-model || Fit and possibly iterate an Autoregessive model || Same as above || C; see also: aarmam, adim, amarma, mvaar from TSA|-|ar-run || Iterate an Autoregessive model || Same as above || FORTRAN|-|av-d2 || Simply smooth output of d2 || Same as above || C|-|boxcount || Renyi Entopies of Qth order || There most likely is none || C|-|c1 || Fixed mass estimation of D1 || Most likely is none || FORTRAN|-|c2d || Get local slopes from correlation integral || Most likely none || FORTRAN|-|c2g || Gaussian kernel of C2 || |||-|c2t || Takens estimator of D2 || Most likely 'rmle' from tsa || FORTRAN|-|choose || Choose rows and/or columns from a data file || Does not need to be ported || ------|-|compare || Compares two data sets || If 'rms' exists in Octave no need for port || FORTRAN|-|corr, autocorr || Autocorrelation function || There is 'acorf' in tsa but i don't know if is the same || corr -C, autocorr (faster according to documentation) - FORTRAN|-|d2 || Correlation dimension d2 || I believe not, don't know || c|-|delay || Creates delay embedding || Most likely does not exist || C|-|endtoend || Determine end-to-end mismatch || |||-|events || Interval/event conversion || |||-|extrema || Determine the extrema of a time series || |||-|false_nearest || The false nearest neighbor algorithm || Does not exist || C|-|ghkss || Nonlinear noise reduction || There is not || C|-|henon || Create a Hénon time series || There is not || To m-file; already ported|-|histogram || Creates histograms || |||-|ikeda || Create an Ikeda time series || |||-|intervals || Event/intervcal conversion || |||-|lazy || Simple nonlinear noise reduction || There is not || FORTRAN|-|lfo-ar || Locally first order model vs. global AR model (old ll-ar) || ||has been determined|-}|lfo-run || Iterate a locally first order model (old nstep) || |||-{|lfo-test || Test a locally first order model (old onestep) || |||-|lorenz || Create a Lorenz time series || |||-|low121 || Time domain low pass filter || |||-|lyap_k || Maximal Lyapunov exponent with the Kantz algorithm || |||-|lyap_r || Maximal Lyapunov exponent with the Rosenstein algorithm || |||-|lyap_spec || Full spectrum of Lyapunov exponents || |||-|lzo-gm || Locally zeroth order model vs. global mean || |||-|lzo-run || Iterate a locally zeroth order model || |||-|lzo-test || Test a locally zeroth order model (old zeroth) || |||-|makenoise || Produce noise || |||-|mem_spec || Power spectrum using the maximum entropy principle || |||-|mutual || Estimate the mutual information || Does not exist || C|-|notch || Notch filter || |||-|nstat_z || Nonstationarity testing via cross-prediction || |||-|pca, pc || Principle component analysis || 'pcacov' if likely the equivalent || pca - C, pc - FORTRAN|-|poincare || Create Poincaré sections || |||-|polyback || Fit a polynomial model (backward elimination) || |||-|polynom || Fit a polynomial model || |||-|polynomp || Fit a polynomial model (reads terms to fit from file) || |||-|polypar || Creates parameter file for polynomp || |||-|predict || Forecast discriminating statistics for surrogates || Does not exist || FORTRANclass="wikitable"
|-
|randomize || General constraint randomization (surrogates) || ||! Program Name !! Program Description !! Corresponding Octave Function !! Lanuguage of Origin !! How to port !! Status
|-
|randomize_spikeauto_exp_random arima-model || Surrogate data preserving event time autocorrelations Fit and possibly iterate an ARIMA model || generalizes TSA arma functions || C || wrapped in C++/mfile/octfile code ||
|-
|randomize_spikespec_exp_event ar-model || Surrogate data preserving event time power spectrum Fit and possibly iterate an Autoregessive model || 'aar' in TSA; see also: aarmam, adim, amarma, mvaar from TSA || C || wrapped in C++/mfile/octfile code ||
|-
|rbf ar-run || Radial basis functions fit Iterate an Autoregessive model || Same as above || FORTRAN || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|av-d2 || Simply smooth output of d2 || Can be implemented with filter in core || C || |||-style="background: LightGreen"|boxcount || Renyi Entopies of Qth order || None in GNU Octave (maybe in info-theory but it is not worth the pain) || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|c1 || Fixed mass estimation of D1 || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|c2d || Get local slopes from correlation integral || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|c2g || Gaussian kernel of C2 || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|c2t || Takens estimator of D2 || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|choose || Choose rows and/or columns from a data file || Does not need to be ported || FORTRAN || ----- || Not Needed|-style="background: LightGreen"|compare || Compares two data sets || Does not need to be ported || FORTRAN || ------ || Not Needed|-style="background: LightGreen"|corr, autocorr || Autocorrelation function || xcorr in signal || corr -C, autocorr (faster according to documentation) - FORTRAN || ------- || Different usage, same result|-style="background: LightGreen"|d2 || Correlation dimension d2 || None in GNU Octave || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|delay || Creates delay embedding || None in GNU Octave (easy to implement in Octave but not worth the effort) || C || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|endtoend || Determine end-to-end mismatch || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code || Ported&Tested
|-
|recurr events || Interval/event conversion || None in GNU Octave || FORTRAN || To be reimplemented as m-file |||-style="background: LightSalmon"|extrema || Determine the extrema of a time series || findpeaks in signal is *not* the same || C || |||-style="background: LightGreen"|false_nearest || The false nearest neighbor algorithm || None in GNU Octave || C || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|ghkss || Nonlinear noise reduction || None in GNU Octave || C || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|henon || Create a Hénon time series || None in GNU Octave || FORTRAN || To be reimplemented as m-file || Ported&Checked|-style="background: LightGreen"|histogram || Creates a recurrence plot histograms || hist in core || C || ||Different usage, same result|-style="background: LightGreen"|ikeda || Create an Ikeda time series || None in GNU Octave || FORTRAN || To be reimplemented as mfile || Ported&Tested
|-
|resample intervals || Resamples data Event/intervcal conversion || There is 'resample' Might exist under different name || FORTRAN || To be reimplemented as mfile |||-style="background: LightGreen"|lazy || Simple nonlinear noise reduction || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|lfo-ar || Locally first order model vs. global AR model (old ll-ar) || None in GNU Octave || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|lfo-run || Iterate a locally first order model (old nstep) || None in GNU Octave, but I believe it does something else || C|| wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|lfo-test || Test a locally first order model (old onestep) || None in GNU Octave || C || wrapped in C++/mfile/octfile code |||-style="background: Yellow"|lorenz || Create a Lorenz time series || Can be implemented in GNU Octave using lsode or odepkg|| FORTRAN || mfile ||
|-
|rescale low121 || Rescale data set Time domain low pass filter || This should be There are lowpass filters in Octave: buttap, cannot find..cheb1ap, cheb2ap, ellipap, sftrans, but I don't think they perform this task || C || Reimplement as mfile |||-style="background: LightGreen"|lyap_k || Maximal Lyapunov exponent with the Kantz algorithm || None in GNU Octave || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|lyap_r || Maximal Lyapunov exponent with the Rosenstein algorithm || None in GNU Octave || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|lyap_spec || Full spectrum of Lyapunov exponents || None in GNU Octave || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|lzo-gm || Locally zeroth order model vs. global mean || None in GNU Octave || C || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|lzo-run || Iterate a locally zeroth order model || None in GNU Octave || C || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|lzo-test || Test a locally zeroth order model (old zeroth) || None in GNU Octave || C || wrapped in C++/mfile/octfile code || Ported&Tested
|-
|rms makenoise || Rescale data set and get mean, variance and data interval Produce noise || This should Rand exists || Should be implemented as mfile using Octave rand functions || wrapped in Octave, cannot find... C++/mfile/octfile code || FORTRNAN
|-
|sav_gol mem_spec || SavitzkyPower spectrum using the maximum entropy principle || None in GNU Octave || C || wrapped in C++/mfile/octfile code |||-Golay style="background: LightGreen"|mutual || Estimate the mutual information || None in GNU Octave || C || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: Yellow"|notch || Notch filter || pei_tseng_notch, needs to be verified || FORTRAN || wrapped in C++/mfile/octfile code ||
|-
|spectrum nstat_z || Power spectrum using FFT Nonstationarity testing via cross-prediction || None in GNU Octave || C ||wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|pca, pc || Principle component analysis || 'pcacov' if likely the equivalent; pricomp in statistics || pca - C, pc - FORTRAN || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|poincare || Create Poincaré sections || None in GNU Octave || C || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightSalmon"|polyback || Fit a polynomial model (backward elimination) || polyfit, detrend, wpolyfit are not similar || C || wrapped in C++ || Porting needed|-style="background: LightGreen"|polynom || Fit a polynomial model || same as above || C || |||-style="background: LightSalmon"|polynomp || Fit a polynomial model (reads terms to fit from file) || same as above || C || |||-style="background: LightSalmon"|polypar || Creates parameter file for polynomp || same as above || C || |||-style="background: LightGreen"|predict || Forecast discriminating statistics for surrogates || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code ||Same as lzo_test; Not Needed
|-
|spikeauto randomize || Autocorrelation General constraint randomization (surrogates) || There are random function of event times , but I don't think this one exists || FORTRAN || wrapped in C++/mfile/octfile code ||
|-
|spikespec randomize_spikeauto_exp_random || Power spectrum of Surrogate data preserving event times time autocorrelations || Same as above || FORTRAN || wrapped in C++/mfile/octfile code ||
|-
|stp randomize_spikespec_exp_event || Creates a spaceSurrogate data preserving event time power spectrum || Same as above || FORTRAN || wrapped in C++/mfile/octfile code |||-time separation plot style="background: LightGreen"|rbf || Radial basis functions fit || None in GNU Octave || C || wrapped in C++/mfile/octfile code ||
|-
|surrogates recurr || Creates surrogate data a recurrence plot || None in GNU Octave || C || wrapped in C++/mfile/octfile code ||
|-
|timerev resample || Time reversal discrimating statistics for surrogates Resamples data || There is 'resample' in Octave, but I believe it does something else || C || wrapped in C++/mfile/octfile code ||
|-
|upo rescale || Finds unstable periodic orbits Rescale data set || This should be in Octave, cannot find... || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|rms || Rescale data set and get mean, variance and estimates their stability data interval || No corresponding function This should be in Octave , cannot find... || FORTRNAN || wrapped in C++/mfile/octfile code || Not Needed|-style="background: Yellow"|sav_gol || Savitzky-Golay filter || sgolayfilt in signal || C || |||-style="background: LightGreen"|spectrum || Power spectrum using FFT || abs (fft (;)) || FORTRAN|| Rewrite as m-file || Ported&Tested
|-
|upoembed spikeauto || Takes the output Autocorrelation function of upo and create data files out of it event times || similar to above || FORTRAN || ||
|-
|wiener spikespec || Wiener filter Power spectrum of event times || ar_psd, cpsd is the closest but I do not think they are the same || FORTRAN || ||
|-
|xc2 stp || CrossCreates a space-correlation integral time separation plot || None in GNU Octave ||FORTRAN || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|surrogates || Creates surrogate data || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|timerev || Time reversal discrimating statistics for surrogates || None in GNU Octave || FORTRAN || To be reimplemented as mfile || Ported&Tested|-style="background: LightGreen"|upo || Finds unstable periodic orbits and estimates their stability || None in GNU Octave || FORTRAN || wrapped in C++/mfile/octfile code || Ported&Tested|-style="background: LightGreen"|upoembed || Takes the output of upo and create data files out of it || None in GNU Octave || FORTAN || wrapped in C++/mfile/octfile code || Ported&Tested
|-
|xcor wiener1, wiener2 || Cross-correlations Wiener filter || Wiener process exists, might be similar || FORTRAN || wrapped in C++/mfile/octfile code ||
|-
|xrecur xc2 || Cross-recurrence Plot correlation integral || xcorr2 - Needs to be verified that works the same way || FORTRAN || wrapped in C++/mfile/octfile code |||-style="background: Yellow"|xcor || Cross-correlations || xcorr - Needs to be verified that works same way || C|| wrapped in C++/mfile/octfile code ||
|-
|xrecur || Cross-recurrence Plot || xcorr, or xcorr2 or another function might cover this || C || wrapped in C++/mfile/octfile code |||-style="background: LightGreen"|xzero || Locally zeroth order cross-prediction|| None in GNU Octave || C || wrapped in C++/mfile/octfile code ||
|}
156

edits

Navigation menu