Metadata-Version: 2.1
Name: SignalFilters
Version: 0.0.4
Summary: Filtering digital signals using a front end to scipy filters
Home-page: https://github.com/eelcovv/SignalFilters
Author: Eelco van Vliet
Author-email: eelcovv@gmail.nl
License: MIT
Project-URL: Documentation, https://signalfilters.readthedocs.io/en/latest/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: PeakUtils
Requires-Dist: scipy
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: dev
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: tabulate ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Provides-Extra: examples
Requires-Dist: funcy ; extra == 'examples'
Requires-Dist: seaborn ; extra == 'examples'
Requires-Dist: matplotlib ; extra == 'examples'
Requires-Dist: tabulate ; extra == 'examples'
Requires-Dist: pymdfreader ; extra == 'examples'
Provides-Extra: notebook
Requires-Dist: jupyter ; extra == 'notebook'
Requires-Dist: funcy ; extra == 'notebook'
Requires-Dist: seaborn ; extra == 'notebook'
Requires-Dist: matplotlib ; extra == 'notebook'
Requires-Dist: tabulate ; extra == 'notebook'
Requires-Dist: pymdfreader ; extra == 'notebook'
Provides-Extra: testing
Requires-Dist: setuptools ; extra == 'testing'
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'

=============
SignalFilters
=============


    A collection of digital signal filter front end for scipy


A collection of signal processing tools, utilities and class for signal processing

Description
===========

The signal processing tool box has the following topics

1. filters: Definition of three digital signal filters (all with low, high, -band-pass mode)
    - Ideal block filter
    - Butterworth filter
    - Kaiser filter
    - Phase shift removal
2. utils: Classes and function to support signal processing
    - SignalGenerator: class to generated signal with multiple harmonic components and
      noise for testing purposes
    - get_peaks: Extract the peaks from a power spectral density

Notes
-----

* The `SciPy`_ provides most signal processing tool, such as as power spectral density
  estimator *welch*, which uses an equivalent algorithm as the *specdens* function from
  the Matlab tool box
* The filters defined in this package are in fact front ends to the Scipy filters,
  however, in this package the filters have a more user-friendly interface.
* For peak finding either the `PeakUtils`_ or the `PyWafo`_ package is recommended.
* The function *get_peaks* is a front end to the *peakutils.peaks* function

Examples
========

* Examples of using filtering with the *SignalFilters* package: `example_filtering`_

.. _example_filtering:  _static/example_filtering.html

.. _PeakUtils:
   https://pypi.python.org/pypi/PeakUtils
.. _SciPy:
   https://www.scipy.org/
.. _PyWafo:
    https://github.com/wafo-project/pywafo

Note
====

This project has been set up using PyScaffold 4.5.0. For details and usage
information on PyScaffold see http://pyscaffold.readthedocs.org/.
