GNU Radio Manual and C++ API Reference  3.9.4.0
The Free & Open Software Radio Ecosystem
eye_sink_f.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_F_H
11 #define INCLUDED_QTGUI_EYE_SINK_F_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 namespace gr {
22 namespace qtgui {
23 
24 /*!
25  * \brief A graphical sink to display signals eye patterns.
26  * \ingroup qtgui
27  *
28  * \details
29  * This is a QT-based graphical sink which takes set of a float streams
30  * and plots them as eye patterns. For each signal, both
31  * the signal's I and Q eye patterns are plotted. Eye patterns are
32  * 2 symbol's time long. Symbol rate must be an integer multiple of
33  * the sample rate to obtain the eye pattern.
34  *
35  * Trigger occurs at the beginning of each stream used to plot the
36  * eye pattern; whilst a real eye diagram would be triggered with
37  * a (recovered) symbol clock. For these reasons, triggering of
38  * noisy and/or unsynchronized signals may lead to incorrect eye
39  * pattern.
40  *
41  * The sink supports plotting streaming float data or
42  * messages. The message port is named "in". The two modes cannot
43  * be used simultaneously, and \p nconnections should be set to 0
44  * when using the message mode. GRC handles this issue by
45  * providing the "Float Message" type that removes the streaming
46  * port(s).
47  *
48  * This sink can plot messages that contain either uniform vectors
49  * of float 32 values (pmt::is_f32vector) or PDUs where the data
50  * is a uniform vector of float 32 values.
51  */
52 
53 class QTGUI_API eye_sink_f : virtual public gr::sync_block
54 {
55 public:
56  // gr::qtgui::eye_sink_f::sptr
57  typedef std::shared_ptr<eye_sink_f> sptr;
58 
59  /*!
60  * \brief Build floating point 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& line) = 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  * The \p delay value is specified in time based off the sample
109  * rate. If the sample rate of the block is set to 1, the delay
110  * is then also the sample number offset. This is the offset
111  * from the left-hand y-axis of the plot. It delays the signal
112  * to show the trigger event at the given delay along with some
113  * portion of the signal before the event. The delay must be
114  * within 0 - t_max where t_max is the maximum amount of time
115  * displayed on the eye pattern equal to 2 symbol time.
116  *
117  * \param mode The trigger_mode: free, auto, normal, or tag.
118  * \param slope The trigger_slope: positive or negative. Only
119  * used for auto and normal modes.
120  * \param level The magnitude of the trigger even for auto or normal modes.
121  * \param delay The delay (in units of time) for where the trigger happens.
122  * \param channel Which input channel to use for the trigger events.
123  * \param tag_key The name (as a string) of the tag to trigger off
124  * of if using the tag mode.
125  */
128  float level,
129  float delay,
130  int channel,
131  const std::string& tag_key = "") = 0;
132 
133  virtual std::string title() = 0;
134  virtual std::string line_label(unsigned int which) = 0;
135  virtual std::string line_color(unsigned int which) = 0;
136  virtual int line_width(unsigned int which) = 0;
137  virtual int line_style(unsigned int which) = 0;
138  virtual int line_marker(unsigned int which) = 0;
139  virtual double line_alpha(unsigned int which) = 0;
140 
141  virtual void set_size(int width, int height) = 0;
142 
143  virtual void enable_menu(bool en = true) = 0;
144  virtual void enable_grid(bool en = true) = 0;
145  virtual void enable_autoscale(bool en = true) = 0;
146  virtual void
147  enable_stem_plot(bool en = true) = 0; // Used by parent class, do not remove
148  virtual void
149  enable_semilogx(bool en = true) = 0; // Used by parent class, do not remove
150  virtual void
151  enable_semilogy(bool en = true) = 0; // Used by parent class, do not remove
152  virtual void enable_control_panel(bool en = true) = 0;
153  virtual void enable_tags(unsigned int which, bool en) = 0;
154  virtual void enable_tags(bool en) = 0;
155  virtual void enable_axis_labels(bool en = true) = 0;
156  virtual void disable_legend() = 0;
157 
158  virtual int nsamps() const = 0;
159  virtual void reset() = 0;
160 
161  QApplication* d_qApplication;
162 };
163 } // namespace qtgui
164 } // namespace gr
165 
166 #endif /* INCLUDED_QTGUI_EYE_SINK_F_H */
A graphical sink to display signals eye patterns.
Definition: eye_sink_f.h:54
virtual void set_line_width(unsigned int which, int width)=0
virtual void set_samp_rate(const double samp_rate)=0
virtual void enable_tags(unsigned int which, bool en)=0
virtual void set_line_label(unsigned int which, const std::string &line)=0
virtual void reset()=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 void set_line_marker(unsigned int which, int marker)=0
virtual void exec_()=0
virtual QWidget * qwidget()=0
virtual void set_nsamps(const int newsize)=0
virtual void set_size(int width, int height)=0
virtual void set_line_color(unsigned int which, const std::string &color)=0
virtual int nsamps() const =0
virtual void set_samp_per_symbol(unsigned int sps)=0
virtual void enable_axis_labels(bool en=true)=0
virtual void enable_tags(bool en)=0
virtual std::string line_label(unsigned int which)=0
virtual void enable_semilogy(bool en=true)=0
virtual void disable_legend()=0
std::shared_ptr< eye_sink_f > sptr
Definition: eye_sink_f.h:57
virtual void set_update_time(double t)=0
virtual void enable_semilogx(bool en=true)=0
virtual void enable_menu(bool en=true)=0
virtual std::string title()=0
virtual void enable_control_panel(bool en=true)=0
virtual std::string line_color(unsigned int which)=0
virtual void enable_grid(bool en=true)=0
virtual double line_alpha(unsigned int which)=0
static sptr make(int size, double samp_rate, unsigned int nconnections=1, QWidget *parent=NULL)
Build floating point eye sink.
virtual int line_style(unsigned int which)=0
virtual int line_width(unsigned int which)=0
virtual void set_y_label(const std::string &label, const std::string &unit="")=0
QApplication * d_qApplication
Definition: eye_sink_f.h:161
virtual void set_y_axis(double min, double max)=0
virtual void enable_autoscale(bool en=true)=0
virtual int line_marker(unsigned int which)=0
virtual void enable_stem_plot(bool en=true)=0
virtual void set_line_alpha(unsigned int which, double alpha)=0
virtual void set_line_style(unsigned int which, int style)=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