GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
ofdm_frame_equalizer_vcvc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/* Copyright 2012 Free Software Foundation, Inc.
3 *
4 * This file is part of GNU Radio
5 *
6 * GNU Radio is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * GNU Radio is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with GNU Radio; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street,
19 * Boston, MA 02110-1301, USA.
20 */
21
22#ifndef INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H
23#define INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H
24
28
29namespace gr {
30namespace digital {
31
32/*!
33 * \brief OFDM frame equalizer
34 * \ingroup ofdm_blk
35 *
36 * \details
37 * Performs equalization in one or two dimensions on a tagged OFDM frame.
38 *
39 * This does two things:
40 * First, it removes the coarse carrier offset. If a tag is found on the first
41 * item with the key 'ofdm_sync_carr_offset', this is interpreted as the coarse
42 * frequency offset in number of carriers.
43 * Next, it performs equalization in one or two dimensions on a tagged OFDM frame.
44 * The actual equalization is done by a ofdm_frame_equalizer object, outside of
45 * the block.
46 *
47 * Note that the tag with the coarse carrier offset is not removed. Blocks
48 * downstream from this block must not attempt to also correct this offset.
49 *
50 * Input: a tagged series of OFDM symbols.
51 * Output: The same as the input, but equalized and frequency-corrected.
52 */
54{
55public:
56 typedef boost::shared_ptr<ofdm_frame_equalizer_vcvc> sptr;
57
58 /*!
59 * \param equalizer The equalizer object that will do the actual work
60 * \param cp_len Length of the cyclic prefix in samples (required to correct the
61 * frequency offset) \param tsb_key TSB key \param propagate_channel_state If true,
62 * the channel state after the last symbol will be added to the first symbol as a tag
63 * \param fixed_frame_len Set if the frame length is fixed. When this value is given,
64 * the TSB tag key can be left empty, but it is useful even
65 * when using tagged streams at the input.
66 */
68 int cp_len,
69 const std::string& tsb_key = "frame_len",
70 bool propagate_channel_state = false,
71 int fixed_frame_len = 0);
72};
73
74} // namespace digital
75} // namespace gr
76
77#endif /* INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H */
boost::shared_ptr< ofdm_equalizer_base > sptr
Definition ofdm_equalizer_base.h:45
OFDM frame equalizer.
Definition ofdm_frame_equalizer_vcvc.h:54
static sptr make(ofdm_equalizer_base::sptr equalizer, int cp_len, const std::string &tsb_key="frame_len", bool propagate_channel_state=false, int fixed_frame_len=0)
boost::shared_ptr< ofdm_frame_equalizer_vcvc > sptr
Definition ofdm_frame_equalizer_vcvc.h:56
Block that operates on PDUs in form of tagged streams.
Definition tagged_stream_block.h:38
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46