GNU Radio C++ API Reference: dc_blocker_ff.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
dc_blocker_ff.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2011,2012 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_FILTER_DC_BLOCKER_FF_H
12#define INCLUDED_FILTER_DC_BLOCKER_FF_H
13
14#include <gnuradio/filter/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace filter {
19
20/*!
21 * \brief a computationally efficient controllable DC blocker
22 * \ingroup filter_blk
23 *
24 * \details
25 * This block implements a computationally efficient DC blocker
26 * that produces a tighter notch filter around DC for a smaller
27 * group delay than an equivalent FIR filter or using a single
28 * pole IIR filter (though the IIR filter is computationally
29 * cheaper).
30 *
31 * The block defaults to using a delay line of length 32 and the
32 * long form of the filter. Optionally, the delay line length can
33 * be changed to alter the width of the DC notch (longer lines
34 * will decrease the width).
35 *
36 * The long form of the filter produces a nearly flat response
37 * outside of the notch but at the cost of a group delay of 2D-2.
38 *
39 * The short form of the filter does not have as flat a response
40 * in the passband but has a group delay of only D-1 and is
41 * cheaper to compute.
42 *
43 * The theory behind this block can be found in the paper:
44 *
45 * <B><EM>R. Yates, "DC Blocker Algorithms," IEEE Signal Processing Magazine,
46 * Mar. 2008, pp 132-134.</EM></B>
47 */
48 class FILTER_API dc_blocker_ff : virtual public sync_block
49{
50public:
51 // gr::filter::dc_blocker_ff::sptr
52 typedef std::shared_ptr<dc_blocker_ff> sptr;
53
54 /*!
55 * Make a DC blocker block.
56 *
57 * \param D (int) the length of the delay line
58 * \param long_form (bool) whether to use long (true, default) or short form
59 */
60 static sptr make(int D, bool long_form = true);
61
62 virtual int group_delay() = 0;
63};
64
65} /* namespace filter */
66} /* namespace gr */
67
68#endif /* INCLUDED_FILTER_DC_BLOCKER_FF_H */
D
#define D(...)
Definition basic_block_pydoc_template.h:10
gr::filter::dc_blocker_ff
a computationally efficient controllable DC blocker
Definition dc_blocker_ff.h:49
gr::filter::dc_blocker_ff::sptr
std::shared_ptr< dc_blocker_ff > sptr
Definition dc_blocker_ff.h:52
gr::filter::dc_blocker_ff::make
static sptr make(int D, bool long_form=true)
gr::filter::dc_blocker_ff::group_delay
virtual int group_delay()=0
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
FILTER_API
#define FILTER_API
Definition gr-filter/include/gnuradio/filter/api.h:18
gr::filter
Definition dc_blocker_cc.h:18
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h