GNU Radio 3.7.3 C++ API
freq_sink_f.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012 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_FREQ_SINK_F_H
24 #define INCLUDED_QTGUI_FREQ_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 <gnuradio/filter/firdes.h>
34 
35 namespace gr {
36  namespace qtgui {
37 
38  /*!
39  * \brief A graphical sink to display multiple signals in frequency.
40  * \ingroup instrumentation_blk
41  * \ingroup qtgui_blk
42  *
43  * \details
44  * This is a QT-based graphical sink the takes set of a floating
45  * point streams and plots the PSD. Each signal is plotted with a
46  * different color, and the \a set_title and \a set_color
47  * functions can be used to change the lable and color for a given
48  * input number.
49  */
50  class QTGUI_API freq_sink_f : virtual public sync_block
51  {
52  public:
53  // gr::qtgui::freq_sink_f::sptr
55 
56  /*!
57  * \brief Build a floating point PSD sink.
58  *
59  * \param fftsize size of the FFT to compute and display
60  * \param wintype type of window to apply (see gnuradio/filter/firdes.h)
61  * \param fc center frequency of signal (use for x-axis labels)
62  * \param bw bandwidth of signal (used to set x-axis labels)
63  * \param name title for the plot
64  * \param nconnections number of signals connected to sink
65  * \param parent a QWidget parent object, if any
66  */
67  static sptr make(int fftsize, int wintype,
68  double fc, double bw,
69  const std::string &name,
70  int nconnections=1,
71  QWidget *parent=NULL);
72 
73  virtual void exec_() = 0;
74 
75 #ifdef ENABLE_PYTHON
76  virtual PyObject* pyqwidget() = 0;
77 #endif
78 
79  virtual void set_fft_size(const int fftsize) = 0;
80  virtual int fft_size() const = 0;
81  virtual void set_fft_average(const float fftavg) = 0;
82  virtual float fft_average() const = 0;
83  virtual void set_fft_window(const gr::filter::firdes::win_type win) = 0;
84  virtual gr::filter::firdes::win_type fft_window() = 0;
85 
86  virtual void set_frequency_range(const double centerfreq, const double bandwidth) = 0;
87  virtual void set_y_axis(double min, double max) = 0;
88 
89  virtual void set_update_time(double t) = 0;
90  virtual void set_title(const std::string &title) = 0;
91  virtual void set_line_label(int which, const std::string &label) = 0;
92  virtual void set_line_color(int which, const std::string &color) = 0;
93  virtual void set_line_width(int which, int width) = 0;
94  virtual void set_line_style(int which, int style) = 0;
95  virtual void set_line_marker(int which, int marker) = 0;
96  virtual void set_line_alpha(int which, double alpha) = 0;
97 
98  virtual std::string title() = 0;
99  virtual std::string line_label(int which) = 0;
100  virtual std::string line_color(int which) = 0;
101  virtual int line_width(int which) = 0;
102  virtual int line_style(int which) = 0;
103  virtual int line_marker(int which) = 0;
104  virtual double line_alpha(int which) = 0;
105 
106  virtual void set_size(int width, int height) = 0;
107 
108  virtual void enable_menu(bool en=true) = 0;
109  virtual void enable_grid(bool en=true) = 0;
110  virtual void enable_autoscale(bool en=true) = 0;
111  virtual void reset() = 0;
112 
113  QApplication *d_qApplication;
114  };
115 
116  } /* namespace qtgui */
117 } /* namespace gr */
118 
119 #endif /* INCLUDED_QTGUI_FREQ_SINK_F_H */
float min(float a, float b)
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:30
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
QApplication * d_qApplication
Definition: freq_sink_f.h:113
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
A graphical sink to display multiple signals in frequency.
Definition: freq_sink_f.h:50
VOLK_API $kern pname $kern name
A function pointer to the dispatcher implementation.
boost::shared_ptr< freq_sink_f > sptr
Definition: freq_sink_f.h:54
win_type
Definition: firdes.h:45