fir_filter.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2004,2010,2012 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio 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, or (at your option)
 * any later version.
 *
 * GNU Radio 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 GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_FILTER_FIR_FILTER_H
#define INCLUDED_FILTER_FIR_FILTER_H

#include <gnuradio/filter/api.h>
#include <gnuradio/gr_complex.h>
#include <vector>

namespace gr {
namespace filter {
namespace kernel {

class FILTER_API fir_filter_fff
{
public:
    fir_filter_fff(int decimation, const std::vector<float>& taps);
    ~fir_filter_fff();

    void set_taps(const std::vector<float>& taps);
    void update_tap(float t, unsigned int index);
    std::vector<float> taps() const;
    unsigned int ntaps() const;

    float filter(const float input[]);
    void filterN(float output[], const float input[], unsigned long n);
    void filterNdec(float output[],
                    const float input[],
                    unsigned long n,
                    unsigned int decimate);

protected:
    std::vector<float> d_taps;
    unsigned int d_ntaps;
    float** d_aligned_taps;
    float* d_output;
    int d_align;
    int d_naligned;
};

/**************************************************************/

class FILTER_API fir_filter_ccf
{
public:
    fir_filter_ccf(int decimation, const std::vector<float>& taps);
    ~fir_filter_ccf();

    void set_taps(const std::vector<float>& taps);
    void update_tap(float t, unsigned int index);
    std::vector<float> taps() const;
    unsigned int ntaps() const;

    gr_complex filter(const gr_complex input[]);
    void filterN(gr_complex output[], const gr_complex input[], unsigned long n);
    void filterNdec(gr_complex output[],
                    const gr_complex input[],
                    unsigned long n,
                    unsigned int decimate);

protected:
    std::vector<float> d_taps;
    unsigned int d_ntaps;
    float** d_aligned_taps;
    gr_complex* d_output;
    int d_align;
    int d_naligned;
};

/**************************************************************/

class FILTER_API fir_filter_fcc
{
public:
    fir_filter_fcc(int decimation, const std::vector<gr_complex>& taps);
    ~fir_filter_fcc();

    void set_taps(const std::vector<gr_complex>& taps);
    void update_tap(gr_complex t, unsigned int index);
    std::vector<gr_complex> taps() const;
    unsigned int ntaps() const;

    gr_complex filter(const float input[]);
    void filterN(gr_complex output[], const float input[], unsigned long n);
    void filterNdec(gr_complex output[],
                    const float input[],
                    unsigned long n,
                    unsigned int decimate);

protected:
    std::vector<gr_complex> d_taps;
    unsigned int d_ntaps;
    gr_complex** d_aligned_taps;
    gr_complex* d_output;
    int d_align;
    int d_naligned;
};

/**************************************************************/

class FILTER_API fir_filter_ccc
{
public:
    fir_filter_ccc(int decimation, const std::vector<gr_complex>& taps);
    ~fir_filter_ccc();

    void set_taps(const std::vector<gr_complex>& taps);
    void update_tap(gr_complex t, unsigned int index);
    std::vector<gr_complex> taps() const;
    unsigned int ntaps() const;

    gr_complex filter(const gr_complex input[]);
    void filterN(gr_complex output[], const gr_complex input[], unsigned long n);
    void filterNdec(gr_complex output[],
                    const gr_complex input[],
                    unsigned long n,
                    unsigned int decimate);

protected:
    std::vector<gr_complex> d_taps;
    unsigned int d_ntaps;
    gr_complex** d_aligned_taps;
    gr_complex* d_output;
    int d_align;
    int d_naligned;
};

/**************************************************************/

class FILTER_API fir_filter_scc
{
public:
    fir_filter_scc(int decimation, const std::vector<gr_complex>& taps);
    ~fir_filter_scc();

    void set_taps(const std::vector<gr_complex>& taps);
    void update_tap(gr_complex t, unsigned int index);
    std::vector<gr_complex> taps() const;
    unsigned int ntaps() const;

    gr_complex filter(const short input[]);
    void filterN(gr_complex output[], const short input[], unsigned long n);
    void filterNdec(gr_complex output[],
                    const short input[],
                    unsigned long n,
                    unsigned int decimate);

protected:
    std::vector<gr_complex> d_taps;
    unsigned int d_ntaps;
    gr_complex** d_aligned_taps;
    gr_complex* d_output;
    int d_align;
    int d_naligned;
};

/**************************************************************/

class FILTER_API fir_filter_fsf
{
public:
    fir_filter_fsf(int decimation, const std::vector<float>& taps);
    ~fir_filter_fsf();

    void set_taps(const std::vector<float>& taps);
    void update_tap(float t, unsigned int index);
    std::vector<float> taps() const;
    unsigned int ntaps() const;

    short filter(const float input[]);
    void filterN(short output[], const float input[], unsigned long n);
    void filterNdec(short output[],
                    const float input[],
                    unsigned long n,
                    unsigned int decimate);

protected:
    std::vector<float> d_taps;
    unsigned int d_ntaps;
    float** d_aligned_taps;
    short* d_output;
    int d_align;
    int d_naligned;
};

} /* namespace kernel */
} /* namespace filter */
} /* namespace gr */

#endif /* INCLUDED_FILTER_FIR_FILTER_H */