Table of Contents

Class: LinearFilter LinearFilter.py

Parent class to implementing linear filtering

It cannot be instanciated. It is intended to be the mother class of another getting the coefficients of the filter.

Any class derived from LinearFilter MUST define an attribute coefs storing the coefficients of the filter and an attribute length with the number of coeffients.

Methods   
__thevalues
getfiltered
reset
  __thevalues 
__thevalues ( self )

  getfiltered 
getfiltered (
        self,
        ifield,
        tcode=Numeric.Float64,
        )

Get a filtered record out of a raw one

This method returns None while not enough records have been passed to the filter. npoints records are missed in the filtering process so the first valid (not None) value returned corresponds to the record npoints in the original field and is returned when 2*'npoints'+1 records have been passed to this function.

Argument:

ifield
Piece of data to be filtered. It can be a multimensional array.

Optional argument:

tcode
Numeric typecode for the internal cumputations
  reset 
reset ( self )

Reset the linear filter

After the reset() the filter can be used to start computing with a data set of a different shape


Table of Contents

This document was automatically generated on Mon Dec 9 15:58:37 2002 by HappyDoc version 2.1