Repository navigation
v3.0.1 is a bug-fix release. No feature values or feature names change from v3.0.0, so there is no need to recompute. The only change to the feature set is which features carry the 'tisean' keyword.
'tisean' keyword
The 'tisean' keyword now marks exactly the features that need the TISEAN binaries: those whose master operation runs a TISEAN program, either directly or by choosing its embedding dimension with false nearest neighbors ({'fnn',0.05}, which runs TISEAN's false_nearest). 580 features carry it (659 in v3.0.0). If you exclude 'tisean' features because TISEAN is not installed, the set you remove is now correct:
- Added to
PP_SchreiberDenoise(14 features) and to five masters that embed withfnn(49 features):NL_nlpe_fnn005_mi_5000_ac1,NL_LocalDensity_5_ac1_ac1e_fnn005,NL_FractalDimensions_5_20_02_1_10_ac1_32_ac_fnn005,NL_RQA_mi_fnn005_ac1_01_2_2_fullandNL_RecurrenceTimes_mi_fnn005_ac1_01_4_full. In v3.0.0 these were kept when'tisean'features were excluded, but could not be computed without TISEAN. - Removed from
NL_PoincareSection(138 features), which is computed natively, and from the fourNL_TakensEstimatormasters with a fixed embedding dimension (4 features). These were excluded unnecessarily in v3.0.0.
compile_tisean no longer builds the poincare program, which no operation calls.
Bug fixes
sample_runscript_matlabskipped the last block of time series when the number of series was not a multiple ofsaveIncrement(e.g. with 7 series andsaveIncrement = 5, series 6 and 7 were never computed). Its help example also passed the file name assaveIncrement; it is nowsample_runscript_matlab(true,5,'HCTSA.mat').TS_WhichProblemTSreturneddataCellas a cell nested inside another cell, sodataCell{1}was not the first problem time series, as its help says.TS_SimSearchwith'whatPlots',{'matrix'}crashed with "Index exceeds the number of array elements" when a neighbor had NaN distances. Such items are now drawn at the end of the ordering, as NaN (black) cells.TS_ComputecheckshowVocal('fast','minimal'or'full') and gives a clear error for an unknown value.trueandfalseare accepted as'full'and'fast'(previouslyfalseran with almost no output), and an empty value takes the default.startup.madded the TISEAN and ripser binaries to the systemPATHwith a:separator, which is wrong on Windows; it now usespathsep. It also matched existingPATHentries as regular expressions, which misread paths containing backslashes or other special characters.BF_AnnotatePointserrored whentextAnnotationwas not text (e.g.false); it now warns and adds no text annotation.- Help-text fixes in
TS_TopFeatures,BF_LowDimProject('tsne') andTS_PlotTimeSeries(the default is'raw').
Toolbox dependencies
ToolboxDependencies.txtis regenerated for v3.0.0's operations, both the MATLAB toolboxes and the provided ones. It no longer lists the System Identification Toolbox, removed operations (SY_DynWin,HT_HypothesisTest) or Econometrics for the GARCH operations.install.mno longer checks for the System Identification and Financial toolboxes, which no registered operation needs. (The Financial Toolbox is used only byPP_Compare's unregistered'boxcox'method.)TS_TopFeaturesneeds the Bioinformatics Toolbox (mafdr) whennumNulls > 0; this is now documented.
Downloads and installation
As for v3.0.0: git clone --recurse-submodules https://github.com/benfulcher/hctsa.git, then run install.m. To download rather than clone, use hctsa-v3.0.1.tar.gz, attached below, which includes the catch22 submodule (GitHub's automatic "Source code" archives do not). If you are updating an existing v3.0.0 installation, you do not need to re-run install.m.
Full changes: v3.0.0...v3.0.1
If you use hctsa, please cite Fulcher & Jones, Cell Systems (2017) and Fulcher, Little & Jones, J. R. Soc. Interface (2013).