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