Difference between revisions of "QT GUI Histogram Sink"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This is a QT-based graphical sink that displays a histogram of the data.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
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.
 +
 
 +
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.
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Param 1 (''R'')
+
; Name
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
+
: Title for the plot
 +
 
 +
; Number of Points
 +
: Number of points to plot at once
 +
 
 +
; Number of Bins (''R'')
 +
: Number of bins to sort the data into
 +
 
 +
; Grid
 +
:
 +
 
 +
; Autoscale
 +
:
 +
 
 +
; Accumulate
 +
: 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.
 +
 
 +
; Min x-axis (''R'')
 +
: Minimum x-axis value
 +
 
 +
; Max x-axis (''R'')
 +
: Maximum x-axis value
 +
 
 +
; Number of Inputs
 +
: Number of signals connected to sink
 +
 
 +
; Update Period (''R'')
 +
:
 +
 
 +
; GUI Hint
 +
: See [[GUI Hint]] for info about how to organize multiple QT GUIs
 +
 
 +
; Grid
 +
:
 +
 
 +
; Legend
 +
:
 +
 
 +
; Axis Labels
 +
:
 +
 
 +
; Line 1 Label
 +
:
 +
 
 +
; Line 1 Width
 +
:
 +
 
 +
; Line 1 Color
 +
:
 +
 
 +
; Line 1 Style
 +
:
 +
 
 +
; Line 1 Marker
 +
:
  
; Param 2
+
; Line 1 Alpha
: blah blah blah
+
:
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 78:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/histogram_sink_f_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/histogram_sink_f_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/include/gnuradio/qtgui/histogram_sink_f.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/grc/qtgui_histogram_sink_x.block.yml]

Revision as of 13:19, 9 September 2019

This is a QT-based graphical sink that 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.

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.

Parameters

(R): Run-time adjustable

Name
Title for the plot
Number of Points
Number of points to plot at once
Number of Bins (R)
Number of bins to sort the data into
Grid
Autoscale
Accumulate
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.
Min x-axis (R)
Minimum x-axis value
Max x-axis (R)
Maximum x-axis value
Number of Inputs
Number of signals connected to sink
Update Period (R)
GUI Hint
See GUI Hint for info about how to organize multiple QT GUIs
Grid
Legend
Axis Labels
Line 1 Label
Line 1 Width
Line 1 Color
Line 1 Style
Line 1 Marker
Line 1 Alpha

Example Flowgraph

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]