Signal Processing Toolkit - Documentation!
===================

.. image:: https://raw.githubusercontent.com/Nikeshbajaj/spkit/master/figures/cwt_ex0.jpg


.. image:: https://img.shields.io/circleci/build/github/Nikeshbajaj/spkit
  :target: https://pypi.python.org/pypi/spkit
  :alt: CircleCI
.. image:: https://readthedocs.org/projects/spkit/badge/?version=latest
  :target: https://spkit.readthedocs.io/en/latest/
  :alt: Documentation Status
  
.. image:: https://img.shields.io/pypi/v/spkit?style=plastic
  :target: https://pypi.python.org/pypi/spkit
  :alt: PyPI
.. image:: https://static.pepy.tech/personalized-badge/spkit?period=total&units=international_system&left_color=black&right_color=blue&left_text=downloads
 :target: https://pepy.tech/project/spkit
.. image:: https://img.shields.io/pypi/dm/spkit
  :target: https://pypi.python.org/pypi/spkit
  :alt: PyPI - Downloads
.. image:: https://img.shields.io/github/license/Nikeshbajaj/spkit
  :target: https://github.com/Nikeshbajaj/spkit
  :alt: GitHub

.. important::
    
    Version: 0.0.9.6 | Released on 27/05/2023
    

:Authors:
    Nikesh Bajaj,
    Jesús Requena Carrión
:Home: https://spkit.github.io  


**New in 0.0.9.6**

* MEA: Multi-Electrode Arrays Processing
* Geomatrical Functions
* Differential Entropy, Transfer Entropy, 
* Signal differentiation, spatial filters



* Homepage *spkit* - https://spkit.github.io

.. * New Guide: - https://spkit.github.io/guide/ 

.. 
  -- Under preperation
 





Getting started
----------

.. toctree::
   :caption: Getting started
   :maxdepth: 1
   
   installation
   

customisation
----------

.. toctree::
   :hidden:
   
   customisation/index

Information Theory
----------   

.. toctree::
   :caption: Information Theory
   :maxdepth: 3
   
   InformationTheory/informationtheory
   InformationTheory/dispersion_entropy

.. Dispersion Entropy (time-series, physiological signals)
.. ----------   

.. .. toctree::
..    :maxdepth: 3
..    :hidden:

   
EEG Artifact Removal Algorithms
----------   

.. toctree::
   :caption: EEG Artifact Removal Algorithms
   :maxdepth: 4
   
   EEG/atar_algo
   EEG/ica_artifact_algo

.. toctree::
   :caption: EEG Topographic Maps (Spatio-Temporal/Spectral)
   :maxdepth: 2
   
   EEG/eeg_topog


Multi-Electrode Arrays Processing: MEA
---------------------------------- 

.. toctree::
   :maxdepth: 3
   
   MEA/mea


  
Complex Continuous Wavelet Transform
---------- 

.. toctree::
   :maxdepth: 3
   
   Wavelet/cwt


Ramanujan Filter Banks for Period Estimation
----------

.. toctree::
   :maxdepth: 3
   
   Processing/ramanujan_methods


Analysis and Synthesis Models
---------- 

.. toctree::
   :maxdepth: 3
   
   Processing/analysis_synthesis_models


.. DFT and STFT for Analysis and Synthesis of signals
.. ---------- 

.. #TODO

Fractional Fourier Transform
---------- 

.. toctree::
   :maxdepth: 3
   
   Processing/fractional_fourier



Filtering
----------   

.. toctree::
   :maxdepth: 2
   
   Processing/filtering


Wavelet Filtering
----------

.. toctree::
   :maxdepth: 2
   
   Wavelet/wavelet_filtering


Independent Component Analysis
----------   

.. toctree::
   :maxdepth: 2
   
   Processing/ica


Machine Learning
---------- 

.. toctree::
   :maxdepth: 3
   
   ML/machinelearning


Basic-utilities
---------- 

.. toctree::
   :maxdepth: 3
   
   basic

   
LFSR
---------- 

.. toctree::
   :maxdepth: 3
   
   pylfsr

API Doc
---------- 

.. toctree::
   :maxdepth: 3
   
   APIs/api

ChangeLog
---------- 

.. toctree::
   :maxdepth: 1
   
   changelog


Contacts
---------- 

.. toctree::
   :maxdepth: 1
   
   contacts