FirFilter.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
//
// $Id$
//
// Copyright 2008, 2009, 2010, 2011, 2012  Antonio Franchi and Paolo Stegagno    
//
// This file is part of MIP.
//
// MIP is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// MIP is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with MIP. If not, see <http://www.gnu.org/licenses/>.
//
// Contact info: antonio.franchi@tuebingen.mpg.de stegagno@diag.uniroma1.it
//
// ----------------------------------------------------------------------------




#ifndef __FIR_FILTER_H_
#define __FIR_FILTER_H_

#ifdef MIP_HOST_APPLE
#include <applePatch.h>
#endif

#include <list>

#include<baselib.h>


#define FIR_TIME_DEBUG 0

using namespace MipBaselib;

/* @{ */

enum FirFilterShapes{
 FIR_SHAPES_CONSTANT,
 FIR_SHAPES_NUM
};

struct FirFilterPar{
 FirFilterShapes shape;
 Time lag;
 
 FirFilterPar(FirFilterShapes s=FIR_SHAPES_CONSTANT, Time l=Time(1,0)){
  shape = s;
  lag = l;
 }
};

struct FirFilterVar{
 list<Decimal> samples;
 list<Time> timeStamps;
 Time lastTimeStamp;
};

struct FirFilterIn{
 Decimal sample;
 
 FirFilterIn(Decimal s=0.0){
  sample = s;
 }
};

struct FirFilterOut{
 Decimal sample;
 int size;
};

class FirFilter{
 private:
  FirFilterPar _par;
  FirFilterVar _var;
  
  void _eraseOldSamples();
  Decimal _average(FirFilterOut& out);
  
 public:
  FirFilter(FirFilterPar par){
   _par = par;
  }
  
  void step(FirFilterIn& in,FirFilterOut& out);
};

#endif


/* @} */