gr::qtgui::waterfall_sink_f Class Reference

A graphical sink to display multiple signals on a waterfall (spectrogram) plot. More...

#include <gnuradio/qtgui/waterfall_sink_f.h>

Inheritance diagram for gr::qtgui::waterfall_sink_f:

Public Types
typedef boost::shared_ptr < waterfall_sink_f >	sptr
Public Types inherited from gr::block
enum	{ WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 }
	Magic return values from general_work. More...
enum	tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 }

Public Member Functions
virtual void	exec_ ()=0
virtual PyObject *	pyqwidget ()=0
virtual void	clear_data ()=0
virtual void	set_fft_size (const int fftsize)=0
virtual int	fft_size () const =0
virtual void	set_fft_average (const float fftavg)=0
virtual float	fft_average () const =0
virtual void	set_fft_window (const gr::filter::firdes::win_type win)=0
virtual gr::filter::firdes::win_type	fft_window ()=0
virtual void	set_frequency_range (const double centerfreq, const double bandwidth)=0
virtual void	set_intensity_range (const double min, const 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 (int which, const std::string &line)=0
virtual void	set_line_alpha (int which, double alpha)=0
virtual void	set_color_map (int which, const int color)=0
virtual std::string	title ()=0
virtual std::string	line_label (int which)=0
virtual double	line_alpha (int which)=0
virtual int	color_map (int which)=0
virtual void	set_size (int width, int height)=0
virtual void	auto_scale ()=0
virtual double	min_intensity (int which)=0
virtual double	max_intensity (int which)=0
virtual void	enable_menu (bool en=true)=0
virtual void	enable_grid (bool en=true)=0
Public Member Functions inherited from gr::sync_block
virtual int	work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0
	just like gr::block::general_work, only this arranges to call consume_each for you More...
void	forecast (int noutput_items, gr_vector_int &ninput_items_required)
	Estimate input requirements given output request. More...
int	general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
	compute output items from input items More...
int	fixed_rate_ninput_to_noutput (int ninput)
	Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...
int	fixed_rate_noutput_to_ninput (int noutput)
	Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...
Public Member Functions inherited from gr::block
virtual	~block ()
unsigned	history () const
void	set_history (unsigned history)
void	declare_sample_delay (int which, unsigned delay)
void	declare_sample_delay (unsigned delay)
unsigned	sample_delay (int which) const
bool	fixed_rate () const
	Return true if this block has a fixed input to output rate. More...
virtual bool	start ()
	Called to enable drivers, etc for i/o devices. More...
virtual bool	stop ()
	Called to disable drivers, etc for i/o devices. More...
void	set_output_multiple (int multiple)
	Constrain the noutput_items argument passed to forecast and general_work. More...
int	output_multiple () const
bool	output_multiple_set () const
void	set_alignment (int multiple)
	Constrains buffers to work on a set item alignment (for SIMD) More...
int	alignment () const
void	set_unaligned (int na)
int	unaligned () const
void	set_is_unaligned (bool u)
bool	is_unaligned () const
void	consume (int which_input, int how_many_items)
	Tell the scheduler how_many_items of input stream which_input were consumed. More...
void	consume_each (int how_many_items)
	Tell the scheduler how_many_items were consumed on each input stream. More...
void	produce (int which_output, int how_many_items)
	Tell the scheduler how_many_items were produced on output stream which_output. More...
void	set_relative_rate (double relative_rate)
	Set the approximate output rate / input rate. More...
double	relative_rate () const
	return the approximate output rate / input rate More...
uint64_t	nitems_read (unsigned int which_input)
	Return the number of items read on input stream which_input. More...
uint64_t	nitems_written (unsigned int which_output)
	Return the number of items written on output stream which_output. More...
tag_propagation_policy_t	tag_propagation_policy ()
	Asks for the policy used by the scheduler to moved tags downstream. More...
void	set_tag_propagation_policy (tag_propagation_policy_t p)
	Set the policy by the scheduler to determine how tags are moved downstream. More...
int	min_noutput_items () const
	Return the minimum number of output items this block can produce during a call to work. More...
void	set_min_noutput_items (int m)
	Set the minimum number of output items this block can produce during a call to work. More...
int	max_noutput_items ()
	Return the maximum number of output items this block will handle during a call to work. More...
void	set_max_noutput_items (int m)
	Set the maximum number of output items this block will handle during a call to work. More...
void	unset_max_noutput_items ()
	Clear the switch for using the max_noutput_items value of this block. More...
bool	is_set_max_noutput_items ()
	Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work. More...
void	expand_minmax_buffer (int port)
long	max_output_buffer (size_t i)
	Returns max buffer size on output port i. More...
void	set_max_output_buffer (long max_output_buffer)
	Sets max buffer size on all output ports. More...
void	set_max_output_buffer (int port, long max_output_buffer)
	Sets max buffer size on output port port. More...
long	min_output_buffer (size_t i)
	Returns min buffer size on output port i. More...
void	set_min_output_buffer (long min_output_buffer)
	Sets min buffer size on all output ports. More...
void	set_min_output_buffer (int port, long min_output_buffer)
	Sets min buffer size on output port port. More...
float	pc_noutput_items ()
	Gets instantaneous noutput_items performance counter. More...
float	pc_noutput_items_avg ()
	Gets average noutput_items performance counter. More...
float	pc_noutput_items_var ()
	Gets variance of noutput_items performance counter. More...
float	pc_nproduced ()
	Gets instantaneous num items produced performance counter. More...
float	pc_nproduced_avg ()
	Gets average num items produced performance counter. More...
float	pc_nproduced_var ()
	Gets variance of num items produced performance counter. More...
float	pc_input_buffers_full (int which)
	Gets instantaneous fullness of which input buffer. More...
float	pc_input_buffers_full_avg (int which)
	Gets average fullness of which input buffer. More...
float	pc_input_buffers_full_var (int which)
	Gets variance of fullness of which input buffer. More...
std::vector< float >	pc_input_buffers_full ()
	Gets instantaneous fullness of all input buffers. More...
std::vector< float >	pc_input_buffers_full_avg ()
	Gets average fullness of all input buffers. More...
std::vector< float >	pc_input_buffers_full_var ()
	Gets variance of fullness of all input buffers. More...
float	pc_output_buffers_full (int which)
	Gets instantaneous fullness of which input buffer. More...
float	pc_output_buffers_full_avg (int which)
	Gets average fullness of which input buffer. More...
float	pc_output_buffers_full_var (int which)
	Gets variance of fullness of which input buffer. More...
std::vector< float >	pc_output_buffers_full ()
	Gets instantaneous fullness of all output buffers. More...
std::vector< float >	pc_output_buffers_full_avg ()
	Gets average fullness of all output buffers. More...
std::vector< float >	pc_output_buffers_full_var ()
	Gets variance of fullness of all output buffers. More...
float	pc_work_time ()
	Gets instantaneous clock cycles spent in work. More...
float	pc_work_time_avg ()
	Gets average clock cycles spent in work. More...
float	pc_work_time_var ()
	Gets average clock cycles spent in work. More...
float	pc_work_time_total ()
	Gets total clock cycles spent in work. More...
void	reset_perf_counters ()
	Resets the performance counters. More...
void	setup_pc_rpc ()
	Sets up export of perf. counters to ControlPort. Only called by the scheduler. More...
bool	is_pc_rpc_set ()
	Checks if this block is already exporting perf. counters to ControlPort. More...
void	no_pc_rpc ()
	If the block calls this in its constructor, it's perf. counters will not be exported. More...
void	set_processor_affinity (const std::vector< int > &mask)
	Set the thread's affinity to processor core n. More...
void	unset_processor_affinity ()
	Remove processor affinity to a specific core. More...
std::vector< int >	processor_affinity ()
	Get the current processor affinity. More...
int	active_thread_priority ()
	Get the current thread priority in use. More...
int	thread_priority ()
	Get the current thread priority stored. More...
int	set_thread_priority (int priority)
	Set the current thread priority. More...
bool	update_rate () const
block_detail_sptr	detail () const
void	set_detail (block_detail_sptr detail)
Public Member Functions inherited from gr::basic_block
pmt::pmt_t	message_subscribers (pmt::pmt_t port)
virtual	~basic_block ()
long	unique_id () const
long	symbolic_id () const
std::string	name () const
std::string	symbol_name () const
gr::io_signature::sptr	input_signature () const
gr::io_signature::sptr	output_signature () const
basic_block_sptr	to_basic_block ()
bool	alias_set ()
std::string	alias ()
pmt::pmt_t	alias_pmt ()
void	set_block_alias (std::string name)
void	message_port_register_in (pmt::pmt_t port_id)
void	message_port_register_out (pmt::pmt_t port_id)
void	message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg)
void	message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target)
void	message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target)
virtual bool	message_port_is_hier (pmt::pmt_t port_id)
virtual bool	message_port_is_hier_in (pmt::pmt_t port_id)
virtual bool	message_port_is_hier_out (pmt::pmt_t port_id)
pmt::pmt_t	message_ports_in ()
	Get input message port names. More...
pmt::pmt_t	message_ports_out ()
	Get output message port names. More...
void	_post (pmt::pmt_t which_port, pmt::pmt_t msg)
bool	empty_p (pmt::pmt_t which_port)
	is the queue empty? More...
bool	empty_p ()
bool	empty_handled_p (pmt::pmt_t which_port)
	are all msg ports with handlers empty? More...
bool	empty_handled_p ()
size_t	nmsgs (pmt::pmt_t which_port)
	How many messages in the queue? More...
void	insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg)
pmt::pmt_t	delete_head_nowait (pmt::pmt_t which_port)
pmt::pmt_t	delete_head_blocking (pmt::pmt_t which_port)
msg_queue_t::iterator	get_iterator (pmt::pmt_t which_port)
void	erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it)
virtual bool	has_msg_port (pmt::pmt_t which_port)
virtual void	setup_rpc ()
	Set up the RPC registered variables. More...
bool	is_rpc_set ()
	Ask if this block has been registered to the RPC. More...
void	rpc_set ()
	When the block is registered with the RPC, set this. More...
virtual bool	check_topology (int ninputs, int noutputs)
	Confirm that ninputs and noutputs is an acceptable combination. More...
template<typename T >
void	set_msg_handler (pmt::pmt_t which_port, T msg_handler)
	Set the callback that is fired when messages are available. More...
Public Member Functions inherited from gr::msg_accepter
	msg_accepter ()
	~msg_accepter ()
void	post (pmt::pmt_t which_port, pmt::pmt_t msg)
	send msg to msg_accepter on port which_port More...
Public Member Functions inherited from gr::messages::msg_accepter
	msg_accepter ()

Static Public Member Functions
static sptr	make (int size, int wintype, double fc, double bw, const std::string &name, int nconnections=1, QWidget *parent=NULL)
	Build a floating point waterfall sink. More...

Public Attributes
QApplication *	d_qApplication

Additional Inherited Members
Protected Types inherited from gr::basic_block
enum	vcolor { WHITE, GREY, BLACK }
Protected Member Functions inherited from gr::sync_block
	sync_block (void)
	sync_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
Protected Member Functions inherited from gr::block
	block (void)
	block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
void	set_fixed_rate (bool fixed_rate)
void	add_item_tag (unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
	Adds a new tag onto the given output buffer. More...
void	add_item_tag (unsigned int which_output, const tag_t &tag)
	Adds a new tag onto the given output buffer. More...
void	remove_item_tag (unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
	Removes a tag from the given input buffer. More...
void	remove_item_tag (unsigned int which_input, const tag_t &tag)
	Removes a tag from the given input buffer. More...
void	get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
	Given a [start,end), returns a vector of all tags in the range. More...
void	get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key)
	Given a [start,end), returns a vector of all tags in the range with a given key. More...
void	enable_update_rate (bool en)
Protected Member Functions inherited from gr::basic_block
	basic_block (void)
	basic_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
	Protected constructor prevents instantiation by non-derived classes. More...
void	set_input_signature (gr::io_signature::sptr iosig)
	may only be called during constructor More...
void	set_output_signature (gr::io_signature::sptr iosig)
	may only be called during constructor More...
void	set_color (vcolor color)
	Allow the flowgraph to set for sorting and partitioning. More...
vcolor	color () const
virtual bool	has_msg_handler (pmt::pmt_t which_port)
	Tests if there is a handler attached to port which_port. More...
virtual void	dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg)
Protected Attributes inherited from gr::block
std::vector< long >	d_max_output_buffer
std::vector< long >	d_min_output_buffer
gr::thread::mutex	d_setlock
gr::logger_ptr	d_logger
gr::logger_ptr	d_debug_logger
Protected Attributes inherited from gr::basic_block
std::string	d_name
gr::io_signature::sptr	d_input_signature
gr::io_signature::sptr	d_output_signature
long	d_unique_id
long	d_symbolic_id
std::string	d_symbol_name
std::string	d_symbol_alias
vcolor	d_color
bool	d_rpc_set
msg_queue_map_t	msg_queue
std::vector< boost::any >	d_rpc_vars
pmt::pmt_t	d_message_subscribers

Detailed Description

A graphical sink to display multiple signals on a waterfall (spectrogram) plot.

This is a QT-based graphical sink the takes set of a floating point streams and plots a waterfall (spectrogram) plot.

Note that unlike the other qtgui sinks, this one does not support multiple input streams. We have yet to figure out a good way to display multiple, independent signals on this kind of a plot. If there are any suggestions or examples of this, we would love to see them. Otherwise, to display multiple signals here, it's probably best to sum the signals together and connect that here.

Member Typedef Documentation

typedef boost::shared_ptr<waterfall_sink_f> gr::qtgui::waterfall_sink_f::sptr

Member Function Documentation

virtual void gr::qtgui::waterfall_sink_f::auto_scale ( )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::clear_data ( )

pure virtual

virtual int gr::qtgui::waterfall_sink_f::color_map ( int  which )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::enable_grid ( bool  en = true )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::enable_menu ( bool  en = true )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::exec_ ( )

pure virtual

virtual float gr::qtgui::waterfall_sink_f::fft_average ( ) const

pure virtual

virtual int gr::qtgui::waterfall_sink_f::fft_size ( ) const

pure virtual

virtual gr::filter::firdes::win_type gr::qtgui::waterfall_sink_f::fft_window ( )

pure virtual

virtual double gr::qtgui::waterfall_sink_f::line_alpha ( int  which )

pure virtual

virtual std::string gr::qtgui::waterfall_sink_f::line_label ( int  which )

pure virtual

static sptr gr::qtgui::waterfall_sink_f::make ( int  size, int  wintype, double  fc, double  bw, const std::string &  name, int  nconnections = 1, QWidget *  parent = NULL  )

static

Build a floating point waterfall sink.

Parameters

size	size of the FFT to compute and display
wintype	type of window to apply (see gnuradio/filter/firdes.h)
fc	center frequency of signal (use for x-axis labels)
bw	bandwidth of signal (used to set x-axis labels)
name	title for the plot
nconnections	number of signals to be connected to the sink
parent	a QWidget parent object, if any

virtual double gr::qtgui::waterfall_sink_f::max_intensity ( int  which )

pure virtual

virtual double gr::qtgui::waterfall_sink_f::min_intensity ( int  which )

pure virtual

virtual PyObject* gr::qtgui::waterfall_sink_f::pyqwidget ( )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_color_map ( int  which, const int  color  )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_fft_average ( const float  fftavg )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_fft_size ( const int  fftsize )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_fft_window ( const gr::filter::firdes::win_type  win )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_frequency_range ( const double  centerfreq, const double  bandwidth  )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_intensity_range ( const double  min, const double  max  )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_line_alpha ( int  which, double  alpha  )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_line_label ( int  which, const std::string &  line  )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_size ( int  width, int  height  )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_title ( const std::string &  title )

pure virtual

virtual void gr::qtgui::waterfall_sink_f::set_update_time ( double  t )

pure virtual

virtual std::string gr::qtgui::waterfall_sink_f::title ( )

pure virtual

Member Data Documentation

QApplication* gr::qtgui::waterfall_sink_f::d_qApplication

---

The documentation for this class was generated from the following file:

• waterfall_sink_f.h