GNU Radio's AIS Package: msk_timing_recovery_cc.h Source File

GNU Radio's AIS Package

msk_timing_recovery_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2014 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_MSK_TIMING_RECOVERY_CC_H
24#define INCLUDED_DIGITAL_MSK_TIMING_RECOVERY_CC_H
25
26#include <ais/api.h>
27#include <gnuradio/block.h>
28
29namespace gr {
30 namespace ais {
31
32 /*!
33 * \brief MSK/GMSK timing recovery
34 * \ingroup synchronizers_blk
35 *
36 * This block performs timing synchronization on CPM modulations using a
37 * fourth-order nonlinearity feedback method which is non-data-aided. The
38 * block does not require prior phase synchronization but is relatively
39 * sensitive to frequency offset (keep offset to 0.1x symbol rate).
40 *
41 * For details on the algorithm, see:
42 * A.N. D'Andrea, U. Mengali, R. Reggiannini: A digital approach to clock
43 * recovery in generalized minimum shift keying. IEEE Transactions on
44 * Vehicular Technology, Vol. 39, Issue 3.
45 */
46 class AIS_API msk_timing_recovery_cc : virtual public gr::block
47 {
48 public:
49 typedef boost::shared_ptr<msk_timing_recovery_cc> sptr;
50
51 /*!
52 * \brief Make an MSK timing recovery block.
53 *
54 * \param sps: Samples per symbol
55 * \param gain: Loop gain of timing error filter (try 0.05)
56 * \param limit: Relative limit of timing error (try 0.1 for 10% error max)
57 * \param osps: Output samples per symbol
58 *
59 */
60 static sptr make(float sps, float gain, float limit, int osps);
61
62 virtual void set_gain(float gain)=0;
63 virtual float get_gain(void)=0;
64
65 virtual void set_limit(float limit)=0;
66 virtual float get_limit(void)=0;
67
68 virtual void set_sps(float sps)=0;
69 virtual float get_sps(void)=0;
70 };
71
72 } // namespace digital
73} // namespace gr
74
75#endif /* INCLUDED_DIGITAL_MSK_TIMING_RECOVERY_CC_H */
76
api.h
AIS_API
#define AIS_API
Definition: api.h:30
gr::ais::msk_timing_recovery_cc
MSK/GMSK timing recovery.
Definition: msk_timing_recovery_cc.h:47
gr::ais::msk_timing_recovery_cc::set_limit
virtual void set_limit(float limit)=0
gr::ais::msk_timing_recovery_cc::set_gain
virtual void set_gain(float gain)=0
gr::ais::msk_timing_recovery_cc::get_gain
virtual float get_gain(void)=0
gr::ais::msk_timing_recovery_cc::sptr
boost::shared_ptr< msk_timing_recovery_cc > sptr
Definition: msk_timing_recovery_cc.h:49
gr::ais::msk_timing_recovery_cc::make
static sptr make(float sps, float gain, float limit, int osps)
Make an MSK timing recovery block.
gr::ais::msk_timing_recovery_cc::set_sps
virtual void set_sps(float sps)=0
gr::ais::msk_timing_recovery_cc::get_limit
virtual float get_limit(void)=0
gr::ais::msk_timing_recovery_cc::get_sps
virtual float get_sps(void)=0
gr
Definition: corr_est_cc.h:29