Metadata-Version: 2.1
Name: py-iir-filter
Version: 1.0.5
Summary: Fast realtime IIR filter
Home-page: https://github.com/berndporr/py-iir-filter
Author: Bernd Porr
Author-email: mail@berndporr.me.uk
License: GPL 3.0
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Dist: numpy

=======================================
Efficient realtime IIR filter in Python
=======================================

This is an IIR filter class which performs sample by sample realtime
processing of data. It's very efficient because it's not using any 
indexing operations internally. The class instance acts as the memory
of the filter so that it remembers its past.


Import
======

Use the standard python command to import it::

  import iir-filter


Calculate the coefficients
==========================

Use your favourite scipy IIR design command and export the coefficients as an SOS::

    sos = signal.butter(order, [cutoff(s)], '[filter type]', output='sos')



Create an instance
==================

The constructor takes the sos chain as an argument::

    f = iir_filter.IIR_filter(sos)



Perform filtering sample by sample
==================================

Filtering is sample by sample by processing the samples
as they arrive, for example from an ADC::

   sample = f.filter(sample)


