GNU Radio Manual and C++ API Reference
3.9.1.0
The Free & Open Software Radio Ecosystem
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
* SPDX-License-Identifier: GPL-3.0-or-later
7
*
8
*/
9
10
#ifndef INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H
11
#define INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H
12
13
#include <
gnuradio/digital/api.h
>
14
#include <
gnuradio/digital/ofdm_equalizer_base.h
>
15
#include <
gnuradio/tagged_stream_block.h
>
16
17
namespace
gr
{
18
namespace
digital {
19
20
/*!
21
* \brief OFDM frame equalizer
22
* \ingroup ofdm_blk
23
*
24
* \details
25
* Performs equalization in one or two dimensions on a tagged OFDM frame.
26
*
27
* This does two things:
28
* First, it removes the coarse carrier offset. If a tag is found on the first
29
* item with the key 'ofdm_sync_carr_offset', this is interpreted as the coarse
30
* frequency offset in number of carriers.
31
* Next, it performs equalization in one or two dimensions on a tagged OFDM frame.
32
* The actual equalization is done by a ofdm_frame_equalizer object, outside of
33
* the block.
34
*
35
* Note that the tag with the coarse carrier offset is not removed. Blocks
36
* downstream from this block must not attempt to also correct this offset.
37
*
38
* Input: a tagged series of OFDM symbols.
39
* Output: The same as the input, but equalized and frequency-corrected.
40
*/
41
class
DIGITAL_API
ofdm_frame_equalizer_vcvc
:
virtual
public
tagged_stream_block
42
{
43
public
:
44
typedef
std::shared_ptr<ofdm_frame_equalizer_vcvc>
sptr
;
45
46
/*!
47
* \param equalizer The equalizer object that will do the actual work
48
* \param cp_len Length of the cyclic prefix in samples (required to correct the
49
* frequency offset) \param tsb_key TSB key \param propagate_channel_state If true,
50
* the channel state after the last symbol will be added to the first symbol as a tag
51
* \param fixed_frame_len Set if the frame length is fixed. When this value is given,
52
* the TSB tag key can be left empty, but it is useful even
53
* when using tagged streams at the input.
54
*/
55
static
sptr
make(
ofdm_equalizer_base::sptr
equalizer,
56
int
cp_len,
57
const
std::string& tsb_key =
"frame_len"
,
58
bool
propagate_channel_state =
false
,
59
int
fixed_frame_len = 0);
60
};
61
62
}
// namespace digital
63
}
// namespace gr
64
65
#endif
/* INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H */
gr::digital::ofdm_equalizer_base::sptr
std::shared_ptr< ofdm_equalizer_base > sptr
Definition:
ofdm_equalizer_base.h:32
tagged_stream_block.h
gr::digital::ofdm_frame_equalizer_vcvc::sptr
std::shared_ptr< ofdm_frame_equalizer_vcvc > sptr
Definition:
ofdm_frame_equalizer_vcvc.h:44
DIGITAL_API
#define DIGITAL_API
Definition:
gr-digital/include/gnuradio/digital/api.h:18
ofdm_equalizer_base.h
api.h
gr::digital::ofdm_frame_equalizer_vcvc
OFDM frame equalizer.
Definition:
ofdm_frame_equalizer_vcvc.h:41
gr
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition:
basic_block.h:29
gr::tagged_stream_block
Block that operates on PDUs in form of tagged streams.
Definition:
tagged_stream_block.h:25
gr-digital
include
gnuradio
digital
ofdm_frame_equalizer_vcvc.h
Generated by
1.8.17