GNU Radio Radar Toolbox
crop_matrix_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_CROP_MATRIX_VCVC_H
23 #define INCLUDED_RADAR_CROP_MATRIX_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 matrix crops a data matrix. A tagged stream combined with vectors as items
33  * represent a matrix. crop_x and crop_y gives the ranges which shall be pushed through.
34  * Rest of the matrix is lost.
35  *
36  * \param vlen Vector length
37  * \param crop_x Index range on x axis to crop matrix
38  * \param crop_y Index range on y axis to crop matrix
39  * \param len_key Packet length key for tagged stream
40  *
41  * \ingroup radar
42  *
43  */
44 class RADAR_API crop_matrix_vcvc : virtual public gr::tagged_stream_block
45 {
46 public:
47  typedef boost::shared_ptr<crop_matrix_vcvc> sptr;
48 
49  /*!
50  * \brief Return a shared_ptr to a new instance of radar::crop_matrix_vcvc.
51  *
52  * To avoid accidental use of raw pointers, radar::crop_matrix_vcvc's
53  * constructor is in a private implementation
54  * class. radar::crop_matrix_vcvc::make is the public interface for
55  * creating new instances.
56  */
57  static sptr make(int vlen,
58  std::vector<int> crop_x,
59  std::vector<int> crop_y,
60  std::string len_key = "packet_len");
61 };
62 
63 } // namespace radar
64 } // namespace gr
65 
66 #endif /* INCLUDED_RADAR_CROP_MATRIX_VCVC_H */
Definition: crop_matrix_vcvc.h:28
This matrix crops a data matrix. A tagged stream combined with vectors as items represent a matrix...
Definition: crop_matrix_vcvc.h:44
#define RADAR_API
Definition: api.h:31
boost::shared_ptr< crop_matrix_vcvc > sptr
Definition: crop_matrix_vcvc.h:47