GNU Radio Radar Toolbox
ofdm_divide_vcvc.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_OFDM_DIVIDE_VCVC_H
23 #define INCLUDED_RADAR_OFDM_DIVIDE_VCVC_H
24 
25 #include <gnuradio/tagged_stream_block.h>
26 #include <radar/api.h>
27 
28 namespace gr {
29 namespace radar {
30 
31 /*!
32  * \brief This block performs a complex complex division with in0/in1. If vlen_out >
33  * vlen_in the additional space is filled with zeros. This can be used for zeropadding.
34  * discarded_carriers is a vector of the carriers which should be not used and set zero as
35  * division result. num_sync_words gives the number of sync words on which the
36  * discarded_carriers rule is not applied.
37  *
38  * \param vlen_in Input vector length
39  * \param vlen_out Output vector length
40  * \param discarded_carriers Discarded carriers
41  * \param num_sync_words Number of sync words
42  * \param len_key Packet length key for tagged stream
43  *
44  * \ingroup radar
45  *
46  */
47 class RADAR_API ofdm_divide_vcvc : virtual public gr::tagged_stream_block
48 {
49 public:
50  typedef std::shared_ptr<ofdm_divide_vcvc> sptr;
51 
52  /*!
53  * \brief Return a shared_ptr to a new instance of radar::ofdm_divide_vcvc.
54  *
55  * To avoid accidental use of raw pointers, radar::ofdm_divide_vcvc's
56  * constructor is in a private implementation
57  * class. radar::ofdm_divide_vcvc::make is the public interface for
58  * creating new instances.
59  */
60  static sptr make(int vlen_in,
61  int vlen_out,
62  std::vector<int> discarded_carriers,
63  int num_sync_words,
64  std::string len_key = "packet_len");
65 };
66 
67 } // namespace radar
68 } // namespace gr
69 
70 #endif /* INCLUDED_RADAR_OFDM_DIVIDE_VCVC_H */
#define RADAR_API
Definition: api.h:31
This block performs a complex complex division with in0/in1. If vlen_out > vlen_in the additional spa...
Definition: ofdm_divide_vcvc.h:48
std::shared_ptr< ofdm_divide_vcvc > sptr
Definition: ofdm_divide_vcvc.h:50
static sptr make(int vlen_in, int vlen_out, std::vector< int > discarded_carriers, int num_sync_words, std::string len_key="packet_len")
Return a shared_ptr to a new instance of radar::ofdm_divide_vcvc.
Definition: crop_matrix_vcvc.h:28