GNU Radio Manual and C++ API Reference 3.10.4.0
The Free & Open Software Radio Ecosystem
time_raster_sink_b.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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_QTGUI_TIME_RASTER_SINK_B_H
12#define INCLUDED_QTGUI_TIME_RASTER_SINK_B_H
13
14#ifdef ENABLE_PYTHON
15#include <Python.h>
16#endif
17
18#include <gnuradio/qtgui/api.h>
19#include <gnuradio/sync_block.h>
20#include <qapplication.h>
21#include <qwt_symbol.h>
22
23namespace gr {
24namespace qtgui {
25
26/*!
27 * \brief A graphical sink to display multiple signals on a
28 * time_raster plot.
29 * \ingroup instrumentation_blk
30 * \ingroup qtgui_blk
31 *
32 * \details
33 * This is a QT-based graphical sink that takes in byte
34 * streams and plots a time_raster (spectrogram) plot.
35 *
36 * Input stream: This expects a bit stream (0, 1 in the LSB of a
37 * byte). It will display packed bytes but the display will have
38 * to be autoscaled.
39 *
40 * The sink supports plotting streaming byte/char data or
41 * messages. The message port is named "in". The two modes cannot
42 * be used simultaneously, and \p nconnections should be set to 0
43 * when using the message mode. GRC handles this issue by
44 * providing the "Float Message" type that removes the streaming
45 * port(s).
46 *
47 * This sink can plot messages that contain either uniform vectors
48 * of byte/char values (pmt::is_{u,s}32vector) or PDUs where the
49 * data is a uniform vector of byte/char values.
50 */
52{
53public:
54 // gr::qtgui::time_raster_sink_b::sptr
55 typedef std::shared_ptr<time_raster_sink_b> sptr;
56
57 /*!
58 * \brief Build a bit time raster sink.
59 *
60 * \param samp_rate sample rate of signal
61 * \param cols number of cols to plot
62 * \param rows number of rows to plot
63 * \param mult vector of floats as a scaling multiplier for each input stream
64 * \param offset vector of floats as an offset for each input stream
65 * \param name title for the plot
66 * \param nconnections number of streams connected
67 * \param parent a QWidget parent object, if any
68 */
69 static sptr make(double samp_rate,
70 double rows,
71 double cols,
72 const std::vector<float>& mult,
73 const std::vector<float>& offset,
74 const std::string& name,
75 int nconnections = 1,
76 QWidget* parent = NULL);
77
78 virtual void exec_() = 0;
79 virtual QWidget* qwidget() = 0;
80
81 virtual void set_x_label(const std::string& label) = 0;
82 virtual void set_x_range(double start, double end) = 0;
83 virtual void set_y_label(const std::string& label) = 0;
84 virtual void set_y_range(double start, double end) = 0;
85 virtual void set_update_time(double t) = 0;
86 virtual void set_title(const std::string& title) = 0;
87 virtual void set_line_label(unsigned int which, const std::string& label) = 0;
88 virtual void set_line_color(unsigned int which, const std::string& color) = 0;
89 virtual void set_line_width(unsigned int which, int width) = 0;
90 virtual void set_line_style(unsigned int which, Qt::PenStyle style) = 0;
91 virtual void set_line_marker(unsigned int which, QwtSymbol::Style marker) = 0;
92 virtual void set_line_alpha(unsigned int which, double alpha) = 0;
93 virtual void set_color_map(unsigned int which, const int color) = 0;
94
95 virtual std::string title() = 0;
96 virtual std::string line_label(unsigned int which) = 0;
97 virtual std::string line_color(unsigned int which) = 0;
98 virtual int line_width(unsigned int which) = 0;
99 virtual int line_style(unsigned int which) = 0;
100 virtual int line_marker(unsigned int which) = 0;
101 virtual double line_alpha(unsigned int which) = 0;
102 virtual int color_map(unsigned int which) = 0;
103
104 virtual void set_size(int width, int height) = 0;
105
106 virtual void set_samp_rate(const double samp_rate) = 0;
107 virtual void set_num_rows(double rows) = 0;
108 virtual void set_num_cols(double cols) = 0;
109
110 virtual double num_rows() = 0;
111 virtual double num_cols() = 0;
112
113 virtual void set_multiplier(const std::vector<float>& mult) = 0;
114 virtual void set_offset(const std::vector<float>& offset) = 0;
115
116 virtual void set_intensity_range(float min, float max) = 0;
117
118 virtual void enable_menu(bool en) = 0;
119 virtual void enable_grid(bool en) = 0;
120 virtual void enable_autoscale(bool en) = 0;
121 virtual void enable_axis_labels(bool en = true) = 0;
122 virtual void reset() = 0;
123
124 QApplication* d_qApplication;
125};
126
127} /* namespace qtgui */
128} /* namespace gr */
129
130#endif /* INCLUDED_QTGUI_TIME_RASTER_SINK_B_H */
A graphical sink to display multiple signals on a time_raster plot.
Definition: time_raster_sink_b.h:52
virtual void set_size(int width, int height)=0
virtual void set_title(const std::string &title)=0
virtual double num_cols()=0
virtual int line_marker(unsigned int which)=0
virtual void set_line_label(unsigned int which, const std::string &label)=0
virtual std::string line_color(unsigned int which)=0
virtual void set_multiplier(const std::vector< float > &mult)=0
virtual void set_intensity_range(float min, float max)=0
virtual void set_x_label(const std::string &label)=0
virtual int line_style(unsigned int which)=0
virtual std::string line_label(unsigned int which)=0
virtual int line_width(unsigned int which)=0
virtual void enable_grid(bool en)=0
virtual std::string title()=0
virtual void set_line_marker(unsigned int which, QwtSymbol::Style marker)=0
virtual void set_samp_rate(const double samp_rate)=0
virtual void set_offset(const std::vector< float > &offset)=0
virtual void enable_autoscale(bool en)=0
std::shared_ptr< time_raster_sink_b > sptr
Definition: time_raster_sink_b.h:55
virtual int color_map(unsigned int which)=0
virtual void set_num_rows(double rows)=0
virtual void enable_axis_labels(bool en=true)=0
virtual QWidget * qwidget()=0
virtual void set_x_range(double start, double end)=0
virtual void set_line_style(unsigned int which, Qt::PenStyle style)=0
virtual void enable_menu(bool en)=0
static sptr make(double samp_rate, double rows, double cols, const std::vector< float > &mult, const std::vector< float > &offset, const std::string &name, int nconnections=1, QWidget *parent=NULL)
Build a bit time raster sink.
virtual void set_color_map(unsigned int which, const int color)=0
QApplication * d_qApplication
Definition: time_raster_sink_b.h:124
virtual void set_y_label(const std::string &label)=0
virtual void set_line_width(unsigned int which, int width)=0
virtual void set_num_cols(double cols)=0
virtual void set_line_alpha(unsigned int which, double alpha)=0
virtual void set_line_color(unsigned int which, const std::string &color)=0
virtual void set_y_range(double start, double end)=0
virtual void set_update_time(double t)=0
virtual double num_rows()=0
virtual double line_alpha(unsigned int which)=0
synchronous 1:1 input to output with history
Definition: sync_block.h:26
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:18
float min(float a, float b)
GNU Radio logging wrapper.
Definition: basic_block.h:29