Vector Insert: 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...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Insert a vector periodically into a stream of 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.
Note that parameters are used so that there is one instance of the inserted vector every ''Periodicity'' output samples
 
And '''''not''''' so that every ''Periodicity'' input items, a vector is inserted.
 
Also note that the ''Offset'' parameter specifies where in the cycle period the block starts at, and '''''not''''' what is the offset of the inserted vector.
 
 
For instance, if one wants to insert a 100 samples long vector every 800 input samples, and have 300 samples before the first vector is inserted,
One should set ''Periodicity'' to 900, and ''Offset'' to 600.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Vector
: 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).
: Vector of data to insert
 
; Periodicity
: The length of the periodicity at which the vector should be inserted at the output (i.e. one vector for every N output items). Must be higher than Vector length
 
; Offset
: Offset specifies where in the cycle period we should begin at. Must be positive and lower than Periodicity


; Param 2
: blah blah blah


== Example Flowgraph ==
== Example Flowgraph ==
Line 21: Line 31:


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/vector_insert_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/vector_insert_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/vector_insert.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_vector_insert_x.block.yml]

Latest revision as of 15:23, 19 August 2024

Insert a vector periodically into a stream of data.

Note that parameters are used so that there is one instance of the inserted vector every Periodicity output samples

And not so that every Periodicity input items, a vector is inserted.

Also note that the Offset parameter specifies where in the cycle period the block starts at, and not what is the offset of the inserted vector.


For instance, if one wants to insert a 100 samples long vector every 800 input samples, and have 300 samples before the first vector is inserted, One should set Periodicity to 900, and Offset to 600.

Parameters

Vector
Vector of data to insert
Periodicity
The length of the periodicity at which the vector should be inserted at the output (i.e. one vector for every N output items). Must be higher than Vector length
Offset
Offset specifies where in the cycle period we should begin at. Must be positive and lower than Periodicity


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]