GNU Radio 3.7.2.1-77 C++ API
histogram_sink_f.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2013 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_HISTOGRAM_SINK_F_H
24
#define INCLUDED_QTGUI_HISTOGRAM_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
34
namespace
gr {
35
namespace
qtgui {
36
37
/*!
38
* \brief A graphical sink to display a histogram.
39
* \ingroup instrumentation_blk
40
* \ingroup qtgui_blk
41
*
42
* \details
43
* This is a QT-based graphical sink the displays a histogram of
44
* the data.
45
*
46
* This histogram allows you to set and change at runtime the
47
* number of points to plot at once and the number of bins in the
48
* histogram. Both x and y-axis have their own auto-scaling
49
* behavior. By default, auto-scaling the y-axis is turned on and
50
* continuously updates the y-axis max value based on the
51
* currently plotted histogram.
52
*
53
* The x-axis auto-scaling function only updates once when
54
* clicked. This resets the x-axis to the current range of minimum
55
* and maximum values represented in the histogram. It resets any
56
* values currently displayed because the location and width of
57
* the bins may have changed.
58
*
59
* The histogram also has an accumulate function that simply
60
* accumulates the data between calls to work. When accumulate is
61
* activated, the y-axis autoscaling is turned on by default as
62
* the values will quickly grow in the this direction.
63
*/
64
class
QTGUI_API
histogram_sink_f
:
virtual
public
sync_block
65
{
66
public
:
67
// gr::qtgui::histogram_sink_f::sptr
68
typedef
boost::shared_ptr<histogram_sink_f>
sptr
;
69
70
/*!
71
* \brief Build floating point histogram sink
72
*
73
* \param size number of points to plot at once
74
* \param bins number of bins to sort the data into
75
* \param xmin minimum x-axis value
76
* \param xmax maximum x-axis value
77
* \param name title for the plot
78
* \param nconnections number of signals connected to sink
79
* \param parent a QWidget parent object, if any
80
*/
81
static
sptr
make(
int
size,
int
bins,
82
double
xmin,
double
xmax,
83
const
std::string &name,
84
int
nconnections=1,
85
QWidget *parent=NULL);
86
87
virtual
void
exec_() = 0;
88
89
#ifdef ENABLE_PYTHON
90
virtual
PyObject* pyqwidget() = 0;
91
#endif
92
93
public
:
94
virtual
std::string title() = 0;
95
virtual
std::string line_label(
int
which) = 0;
96
virtual
std::string line_color(
int
which) = 0;
97
virtual
int
line_width(
int
which) = 0;
98
virtual
int
line_style(
int
which) = 0;
99
virtual
int
line_marker(
int
which) = 0;
100
virtual
double
line_alpha(
int
which) = 0;
101
102
virtual
void
set_size(
int
width,
int
height) = 0;
103
104
virtual
void
enable_menu(
bool
en=
true
) = 0;
105
virtual
void
enable_grid(
bool
en=
true
) = 0;
106
virtual
void
enable_autoscale(
bool
en=
true
) = 0;
107
virtual
void
enable_semilogx(
bool
en=
true
) = 0;
108
virtual
void
enable_semilogy(
bool
en=
true
) = 0;
109
virtual
void
enable_accumulate(
bool
en=
true
) = 0;
110
virtual
void
autoscalex() = 0;
111
virtual
int
nsamps()
const
= 0;
112
virtual
int
bins()
const
= 0;
113
virtual
void
reset() = 0;
114
115
QApplication *
d_qApplication
;
116
117
virtual
void
set_y_axis(
double
min
,
double
max) = 0;
118
virtual
void
set_x_axis(
double
min
,
double
max) = 0;
119
virtual
void
set_update_time(
double
t) = 0;
120
virtual
void
set_title(
const
std::string &title) = 0;
121
virtual
void
set_line_label(
int
which,
const
std::string &line) = 0;
122
virtual
void
set_line_color(
int
which,
const
std::string &color) = 0;
123
virtual
void
set_line_width(
int
which,
int
width) = 0;
124
virtual
void
set_line_style(
int
which,
int
style) = 0;
125
virtual
void
set_line_marker(
int
which,
int
marker) = 0;
126
virtual
void
set_line_alpha(
int
which,
double
alpha) = 0;
127
virtual
void
set_nsamps(
const
int
newsize) = 0;
128
virtual
void
set_bins(
const
int
bins) = 0;
129
};
130
131
}
/* namespace qtgui */
132
}
/* namespace gr */
133
134
#endif
/* INCLUDED_QTGUI_HISTOGRAM_SINK_F_H */
gnuradio
gr-qtgui
include
gnuradio
qtgui
histogram_sink_f.h
Generated by
1.8.3.1