Multiply by Tag Value: 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...")
 
(add example flowgraph)
(One intermediate revision by one other user not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
output = input * complex constant
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.
The complex constant used by this block is found from a tag with the specified name. The tag must contain a float/double or complex PMT value that will be converted into a gr_complex value. All input data is multiplied by this value until a new tag with an update value is found. The block starts with a value of '1.0' for the multiplier constant.


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


; Param 1 (''R'')
; Tag 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).
: Tag's key that it will use to get the multiplicative constant.


; Param 2
== Example Flowgraph ==
: blah blah blah


== Example Flowgraph ==
This flowgraph can be found at [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/examples/packet/packet_rx.grc]


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.
[[File:Packet_rx_fg.png|800px]]


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

Revision as of 01:01, 7 April 2021

output = input * complex constant

The complex constant used by this block is found from a tag with the specified name. The tag must contain a float/double or complex PMT value that will be converted into a gr_complex value. All input data is multiplied by this value until a new tag with an update value is found. The block starts with a value of '1.0' for the multiplier constant.

Parameters

Tag name
Tag's key that it will use to get the multiplicative constant.

Example Flowgraph

This flowgraph can be found at [1]

Packet rx fg.png

Source Files

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO
Retrieved from "https://wiki.gnuradio.org/index.php?title=Multiply_by_Tag_Value&oldid=8447"