GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
time_raster_sink_f.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012,2013,2015 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_QTGUI_TIME_RASTER_SINK_F_H
24 #define INCLUDED_QTGUI_TIME_RASTER_SINK_F_H
25 
26 #ifdef ENABLE_PYTHON
27 #include <Python.h>
28 #endif
29 
30 #include <gnuradio/qtgui/api.h>
31 #include <gnuradio/sync_block.h>
32 #include <qapplication.h>
33 #include <qwt_symbol.h>
34 
35 namespace gr {
36  namespace qtgui {
37 
38  /*!
39  * \brief A graphical sink to display multiple signals on a
40  * time_raster plot.
41  * \ingroup instrumentation_blk
42  * \ingroup qtgui_blk
43  *
44  * \details
45  * This is a QT-based graphical sink that takes set of a floating
46  * point streams and plots a time_raster (spectrogram) plot.
47  *
48  * The sink supports plotting streaming float data or
49  * messages. The message port is named "in". The two modes cannot
50  * be used simultaneously, and \p nconnections should be set to 0
51  * when using the message mode. GRC handles this issue by
52  * providing the "Float Message" type that removes the streaming
53  * port(s).
54  *
55  * This sink can plot messages that contain either uniform vectors
56  * of float 32 values (pmt::is_f32vector) or PDUs where the data
57  * is a uniform vector of float 32 values.
58  */
59  class QTGUI_API time_raster_sink_f : virtual public sync_block
60  {
61  public:
62  // gr::qtgui::time_raster_sink_f::sptr
63  typedef boost::shared_ptr<time_raster_sink_f> sptr;
64 
65  /*!
66  * \brief Build a floating point time raster sink.
67  *
68  * \param samp_rate sample rate of signal
69  * \param cols number of cols to plot
70  * \param rows number of rows to plot
71  * \param mult vector of floats as a scaling multiplier for each input stream
72  * \param offset vector of floats as an offset for each input stream
73  * \param name title for the plot
74  * \param nconnections number of streams connected
75  * \param parent a QWidget parent object, if any
76  */
77  static sptr make(double samp_rate,
78  double rows, double cols,
79  const std::vector<float> &mult,
80  const std::vector<float> &offset,
81  const std::string &name,
82  int nconnections=1,
83  QWidget *parent=NULL);
84 
85  virtual void exec_() = 0;
86  virtual QWidget* qwidget() = 0;
87 
88 #ifdef ENABLE_PYTHON
89  virtual PyObject* pyqwidget() = 0;
90 #else
91  virtual void* pyqwidget() = 0;
92 #endif
93 
94  virtual void set_update_time(double t) = 0;
95  virtual void set_title(const std::string &title) = 0;
96  virtual void set_line_label(int which, const std::string &lable) = 0;
97  virtual void set_line_color(int which, const std::string &color) = 0;
98  virtual void set_line_width(int which, int width) = 0;
99  virtual void set_line_style(int which, Qt::PenStyle style) = 0;
100  virtual void set_line_marker(int which, QwtSymbol::Style marker) = 0;
101  virtual void set_line_alpha(int which, double alpha) = 0;
102  virtual void set_color_map(int which, const int color) = 0;
103 
104  virtual std::string title() = 0;
105  virtual std::string line_label(int which) = 0;
106  virtual std::string line_color(int which) = 0;
107  virtual int line_width(int which) = 0;
108  virtual int line_style(int which) = 0;
109  virtual int line_marker(int which) = 0;
110  virtual double line_alpha(int which) = 0;
111  virtual int color_map(int which) = 0;
112 
113  virtual void set_size(int width, int height) = 0;
114 
115  virtual void set_samp_rate(const double samp_rate) = 0;
116  virtual void set_num_rows(double rows) = 0;
117  virtual void set_num_cols(double cols) = 0;
118 
119  virtual double num_rows() = 0;
120  virtual double num_cols() = 0;
121 
122  virtual void set_multiplier(const std::vector<float> &mult) = 0;
123  virtual void set_offset(const std::vector<float> &offset) = 0;
124 
125  virtual void set_intensity_range(float min, float max) = 0;
126 
127  virtual void enable_menu(bool en) = 0;
128  virtual void enable_grid(bool en) = 0;
129  virtual void enable_autoscale(bool en) = 0;
130  virtual void reset() = 0;
131 
132  QApplication *d_qApplication;
133  };
134 
135  } /* namespace qtgui */
136 } /* namespace gr */
137 
138 #endif /* INCLUDED_QTGUI_TIME_RASTER_SINK_F_H */
QApplication * d_qApplication
Definition: time_raster_sink_f.h:132
float min(float a, float b)
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:30
A graphical sink to display multiple signals on a time_raster plot.
Definition: time_raster_sink_f.h:59
Include this header to use the message passing features.
Definition: logger.h:131
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
boost::shared_ptr< time_raster_sink_f > sptr
Definition: time_raster_sink_f.h:63