Loading...
Searching...
No Matches
dc_blocker_cc.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2011,2012 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_FILTER_DC_BLOCKER_CC_H
#define INCLUDED_FILTER_DC_BLOCKER_CC_H
#include <gnuradio/filter/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace filter {
/*!
* \brief a computationally efficient controllable DC blocker
* \ingroup filter_blk
*
* \details
* This block implements a computationally efficient DC blocker that produces
* a tighter notch filter around DC for a smaller group delay than an
* equivalent FIR filter or using a single pole IIR filter (though the IIR
* filter is computationally cheaper).
*
* The block defaults to using a delay line of length 32 and the long form
* of the filter. Optionally, the delay line length can be changed to alter
* the width of the DC notch (longer lines will decrease the width).
*
* The long form of the filter produces a nearly flat response outside of
* the notch but at the cost of a group delay of 2D-2.
*
* The short form of the filter does not have as flat a response in the
* passband but has a group delay of only D-1 and is cheaper to compute.
*
* The theory behind this block can be found in the paper:
*
* <B><EM>R. Yates, "DC Blocker Algorithms," IEEE Signal Processing Magazine,
* Mar. 2008, pp 132-134.</EM></B>
*/
class FILTER_API dc_blocker_cc : virtual public sync_block
{
public:
// gr::filter::dc_blocker_cc::sptr
typedef std::shared_ptr<dc_blocker_cc> sptr;
/*!
* Make a DC blocker block.
*
* \param D (int) the length of the delay line
* \param long_form (bool) whether to use long (true, default) or short form
*/
static sptr make(int D, bool long_form);
virtual int group_delay() = 0;
};
} /* namespace filter */
} /* namespace gr */
#endif /* INCLUDED_FILTER_DC_BLOCKER_CC_H */
D
#define D(...)
Definition basic_block_pydoc_template.h:10
gr::filter::dc_blocker_cc
a computationally efficient controllable DC blocker
Definition dc_blocker_cc.h:46
gr::filter::dc_blocker_cc::group_delay
virtual int group_delay()=0
gr::filter::dc_blocker_cc::sptr
std::shared_ptr< dc_blocker_cc > sptr
Definition dc_blocker_cc.h:49
gr::filter::dc_blocker_cc::make
static sptr make(int D, bool long_form)
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