GNU Radio Manual and C++ API Reference 3.9.4.0
The Free & Open Software Radio Ecosystem
hilbert_fc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,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_HILBERT_FC_H
12#define INCLUDED_FILTER_HILBERT_FC_H
13
14#include <gnuradio/fft/window.h>
15#include <gnuradio/filter/api.h>
17#include <gnuradio/sync_block.h>
18#include <gnuradio/types.h>
19
20namespace gr {
21namespace filter {
22
23/*!
24 * \brief Hilbert transformer.
25 * \ingroup filter_blk
26 *
27 * \details
28 * real output is input appropriately delayed.
29 * imaginary output is hilbert filtered (90 degree phase shift)
30 * version of input.
31 */
32class FILTER_API hilbert_fc : virtual public sync_block
33{
34public:
35 // gr::filter::hilbert_fc::sptr
36 typedef std::shared_ptr<hilbert_fc> sptr;
37
38 /*!
39 * Build a Hilbert transformer filter block.
40 *
41 * \param ntaps The number of taps for the filter.
42 * \param window Window type (see fft::window::win_type) to use.
43 * \param beta Parameter value for Kaiser, Exp., Gaussian, Tukey windows, the name
44 * `beta` is used for API compatibility but will be changed to `param` in 3.10.
45 */
46 static sptr make(unsigned int ntaps,
47 fft::window::win_type window = fft::window::win_type::WIN_HAMMING,
48 double beta = 6.76);
49};
50
51} /* namespace filter */
52} /* namespace gr */
53
54#endif /* INCLUDED_FILTER_HILBERT_FC_H */
win_type
Definition: window.h:25
Hilbert transformer.
Definition: hilbert_fc.h:33
std::shared_ptr< hilbert_fc > sptr
Definition: hilbert_fc.h:36
static sptr make(unsigned int ntaps, fft::window::win_type window=fft::window::win_type::WIN_HAMMING, double beta=6.76)
synchronous 1:1 input to output with history
Definition: sync_block.h:26
#define FILTER_API
Definition: gr-filter/include/gnuradio/filter/api.h:18
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition: basic_block.h:29