GNU Radio Manual and C++ API Reference 3.10.4.0-rc1
The Free & Open Software Radio Ecosystem
time_sink_c.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2011-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_SINK_C_H
12#define INCLUDED_QTGUI_TIME_SINK_C_H
13
14#ifdef ENABLE_PYTHON
15#include <Python.h>
16#endif
17
18#include <gnuradio/qtgui/api.h>
20#include <gnuradio/sync_block.h>
21#include <qapplication.h>
22
23namespace gr {
24namespace qtgui {
25
26/*!
27 * \brief A graphical sink to display multiple signals in time.
28 * \ingroup instrumentation_blk
29 * \ingroup qtgui_blk
30 *
31 * \details
32 * This is a QT-based graphical sink the takes set of a complex
33 * streams and plots them in the time domain. For each signal, both
34 * the signal's I and Q parts are plotted, and they are all plotted
35 * with a different color, and the \a set_title and \a set_color
36 * functions can be used to change the label and color for a given
37 * input number.
38 *
39 * The sink supports plotting streaming complex data or
40 * messages. The message port is named "in". The two modes cannot
41 * be used simultaneously, and \p nconnections should be set to 0
42 * when using the message mode. GRC handles this issue by
43 * providing the "Complex Message" type that removes the streaming
44 * port(s).
45 *
46 * This sink can plot messages that contain either uniform vectors
47 * of complex 32 values (pmt::is_c32vector) or PDUs where the data
48 * is a uniform vector of complex 32 values.
49 */
50class QTGUI_API time_sink_c : virtual public sync_block
51{
52public:
53 // gr::qtgui::time_sink_c::sptr
54 typedef std::shared_ptr<time_sink_c> sptr;
55
56 /*!
57 * \brief Build complex time sink
58 *
59 * \param size number of points to plot at once
60 * \param samp_rate sample rate (used to set x-axis labels)
61 * \param name title for the plot
62 * \param nconnections number of signals connected to sink
63 * \param parent a QWidget parent object, if any
64 */
65 static sptr make(int size,
66 double samp_rate,
67 const std::string& name,
68 unsigned int nconnections = 1,
69 QWidget* parent = NULL);
70
71 virtual void exec_() = 0;
72 virtual QWidget* qwidget() = 0;
73
74 virtual void set_y_axis(double min, double max) = 0;
75 virtual void set_y_label(const std::string& label, const std::string& unit = "") = 0;
76 virtual void set_update_time(double t) = 0;
77 virtual void set_title(const std::string& title) = 0;
78 virtual void set_line_label(unsigned int which, const std::string& label) = 0;
79 virtual void set_line_color(unsigned int which, const std::string& color) = 0;
80 virtual void set_line_width(unsigned int which, int width) = 0;
81 virtual void set_line_style(unsigned int which, int style) = 0;
82 virtual void set_line_marker(unsigned int which, int marker) = 0;
83 virtual void set_nsamps(const int newsize) = 0;
84 virtual void set_samp_rate(const double samp_rate) = 0;
85 virtual void set_line_alpha(unsigned int which, double alpha) = 0;
86
87 /*!
88 * Set up a trigger for the sink to know when to start
89 * plotting. Useful to isolate events and avoid noise.
90 *
91 * The trigger modes are Free, Auto, Normal, and Tag (see
92 * gr::qtgui::trigger_mode). The first three are like a normal
93 * oscope trigger function. Free means free running with no
94 * trigger, auto will trigger if the trigger event is seen, but
95 * will still plot otherwise, and normal will hold until the
96 * trigger event is observed. The Tag trigger mode allows us to
97 * trigger off a specific stream tag. The tag trigger is based
98 * only on the name of the tag, so when a tag of the given name
99 * is seen, the trigger is activated.
100 *
101 * In auto and normal mode, we look for the slope of the of the
102 * signal. Given a gr::qtgui::trigger_slope as either Positive
103 * or Negative, if the value between two samples moves in the
104 * given direction (x[1] > x[0] for Positive or x[1] < x[0] for
105 * Negative), then the trigger is activated.
106 *
107 * With the complex time sink, each input has two lines drawn
108 * for the real and imaginary parts of the signal. When
109 * selecting the \p channel value, channel 0 is the real signal
110 * and channel 1 is the imaginary signal. For more than 1 input
111 * stream, channel 2i is the real part of the ith input and
112 * channel (2i+1) is the imaginary part of the ith input
113 * channel.
114 *
115 * The \p delay value is specified in time based off the sample
116 * rate. If the sample rate of the block is set to 1, the delay
117 * is then also the sample number offset. This is the offset
118 * from the left-hand y-axis of the plot. It delays the signal
119 * to show the trigger event at the given delay along with some
120 * portion of the signal before the event. The delay must be
121 * within 0 - t_max where t_max is the maximum amount of time
122 * displayed on the time plot.
123 *
124 * \param mode The trigger_mode: free, auto, normal, or tag.
125 * \param slope The trigger_slope: positive or negative. Only
126 * used for auto and normal modes.
127 * \param level The magnitude of the trigger even for auto or normal modes.
128 * \param delay The delay (in units of time) for where the trigger happens.
129 * \param channel Which input channel to use for the trigger events.
130 * \param tag_key The name (as a string) of the tag to trigger off
131 * of if using the tag mode.
132 */
134 trigger_slope slope,
135 float level,
136 float delay,
137 int channel,
138 const std::string& tag_key = "") = 0;
139
140 virtual std::string title() = 0;
141 virtual std::string line_label(unsigned int which) = 0;
142 virtual std::string line_color(unsigned int which) = 0;
143 virtual int line_width(unsigned int which) = 0;
144 virtual int line_style(unsigned int which) = 0;
145 virtual int line_marker(unsigned int which) = 0;
146 virtual double line_alpha(unsigned int which) = 0;
147
148 virtual void set_size(int width, int height) = 0;
149
150 virtual void enable_menu(bool en = true) = 0;
151 virtual void enable_grid(bool en = true) = 0;
152 virtual void enable_autoscale(bool en = true) = 0;
153 virtual void enable_stem_plot(bool en = true) = 0;
154 virtual void enable_semilogx(bool en = true) = 0;
155 virtual void enable_semilogy(bool en = true) = 0;
156 virtual void enable_control_panel(bool en = true) = 0;
157 virtual void enable_tags(unsigned int which, bool en) = 0;
158 virtual void enable_tags(bool en) = 0;
159 virtual void enable_axis_labels(bool en = true) = 0;
160 virtual void disable_legend() = 0;
161
162 virtual int nsamps() const = 0;
163 virtual void reset() = 0;
164
165 QApplication* d_qApplication;
166};
167
168} /* namespace qtgui */
169} /* namespace gr */
170
171#endif /* INCLUDED_QTGUI_TIME_SINK_C_H */
A graphical sink to display multiple signals in time.
Definition: time_sink_c.h:51
virtual void set_line_style(unsigned int which, int style)=0
virtual int line_style(unsigned int which)=0
virtual void set_update_time(double t)=0
std::shared_ptr< time_sink_c > sptr
Definition: time_sink_c.h:54
virtual void enable_control_panel(bool en=true)=0
virtual void disable_legend()=0
virtual void set_y_axis(double min, double max)=0
virtual void set_nsamps(const int newsize)=0
virtual std::string line_label(unsigned int which)=0
virtual void set_line_marker(unsigned int which, int marker)=0
virtual void set_title(const std::string &title)=0
virtual std::string title()=0
virtual double line_alpha(unsigned int which)=0
virtual void set_line_alpha(unsigned int which, double alpha)=0
virtual int line_width(unsigned int which)=0
virtual std::string line_color(unsigned int which)=0
virtual void enable_autoscale(bool en=true)=0
virtual void enable_menu(bool en=true)=0
static sptr make(int size, double samp_rate, const std::string &name, unsigned int nconnections=1, QWidget *parent=NULL)
Build complex time sink.
virtual void enable_tags(unsigned int which, bool en)=0
virtual void exec_()=0
virtual void set_size(int width, int height)=0
virtual int line_marker(unsigned int which)=0
virtual void set_line_width(unsigned int which, int width)=0
virtual void reset()=0
virtual void enable_semilogx(bool en=true)=0
virtual void set_y_label(const std::string &label, const std::string &unit="")=0
virtual void set_line_color(unsigned int which, const std::string &color)=0
virtual void enable_grid(bool en=true)=0
virtual void enable_stem_plot(bool en=true)=0
virtual void enable_axis_labels(bool en=true)=0
virtual void set_line_label(unsigned int which, const std::string &label)=0
virtual void set_trigger_mode(trigger_mode mode, trigger_slope slope, float level, float delay, int channel, const std::string &tag_key="")=0
virtual void enable_tags(bool en)=0
virtual void enable_semilogy(bool en=true)=0
virtual void set_samp_rate(const double samp_rate)=0
QApplication * d_qApplication
Definition: time_sink_c.h:165
virtual QWidget * qwidget()=0
virtual int nsamps() const =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
trigger_mode
Definition: trigger_mode.h:17
trigger_slope
Definition: trigger_mode.h:24
float min(float a, float b)
GNU Radio logging wrapper.
Definition: basic_block.h:29