GNU Radio 3.7.2git-79-g931a7b07 C++ API
pll_freqdet_cf.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2004,2011 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_ANALOG_PLL_FREQDET_CF_H
24
#define INCLUDED_ANALOG_PLL_FREQDET_CF_H
25
26
#include <
gnuradio/analog/api.h
>
27
#include <
gnuradio/blocks/control_loop.h
>
28
#include <
gnuradio/sync_block.h
>
29
30
namespace
gr {
31
namespace
analog {
32
33
/*!
34
* \brief Implements a PLL which locks to the input frequency and outputs
35
* an estimate of that frequency. Useful for FM Demod.
36
* \ingroup synchronizers_blk
37
*
38
* \details
39
* Input stream 0: complex
40
* Output stream 0: float
41
*
42
* This PLL locks onto a [possibly noisy] reference carrier on
43
* the input and outputs an estimate of that frequency in radians per sample.
44
* All settings max_freq and min_freq are in terms of radians per sample,
45
* NOT HERTZ. The loop bandwidth determins the lock range and should be set
46
* around pi/200 -- 2pi/100.
47
* \sa pll_refout_cc, pll_carriertracking_cc
48
*/
49
class
ANALOG_API
pll_freqdet_cf
50
:
virtual
public
sync_block
,
51
virtual
public
blocks::control_loop
52
{
53
public
:
54
// gr::analog::pll_freqdet_cf::sptr
55
typedef
boost::shared_ptr<pll_freqdet_cf>
sptr
;
56
57
/* \brief Make PLL block that outputs the tracked signal's frequency.
58
*
59
* \param loop_bw: control loop's bandwidth parameter.
60
* \param max_freq: maximum (normalized) frequency PLL will lock to.
61
* \param min_freq: minimum (normalized) frequency PLL will lock to.
62
*/
63
static
sptr
make(
float
loop_bw,
float
max_freq,
float
min_freq);
64
65
virtual
void
set_loop_bandwidth(
float
bw) = 0;
66
virtual
void
set_damping_factor(
float
df) = 0;
67
virtual
void
set_alpha(
float
alpha) = 0;
68
virtual
void
set_beta(
float
beta) = 0;
69
virtual
void
set_frequency(
float
freq) = 0;
70
virtual
void
set_phase(
float
phase) = 0;
71
virtual
void
set_min_freq(
float
freq) = 0;
72
virtual
void
set_max_freq(
float
freq) = 0;
73
74
virtual
float
get_loop_bandwidth()
const
= 0;
75
virtual
float
get_damping_factor()
const
= 0;
76
virtual
float
get_alpha()
const
= 0;
77
virtual
float
get_beta()
const
= 0;
78
virtual
float
get_frequency()
const
= 0;
79
virtual
float
get_phase()
const
= 0;
80
virtual
float
get_min_freq()
const
= 0;
81
virtual
float
get_max_freq()
const
= 0;
82
};
83
84
}
/* namespace analog */
85
}
/* namespace gr */
86
87
#endif
/* INCLUDED_ANALOG_PLL_FREQDET_CF_H */
gnuradio
gr-analog
include
gnuradio
analog
pll_freqdet_cf.h
Generated by
1.8.1.1