conv_bit_corr_bb.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2013-2014 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_FEC_CONV_BIT_CORR_BB_H
#define INCLUDED_FEC_CONV_BIT_CORR_BB_H

#include <gnuradio/fec/api.h>
#include <gnuradio/block.h>
#include <vector>

namespace gr {
  namespace fec {

    /*!
     * \brief Correlate block in FECAPI
     * \ingroup error_coding_blk
     *
     * \details
     *
     * What does this block do?
     */
    class FEC_API conv_bit_corr_bb : virtual public block
    {
    public:
      // gr::fec::conv_bit_corr_bb::sptr
      typedef boost::shared_ptr<conv_bit_corr_bb> sptr;

      static sptr make(std::vector<unsigned long long> correlator,
                       int corr_sym, int corr_len, int cut,
                       int flush, float thresh);

      /*!
       * This subroutine will find the encoded data garble rate
       * corresponding to a syndrome density of `target', that is created
       * with an annihilating polynomial with 'taps' number of taps.
       */
      virtual float data_garble_rate(int taps, float syn_density) = 0;
    };

  } /* namespace fec */
} /* namespace gr */

#endif /* INCLUDED_FEC_CONV_BIT_CORR_BB_H */