GNU Radio 3.7.1.1 C++ API
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
25
#include <
gnuradio/digital/api.h
>
26
#include <
gnuradio/digital/ofdm_equalizer_base.h
>
27
#include <
gnuradio/tagged_stream_block.h
>
28
29
namespace
gr {
30
namespace
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
*/
53
class
DIGITAL_API
ofdm_frame_equalizer_vcvc
:
virtual
public
tagged_stream_block
54
{
55
public
:
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 frequency offset)
61
* \param len_tag_key Length tag key
62
* \param propagate_channel_state If true, the channel state after the last symbol
63
* will be added to the first symbol as a tag
64
* \param fixed_frame_len Set if the frame length is fixed throughout,
65
* helps with book keeping.
66
*/
67
static
sptr
make(
68
ofdm_equalizer_base::sptr
equalizer,
69
int
cp_len,
70
const
std::string &len_tag_key =
"frame_len"
,
71
bool
propagate_channel_state=
false
,
72
int
fixed_frame_len=0
73
);
74
};
75
76
}
// namespace digital
77
}
// namespace gr
78
79
#endif
/* INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H */
80
gnuradio
gr-digital
include
gnuradio
digital
ofdm_frame_equalizer_vcvc.h
Generated by
1.8.1.1