GNU Radio Radar Toolbox
 All Classes Namespaces Files Functions Variables Typedefs Macros
qtgui_scatter_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_SCATTER_PLOT_H
23 #define INCLUDED_RADAR_QTGUI_SCATTER_PLOT_H
24 
25 #include <radar/api.h>
26 #include <gnuradio/block.h>
27 
28 namespace gr {
29  namespace radar {
30 
31  /*!
32  * \brief This block displays a scatter plot of two data sets. The identifiers (symbols) are given with label_x and label_y. The display range is given with axis_x and axis_y. Points that are not in range are simply not displayed (there are no errors or warnings). label gives an additional lable to differ multiple scatter plots on the screen by the titles. The update interval is given in milliseconds.
33  *
34  * \param interval Update interval in milliseconds
35  * \param label_x Identifier (symbol) of first data set
36  * \param label_y Identifier (symbol) of second data set
37  * \param axis_x Display range on x axis
38  * \param axis_y Display range on y axis
39  * \param label Optional label for the title
40  *
41  * \ingroup radar
42  *
43  */
44  class RADAR_API qtgui_scatter_plot : virtual public gr::block
45  {
46  public:
47  typedef boost::shared_ptr<qtgui_scatter_plot> sptr;
48 
49  /*!
50  * \brief Return a shared_ptr to a new instance of radar::qtgui_scatter_plot.
51  *
52  * To avoid accidental use of raw pointers, radar::qtgui_scatter_plot's
53  * constructor is in a private implementation
54  * class. radar::qtgui_scatter_plot::make is the public interface for
55  * creating new instances.
56  */
57  static sptr make(int interval, std::string label_x, std::string label_y, std::vector<float> axis_x, std::vector<float> axis_y, std::string label="");
58  };
59 
60  } // namespace radar
61 } // namespace gr
62 
63 #endif /* INCLUDED_RADAR_QTGUI_SCATTER_PLOT_H */
64 
This block displays a scatter plot of two data sets. The identifiers (symbols) are given with label_x...
Definition: qtgui_scatter_plot.h:44
boost::shared_ptr< qtgui_scatter_plot > sptr
Definition: qtgui_scatter_plot.h:47
#define RADAR_API
Definition: api.h:30