Changelog / backlog¶

Feature requests and suggestions should be submitted on the GitHub repository and are always welcome.

Backlog¶

Improved statistic handling, possibly with option to export to pandas and easier gathering of statistics for many recordings
Improved masking, more types of masking and custom masking
Improved robust regression and integrating this with the configuration options
Improved estimation of the regression uncertainty to feed into inversion
Full support of Phoenix data and calibration files
Support for miniseed data format
More parameters in transfunc data (induction arrows etc), rotation
Support for SPAM XTRX header files
Investigating how the statistics can be best combined
Addition of signal processing methods to denoise in time domain
Possible denoising in frequency domain
Extraction of more meaningful window features
Supporting the use of custom statistics

March 15, 2020

Added: None.
Changed: The way windows are defined when selecting statistics from statistic data. Currently, the statistic data is in raw arrays. In future, might be best to be able to export as Pandas dataframe to allow people to use statistics easier.
Deprecated: None.
Removed: None.
Fixed: Change the way data is selected in StatisticData to fix Issue #5. The was due to injudicious use to bools and Lists for truth checking. Now increasing the use of None in the code where no results are found.
Fixed: Fixed issue where some window parameters are not passed from configuration file into WindowParameters. For more information, see Issue #4.
Fixed: Fixed bug in SpectrumReader when requesting 0 windows from batch reader. This can happen when selecting windows shared across multiple sites and a recording at one site has not shared windows with another site. In this case, 0 windows will be requested from this recording and it would previously fail. See Issue #3.

Nov 11, 2019

Added: Multiprocessing added for spectra calculations, statistic calculations and transfer function estimation (predominantly the power spectra calculations).
Added: Multiprocessing documentation.
Added: Spectra batches in WindowSelector allowing batches of overlapping spectra data to be pre-read for processing. This speeds up transfer function estimation by reducing disk reads.
Changed: Speed up transfer function estimation by using WindowSelector spectra batches.
Changed: Statistics and spectra readers return None when no file is found rather than False.
Deprecated: None.
Removed: None.
Fixed: None.

Oct 13, 2019

Added: Modules common, config, time, spectra, statistics, mask, transfunc, calibration, window, decimate, regression, project, site as part of a restructure of the resistics code base to give more meaningful imports.
Added: Statistic documentation in the features section
Changed: Tutorial changed to reflect new code structure.
Changed: Advanced examples to reflect new code structure.
Changed: Time series and calibration format examples changed to reflect new code structure.
Changed: Cookbook changed to reflect new code structure.
Deprecated: All functionality remains but has been re-organised.
Removed: Modules ioHandlers, dataObjects, calculators and utilities all removed as part of a restructure of resistics to give more meaningful imports and to simplify the organisation of functionality.
Fixed: Fixed a bug in resistics.project.transfunc.processSite and resistics.project.shortcuts.getWindowSelector which ignores user supplied specdir option.

Sep 29, 2019

Added: Modules to read in Lemi B423 and B423E data and documenation to show usage.
Added: Documentation for advanced methods include remote reference, pre-processing and intersite processing.
Changed: None
Deprecated: None
Removed: None
Fixed: Fixed a bug in resistics.ioHandlers.spectrumWriter.SpectrumWriter with a mismatch between channel ordering in the info file and channel ordering in the data. This could lead to incorrect usage of channel data in transfer function calculations if the data had been written out in resistics internal format.