Loading...
Searching...
No Matches
histogram_sink_f.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2013,2015 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_QTGUI_HISTOGRAM_SINK_F_H
#define INCLUDED_QTGUI_HISTOGRAM_SINK_F_H
#include <gnuradio/qtgui/api.h>
#include <gnuradio/sync_block.h>
#include <qapplication.h>
namespace gr {
namespace qtgui {
/*!
* \brief A graphical sink to display a histogram.
* \ingroup instrumentation_blk
* \ingroup qtgui_blk
*
* \details
* This is a QT-based graphical sink the displays a histogram of
* the data.
*
* This histogram allows you to set and change at runtime the
* number of points to plot at once and the number of bins in the
* histogram. Both x and y-axis have their own auto-scaling
* behavior. By default, auto-scaling the y-axis is turned on and
* continuously updates the y-axis max value based on the
* currently plotted histogram.
*
* The x-axis auto-scaling function only updates once when
* clicked. This resets the x-axis to the current range of minimum
* and maximum values represented in the histogram. It resets any
* values currently displayed because the location and width of
* the bins may have changed.
*
* The histogram also has an accumulate function that simply
* accumulates the data between calls to work. When accumulate is
* activated, the y-axis autoscaling is turned on by default as
* the values will quickly grow in the this direction.
*
* The sink supports plotting streaming float data or
* messages. The message port is named "in". The two modes cannot
* be used simultaneously, and \p nconnections should be set to 0
* when using the message mode. GRC handles this issue by
* providing the "Float Message" type that removes the streaming
* port(s).
*
* This sink can plot messages that contain either uniform vectors
* of float 32 values (pmt::is_f32vector) or PDUs where the data
* is a uniform vector of float 32 values.
*/
class QTGUI_API histogram_sink_f : virtual public sync_block
{
public:
// gr::qtgui::histogram_sink_f::sptr
typedef std::shared_ptr<histogram_sink_f> sptr;
/*!
* \brief Build floating point histogram sink
*
* \param size number of points to plot at once
* \param bins number of bins to sort the data into
* \param xmin minimum x-axis value
* \param xmax maximum x-axis value
* \param name title for the plot
* \param nconnections number of signals connected to sink
* \param parent a QWidget parent object, if any
*/
static sptr make(int size,
int bins,
double xmin,
double xmax,
const std::string& name,
int nconnections = 1,
QWidget* parent = NULL);
virtual void exec_() = 0;
virtual QWidget* qwidget() = 0;
public:
virtual std::string title() = 0;
virtual std::string line_label(unsigned int which) = 0;
virtual std::string line_color(unsigned int which) = 0;
virtual int line_width(unsigned int which) = 0;
virtual int line_style(unsigned int which) = 0;
virtual int line_marker(unsigned int which) = 0;
virtual double line_alpha(unsigned int which) = 0;
virtual void set_size(int width, int height) = 0;
virtual void enable_menu(bool en = true) = 0;
virtual void enable_grid(bool en = true) = 0;
virtual void enable_autoscale(bool en = true) = 0;
virtual void enable_semilogx(bool en = true) = 0;
virtual void enable_semilogy(bool en = true) = 0;
virtual void enable_accumulate(bool en = true) = 0;
virtual void enable_axis_labels(bool en = true) = 0;
virtual void autoscalex() = 0;
virtual int nsamps() const = 0;
virtual int bins() const = 0;
virtual void reset() = 0;
QApplication* d_qApplication;
virtual void set_y_axis(double min, double max) = 0;
virtual void set_x_axis(double min, double max) = 0;
virtual void set_update_time(double t) = 0;
virtual void set_title(const std::string& title) = 0;
virtual void set_line_label(unsigned int which, const std::string& line) = 0;
virtual void set_line_color(unsigned int which, const std::string& color) = 0;
virtual void set_line_width(unsigned int which, int width) = 0;
virtual void set_line_style(unsigned int which, int style) = 0;
virtual void set_line_marker(unsigned int which, int marker) = 0;
virtual void set_line_alpha(unsigned int which, double alpha) = 0;
virtual void set_nsamps(const int newsize) = 0;
virtual void set_bins(const int bins) = 0;
virtual void disable_legend() = 0;
};
} /* namespace qtgui */
} /* namespace gr */
#endif /* INCLUDED_QTGUI_HISTOGRAM_SINK_F_H */
gr::basic_block::color
vcolor color() const
Definition basic_block.h:122
gr::basic_block::name
std::string name() const
Definition basic_block.h:168
gr::qtgui::histogram_sink_f
A graphical sink to display a histogram.
Definition histogram_sink_f.h:60
gr::qtgui::histogram_sink_f::set_line_alpha
virtual void set_line_alpha(unsigned int which, double alpha)=0
gr::qtgui::histogram_sink_f::enable_axis_labels
virtual void enable_axis_labels(bool en=true)=0
gr::qtgui::histogram_sink_f::enable_menu
virtual void enable_menu(bool en=true)=0
gr::qtgui::histogram_sink_f::enable_accumulate
virtual void enable_accumulate(bool en=true)=0
gr::qtgui::histogram_sink_f::qwidget
virtual QWidget * qwidget()=0
gr::qtgui::histogram_sink_f::exec_
virtual void exec_()=0
gr::qtgui::histogram_sink_f::sptr
std::shared_ptr< histogram_sink_f > sptr
Definition histogram_sink_f.h:63
gr::qtgui::histogram_sink_f::line_style
virtual int line_style(unsigned int which)=0
gr::qtgui::histogram_sink_f::set_y_axis
virtual void set_y_axis(double min, double max)=0
gr::qtgui::histogram_sink_f::disable_legend
virtual void disable_legend()=0
gr::qtgui::histogram_sink_f::line_width
virtual int line_width(unsigned int which)=0
gr::qtgui::histogram_sink_f::line_alpha
virtual double line_alpha(unsigned int which)=0
gr::qtgui::histogram_sink_f::title
virtual std::string title()=0
gr::qtgui::histogram_sink_f::set_line_label
virtual void set_line_label(unsigned int which, const std::string &line)=0
gr::qtgui::histogram_sink_f::d_qApplication
QApplication * d_qApplication
Definition histogram_sink_f.h:110
gr::qtgui::histogram_sink_f::line_label
virtual std::string line_label(unsigned int which)=0
gr::qtgui::histogram_sink_f::autoscalex
virtual void autoscalex()=0
gr::qtgui::histogram_sink_f::enable_autoscale
virtual void enable_autoscale(bool en=true)=0
gr::qtgui::histogram_sink_f::set_line_marker
virtual void set_line_marker(unsigned int which, int marker)=0
gr::qtgui::histogram_sink_f::set_line_style
virtual void set_line_style(unsigned int which, int style)=0
gr::qtgui::histogram_sink_f::line_color
virtual std::string line_color(unsigned int which)=0
gr::qtgui::histogram_sink_f::reset
virtual void reset()=0
gr::qtgui::histogram_sink_f::set_update_time
virtual void set_update_time(double t)=0
gr::qtgui::histogram_sink_f::enable_semilogx
virtual void enable_semilogx(bool en=true)=0
gr::qtgui::histogram_sink_f::set_x_axis
virtual void set_x_axis(double min, double max)=0
gr::qtgui::histogram_sink_f::set_nsamps
virtual void set_nsamps(const int newsize)=0
gr::qtgui::histogram_sink_f::nsamps
virtual int nsamps() const =0
gr::qtgui::histogram_sink_f::enable_semilogy
virtual void enable_semilogy(bool en=true)=0
gr::qtgui::histogram_sink_f::set_bins
virtual void set_bins(const int bins)=0
gr::qtgui::histogram_sink_f::make
static sptr make(int size, int bins, double xmin, double xmax, const std::string &name, int nconnections=1, QWidget *parent=NULL)
Build floating point histogram sink.
gr::qtgui::histogram_sink_f::set_line_color
virtual void set_line_color(unsigned int which, const std::string &color)=0
gr::qtgui::histogram_sink_f::enable_grid
virtual void enable_grid(bool en=true)=0
gr::qtgui::histogram_sink_f::line_marker
virtual int line_marker(unsigned int which)=0
gr::qtgui::histogram_sink_f::bins
virtual int bins() const =0
gr::qtgui::histogram_sink_f::set_size
virtual void set_size(int width, int height)=0
gr::qtgui::histogram_sink_f::set_title
virtual void set_title(const std::string &title)=0
gr::qtgui::histogram_sink_f::set_line_width
virtual void set_line_width(unsigned int which, int width)=0
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
QTGUI_API
#define QTGUI_API
Definition gr-qtgui/include/gnuradio/qtgui/api.h:18
gr::qtgui
Definition ber_sink_b.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h