Vector 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...")
 
m (correct syntax for Python 3)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Stores stream to a vector, useful if you’re running for a short time, for example
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.
in a test. You can access that data using snk.data() after tb.run() has completed.


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
So something like:
tb.run()
time.sleep(10)
my_data = tb.my_vec_snk.data()
print("data: ",my_data)
 
To extract data from a running flow graph use the probe blocks.
tb.start()
time.sleep(10)
my_data = tb.my_probe_signal.level()
print("data: ",my_data)


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; Reserve Memory for Items
 
: Reserve space in the internal storage for this many items; the internal storage will still grow to accommodate more item if necessary, but setting this to a realistic value can avoid memory allocations during runtime, especially if you know a priori how many items you're going to store.
; Param 1 (''R'')
: 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).
 
; Param 2
: blah blah blah


== Example Flowgraph ==
== Example Flowgraph ==

Latest revision as of 12:13, 26 October 2022

Stores stream to a vector, useful if you’re running for a short time, for example in a test. You can access that data using snk.data() after tb.run() has completed.

So something like:

tb.run()
time.sleep(10)
my_data = tb.my_vec_snk.data()
print("data: ",my_data)

To extract data from a running flow graph use the probe blocks.

tb.start()
time.sleep(10)
my_data = tb.my_probe_signal.level()
print("data: ",my_data)

Parameters

Reserve Memory for Items
Reserve space in the internal storage for this many items; the internal storage will still grow to accommodate more item if necessary, but setting this to a realistic value can avoid memory allocations during runtime, especially if you know a priori how many items you're going to store.

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
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO