Difference between revisions of "QT GUI Vector 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...")
 
(Parameters)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This is a QT-based graphical sink that plots vectors of data as-is. Each signal is plotted with a different color.
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.
 
  
 
== 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
 +
 
 +
; Vector Size
 +
: Vector length at input
 +
 
 +
; X-Axis Start Value (''R'')
 +
: The x-Axis value of the first vector element
 +
 
 +
; X-Axis Start Value (''R'')
 +
: The step with which x-Axis values increment
 +
 
 +
; X-Axis Label
 +
: The X-Axis label
 +
 
 +
; Y-Axis Label
 +
: The Y-Axis label
 +
 
 +
; X-Axis Units (''R'')
 +
:
 +
 
 +
; Y-Axis Units (''R'')
 +
:
 +
 
 +
; Ref Level (''R'')
 +
:
 +
 
 +
; Grid
 +
:
 +
 
 +
; Autoscale
 +
:
 +
 
 +
; Average
 +
:
 +
 
 +
; Y min (''R'')
 +
:
 +
 
 +
; Y max (''R'')
 +
:
 +
 
 +
; Number of Inputs
 +
: Number of signals connected to sink
  
; Param 2
+
; Update Period (''R'')
: blah blah blah
+
:
 +
 
 +
; GUI Hint
 +
: See [[GUI Hint]] for info about how to organize multiple QT GUIs
 +
 
 +
; Show Msg Ports
 +
: True/False
 +
 
 +
; Line 1 Label
 +
:
 +
 
 +
; Line 1 Width
 +
:
 +
 
 +
; Line 1 Color
 +
:
 +
 
 +
; Line 1 Alpha
 +
:
  
 
== Example Flowgraph ==
 
== 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.
+
This flowgraph and output was produced by https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/examples/qtgui_vector_sink_example.grc
 +
 
 +
[[File:Vector_sink.png|800px]]
  
 
== Source Files ==
 
== Source Files ==
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/vector_sink_f_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/vector_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/vector_sink_f.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/grc/qtgui_vector_sink_f.block.yml]

Latest revision as of 20:28, 30 April 2020

This is a QT-based graphical sink that plots vectors of data as-is. Each signal is plotted with a different color.

Parameters[edit]

(R): Run-time adjustable

Name
Title for the plot
Vector Size
Vector length at input
X-Axis Start Value (R)
The x-Axis value of the first vector element
X-Axis Start Value (R)
The step with which x-Axis values increment
X-Axis Label
The X-Axis label
Y-Axis Label
The Y-Axis label
X-Axis Units (R)
Y-Axis Units (R)
Ref Level (R)
Grid
Autoscale
Average
Y min (R)
Y max (R)
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
Show Msg Ports
True/False
Line 1 Label
Line 1 Width
Line 1 Color
Line 1 Alpha

Example Flowgraph[edit]

This flowgraph and output was produced by https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/examples/qtgui_vector_sink_example.grc

Vector sink.png

Source Files[edit]

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