GNU Radio Radar Toolbox
estimator_ofdm.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2014 Communications Engineering Lab, KIT.
4 *
5 * This is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3, or (at your option)
8 * any later version.
9 *
10 * This software is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this software; see the file COPYING. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street,
18 * Boston, MA 02110-1301, USA.
19 */
20
21
22#ifndef INCLUDED_RADAR_ESTIMATOR_OFDM_H
23#define INCLUDED_RADAR_ESTIMATOR_OFDM_H
24
25#include <gnuradio/block.h>
26#include <radar/api.h>
27
28namespace gr {
29namespace radar {
30
31/*!
32 * \brief This block evaluates the peaks given from a OFDM matrix. Input are the bins of
33 * the peaks with the identifiers 'axis_x' and 'axis_y'. The parameters of the block
34 * axis_x and axis_y are vectors which define the mapping of the axis. If two values are
35 * given it is assumed a linear progression in between. If four values are given the
36 * middle values are set on half of the axis and it is interpolated linear in between.
37 * len_x and len_y gives the length of the axis in number of bins. symbol_x and symbol_y
38 * defines the identifier (symbols) for the output data. merge_consecutive toggles merging
39 * consecutive peaks. Each peak is compared with peaks in a range of one bin. If there is
40 * a peak with a higher power the actual bin is not used for evaluations. If
41 * merge_consecutive is true data with identifier 'power' is needed.
42 *
43 * \param symbol_x Identifier (symbol) for information on x axis
44 * \param len_x Length of x axis in bins
45 * \param axis_x Axis x
46 * \param symbol_y Identifier (symbol) for information on y axis
47 * \param len_y Length of y axis in bins
48 * \param axis_y Axis y
49 * \param merge_consecutive Merge consecutive peaks
50 *
51 * \ingroup radar
52 *
53 */
54class RADAR_API estimator_ofdm : virtual public gr::block
55{
56public:
57 typedef std::shared_ptr<estimator_ofdm> sptr;
58
59 /*!
60 * \brief Return a shared_ptr to a new instance of radar::estimator_ofdm.
61 *
62 * To avoid accidental use of raw pointers, radar::estimator_ofdm's
63 * constructor is in a private implementation
64 * class. radar::estimator_ofdm::make is the public interface for
65 * creating new instances.
66 */
67 static sptr make(std::string symbol_x,
68 int len_x,
69 std::vector<float> axis_x,
70 std::string symbol_y,
71 int len_y,
72 std::vector<float> axis_y,
73 bool merge_consecutive = true);
74};
75
76} // namespace radar
77} // namespace gr
78
79#endif /* INCLUDED_RADAR_ESTIMATOR_OFDM_H */
#define RADAR_API
Definition api.h:31
This block evaluates the peaks given from a OFDM matrix. Input are the bins of the peaks with the ide...
Definition estimator_ofdm.h:55
std::shared_ptr< estimator_ofdm > sptr
Definition estimator_ofdm.h:57
static sptr make(std::string symbol_x, int len_x, std::vector< float > axis_x, std::string symbol_y, int len_y, std::vector< float > axis_y, bool merge_consecutive=true)
Return a shared_ptr to a new instance of radar::estimator_ofdm.
Definition crop_matrix_vcvc.h:28