QT GUI Time Raster Sink: Difference between revisions

From GNU Radio
Jump to navigation Jump to 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...")
 
(→‎Interactive Demo: : Properly link to flowgraph file)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This is a QT-based graphical sink that takes in numerical streams and plots a time_raster (spectrogram) plot.
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 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.
 
'''Note:''' This block does not limit the items per second it consumes, even though it has an "Update Rate" parameter; it will drop samples if the incoming data rate is higher than the product of the number of columns and the update rate. It is up to the user to choose an update rate that represents his processing needs.


== 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
 
; Sample Rate
: Sample rate of signal
 
; Num. Rows (''R'')
: Number of rows to plot
 
; Num. Cols (''R'')
: Number of cols to plot
 
; Grid
:
 
; Int. min
:
 
; Int. max
:
 
; Multiplier (''R'')
: Vector of floats as a scaling multiplier for each input stream
 
; Offset (''R'')
: Vector of floats as an offset for each input stream
 
; Number of Inputs
: Number of streams connected
 
; Update Period (''R'')
:
 
; GUI Hint
: See [[GUI Hint]] for info about how to organize multiple QT GUIs
 
; Axis Labels
:
 
; Line Label
:
 
; Line Color
:


; Param 2
; Line Alpha
: blah blah blah
:
 
; X-Axis Label, X-Axis Start Value,  X-Axis End Value, Y-Axis Label, Y-Axis Start Value, Y-Axis End Value (New as of 3.9)
: Allows the Time Raster to be able to look like a [[QT GUI Waterfall Sink]] if desired


== 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 show a QT GUI Time Raster Sink.
 
[[File:Time_raster.png|800px]]
 
=== Interactive Demo ===
 
This flowgraph shows how to adjust processing rate in a pure simulation flow graph using the new-style [[Throttle]] block.
 
[[Media:Demonstrate qt gui raster sink.grc|GRC Flowgraph]]
 
[[File:Demonstrate qt gui raster sink.png]]
 
[[File:Qttimerastersink.gif]]


== Source Files ==
== Source Files ==


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/time_raster_sink_f_impl.cc Float input]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/time_raster_sink_b_impl.cc Bit input]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/time_raster_sink_f_impl.h Float input]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/lib/time_raster_sink_b_impl.h Bit input]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/include/gnuradio/qtgui/time_raster_sink_f.h Float input]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/include/gnuradio/qtgui/time_raster_sink_b.h Bit input]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/grc/qtgui_time_raster_x.block.yml]

Latest revision as of 13:00, 26 September 2023

This is a QT-based graphical sink that takes in numerical streams and plots a time_raster (spectrogram) plot.

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.

Note: This block does not limit the items per second it consumes, even though it has an "Update Rate" parameter; it will drop samples if the incoming data rate is higher than the product of the number of columns and the update rate. It is up to the user to choose an update rate that represents his processing needs.

Parameters

(R): Run-time adjustable

Name
Title for the plot
Sample Rate
Sample rate of signal
Num. Rows (R)
Number of rows to plot
Num. Cols (R)
Number of cols to plot
Grid
Int. min
Int. max
Multiplier (R)
Vector of floats as a scaling multiplier for each input stream
Offset (R)
Vector of floats as an offset for each input stream
Number of Inputs
Number of streams connected
Update Period (R)
GUI Hint
See GUI Hint for info about how to organize multiple QT GUIs
Axis Labels
Line Label
Line Color
Line Alpha
X-Axis Label, X-Axis Start Value, X-Axis End Value, Y-Axis Label, Y-Axis Start Value, Y-Axis End Value (New as of 3.9)
Allows the Time Raster to be able to look like a QT GUI Waterfall Sink if desired

Example Flowgraph

This flowgraph and output show a QT GUI Time Raster Sink.

Time raster.png

Interactive Demo

This flowgraph shows how to adjust processing rate in a pure simulation flow graph using the new-style Throttle block.

GRC Flowgraph

Demonstrate qt gui raster sink.png

Qttimerastersink.gif

Source Files

C++ files
Float input
Bit input
Header files
Float input
Bit input
Public header files
Float input
Bit input
Block definition
[1]
Retrieved from "https://wiki.gnuradio.org/index.php?title=QT_GUI_Time_Raster_Sink&oldid=13396"