Import: 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 explanation of paths for import)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Import additional python modules into the namespace.
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.
;Examples:
:* from gnuradio.filter import firdes
:* import math,cmath
:* from math import pi


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


; Param 1 (''R'')
; Import
: 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).
: Takes the import string as input e.g. ("import math"). Python will attempt to import from whatever directory the current .grc file is in, the default system paths, and whatever is in $PYTHONPATH. You can not specify other paths in the Import parameter.


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


== Example Flowgraph ==
In the following flowgraph, we used the Import block to import fftpack from scipy (the argument to the block is 'from scipy import fftpack'). fftpack is then used to set the variable taps as 'fftpack.ifftshift(fftpack.ifft([tap3, tap4, 1.0, tap1, tap2]))'


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:Import_example.PNG]]


== Source Files ==
== Source Files ==
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]

Latest revision as of 21:27, 16 May 2023

Import additional python modules into the namespace.

Examples
  • from gnuradio.filter import firdes
  • import math,cmath
  • from math import pi

Parameters

Import
Takes the import string as input e.g. ("import math"). Python will attempt to import from whatever directory the current .grc file is in, the default system paths, and whatever is in $PYTHONPATH. You can not specify other paths in the Import parameter.

Example Flowgraph

In the following flowgraph, we used the Import block to import fftpack from scipy (the argument to the block is 'from scipy import fftpack'). fftpack is then used to set the variable taps as 'fftpack.ifftshift(fftpack.ifft([tap3, tap4, 1.0, tap1, tap2]))'

Import example.PNG

Source Files