GNU Radio Radar Toolbox
qtgui_spectrogram_plot.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_QTGUI_SPECTROGRAM_PLOT_H
23 #define INCLUDED_RADAR_QTGUI_SPECTROGRAM_PLOT_H
24 
25 #include <radar/api.h>
26 #include <gnuradio/tagged_stream_block.h>
27 
28 namespace gr {
29  namespace radar {
30 
31  /*!
32  * \brief This block displays a spectrogram plot of a tagged stream with vectors. Tagged streams combined with vectors represent a matrix. The value of the matrix elements are displayed within a color plot. The colorbar can be scaled automatically or with a manual scale with axis_z. The axis of x and y are set with axis_x and axis_y. The update rate interval is given in milliseconds.
33  *
34  * \param vlen Vector length
35  * \param xlabel Label for x axis
36  * \param ylabel Label for y axis
37  * \param label Addition label for title
38  * \param axis_x Display range for x axis
39  * \param axis_y Display range for y axis
40  * \param axis_z Display range for z axis. This defines the colorbar if autoscale_z is disabled.
41  * \param autoscale_z Toggle automatic scale of the colorbar
42  * \param packet_len Packet length key for tagged stream
43  *
44  * \ingroup radar
45  *
46  */
47  class RADAR_API qtgui_spectrogram_plot : virtual public gr::tagged_stream_block
48  {
49  public:
50  typedef boost::shared_ptr<qtgui_spectrogram_plot> sptr;
51 
52  /*!
53  * \brief Return a shared_ptr to a new instance of radar::qtgui_spectrogram_plot.
54  *
55  * To avoid accidental use of raw pointers, radar::qtgui_spectrogram_plot's
56  * constructor is in a private implementation
57  * class. radar::qtgui_spectrogram_plot::make is the public interface for
58  * creating new instances.
59  */
60  static sptr make(int vlen, int interval, std::string xlabel, std::string ylabel, std::string label, std::vector<float> axis_x, std::vector<float> axis_y, std::vector<float> axis_z, bool autoscale_z, std::string len_key="packet_len");
61  };
62 
63  } // namespace radar
64 } // namespace gr
65 
66 #endif /* INCLUDED_RADAR_QTGUI_SPECTROGRAM_PLOT_H */
67 
boost::shared_ptr< qtgui_spectrogram_plot > sptr
Definition: qtgui_spectrogram_plot.h:50
This block displays a spectrogram plot of a tagged stream with vectors. Tagged streams combined with ...
Definition: qtgui_spectrogram_plot.h:47
Definition: crop_matrix_vcvc.h:28
#define RADAR_API
Definition: api.h:30