GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
clock_recovery_mm_ff.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2011,2012 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_DIGITAL_CLOCK_RECOVERY_MM_FF_H
24 #define INCLUDED_DIGITAL_CLOCK_RECOVERY_MM_FF_H
25 
26 #include <gnuradio/digital/api.h>
27 #include <gnuradio/block.h>
28 
29 namespace gr {
30  namespace digital {
31 
32  /*!
33  * \brief Mueller and Müller (M&M) based clock recovery block with float input, float output.
34  * \ingroup synchronizers_blk
35  *
36  * \details
37  * This implements the Mueller and Müller (M&M) discrete-time
38  * error-tracking synchronizer.
39  *
40  * See "Digital Communication Receivers: Synchronization, Channel
41  * Estimation and Signal Processing" by Heinrich Meyr, Marc
42  * Moeneclaey, & Stefan Fechtel. ISBN 0-471-50275-8.
43  */
44  class DIGITAL_API clock_recovery_mm_ff : virtual public block
45  {
46  public:
47  // gr::digital::clock_recovery_mm_ff::sptr
48  typedef boost::shared_ptr<clock_recovery_mm_ff> sptr;
49 
50  /*!
51  * Make a M&M clock recovery block.
52  *
53  * \param omega Initial estimate of samples per symbol
54  * \param gain_omega Gain setting for omega update loop
55  * \param mu Initial estimate of phase of sample
56  * \param gain_mu Gain setting for mu update loop
57  * \param omega_relative_limit maximum relative deviation from omega
58  */
59  static sptr make(float omega, float gain_omega,
60  float mu, float gain_mu,
61  float omega_relative_limit);
62 
63  virtual float mu() const = 0;
64  virtual float omega() const = 0;
65  virtual float gain_mu() const = 0;
66  virtual float gain_omega() const = 0;
67 
68  virtual void set_verbose(bool verbose) = 0;
69  virtual void set_gain_mu (float gain_mu) = 0;
70  virtual void set_gain_omega (float gain_omega) = 0;
71  virtual void set_mu (float mu) = 0;
72  virtual void set_omega (float omega) = 0;
73  };
74 
75  } /* namespace digital */
76 } /* namespace gr */
77 
78 #endif /* INCLUDED_DIGITAL_CLOCK_RECOVERY_MM_FF_H */
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
Include this header to use the message passing features.
Definition: logger.h:131
boost::shared_ptr< clock_recovery_mm_ff > sptr
Definition: clock_recovery_mm_ff.h:48
The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ...
Definition: block.h:60
Mueller and Müller (M&M) based clock recovery block with float input, float output.
Definition: clock_recovery_mm_ff.h:44