Metadata-Version: 2.1
Name: butterworth
Version: 0.0.3
Summary: Real-time digital butterworth IIR filter
Home-page: https://github.com/keikun555/butter
Author: Kei Imada
Author-email: kimada1@swarthmore.edu
License: MIT
Keywords: signal processing butterworth filter IIR infinite impulse response forward-backward filtering
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: numba
Requires-Dist: numpy

butter
======
Python implementation of the digital butterworth IIR filter

Dependencies
============
- **numpy** -- used for its math modules and fast array calculations
- **numba** -- used to increase calculation speed

Basic Usage
===========
Importing the Butter module::

  from butterworth import Butter

Creating the Butter instance for a lowpass butterworth filter with cutoff frequency 1000Hz and rolloff frequency 48Hz for data taken with sampling frequency 44100::

  filter_ = Butter(btype="Lowpass", cutoff=1000, rolloff=48, sampling=44100)

Sending sample data into filter and retrieving the filtered data::

  data=[1.0, -2.0, 3.0, . . . .]
  filtered_data = filter_.send(data)

Retrieving forward-backward filtered data for the accumulated data::

  data1=[1.0, -2.0, 3.0, . . . .]
  filtered_data = filter_.send(data1)
  data2=[-1.0, 2.0, -3.0, . . . .]
  more_filtered_data = filter_.send(data2)
  forward_backwards_filtered_data = filter_.filtfilt()


