gr_adaptive_fir_ccf.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2006 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_GR_ADAPTIVE_FIR_CCF_H
#define INCLUDED_GR_ADAPTIVE_FIR_CCF_H

#include <gr_core_api.h>
#include <gr_sync_decimator.h>

/*!
 * \brief Adaptive FIR filter with gr_complex input, gr_complex output and float taps
 */
class GR_CORE_API gr_adaptive_fir_ccf : public gr_sync_decimator
{
private:
  std::vector<float>  d_new_taps;
  bool                d_updated;

protected:
  float               d_error;
  std::vector<float>  d_taps;

  // Override to calculate error signal per output
  virtual float error(const gr_complex &out) = 0;

  // Override to calculate new weight from old, corresponding input
  virtual void update_tap(float &tap, const gr_complex &in) = 0;

  gr_adaptive_fir_ccf(const char *name, int decimation, const std::vector<float> &taps);

public:
  void set_taps(const std::vector<float> &taps);

  int work(int noutput_items,
           gr_vector_const_void_star &input_items,
           gr_vector_void_star &output_items);
};

#endif