firfilter.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */
 
 
#ifndef AIMS_SIGNALFILTER_FIRFILTER_H
#define AIMS_SIGNALFILTER_FIRFILTER_H
 
#include <aims/config/aimsalgo_config.h>
#include <aims/def/general.h>
 
namespace carto
{
  template <class T> class Volume;
  template <class T> class VolumeRef;
}
 
 
enum AimsDirectionAxis
{
  AIMS_X_DIRECTION,
  AIMS_Y_DIRECTION,
  AIMS_Z_DIRECTION,
  AIMS_T_DIRECTION
};
 
 
enum AimsFirFilterType
{
  AIMS_FIR_LOWPASS,
  AIMS_FIR_HIGHPASS,
  AIMS_FIR_BANDPASS,
  AIMS_FIR_BANDSTOP
};
 
 
class AIMSALGO_API AimsFIRFilter
{ protected:
    float _fSampling;
    float _fCut;
    float _fLow;
    float _fHigh;
    float _deltaF;
    float _deltaP;
    float _deltaS;
    float _beta;
    int _type;
    int _nCoef;
    carto::VolumeRef<float> *_impulseResponse;
 
    void numberOfFIRFilterCoef();
    carto::VolumeRef<float> kaiserWindow();
    carto::VolumeRef<float> idealImpulseResponse();
    carto::VolumeRef<float> impulseResponse();
    void initialize();
 
  public:
    AimsFIRFilter(float fs, float fc, float deltaf, float deltap, float deltas,
                  int type);
    AimsFIRFilter(float fs, float fl, float fh, float deltaf, float deltap,
                  float deltas, int type);
    virtual ~AimsFIRFilter();    
 
    float fSampling() const;
    float fCut()      const;
    float fLow()      const;
    float fHigh()     const;
    float deltaF()    const;
    float deltaP()    const;
    float deltaS()    const;
    int  type()      const;
  
    carto::VolumeRef<float>
    process(const carto::rc_ptr<carto::Volume<float> > &data,
            AimsDirectionAxis dir = AIMS_X_DIRECTION);
};
 
 
#endif