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