summaryrefslogtreecommitdiff
path: root/docs/doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen')
-rw-r--r--docs/doxygen/other/ctrlport.dox38
-rw-r--r--docs/doxygen/other/main_page.dox18
-rw-r--r--docs/doxygen/other/pfb_intro.dox8
3 files changed, 51 insertions, 13 deletions
diff --git a/docs/doxygen/other/ctrlport.dox b/docs/doxygen/other/ctrlport.dox
new file mode 100644
index 0000000000..17f5f0d467
--- /dev/null
+++ b/docs/doxygen/other/ctrlport.dox
@@ -0,0 +1,38 @@
+/*! \page page_filter filter Signal Processing Blocks
+
+\section Introduction
+
+This is the gr-ctroport package. It is a tool to create distributed
+contol applications for GNU Radio. It provides blocks that can be
+connected to an output stream to plot the signal remotely. It also
+provides an API that allows blocks to export variables that can be
+set, monitored, and plotted remotely.
+
+The Python namespace is in gnuradio.ctrlport, which would be normally
+imported as:
+
+\code
+ from gnuradio import ctrlport
+\endcode
+
+
+See the Doxygen documentation for details about the blocks available
+in this package. A quick listing of the details can be found in Python
+after importing by using:
+
+\code
+ help(ctrlport)
+\endcode
+
+\section Dependencies
+
+ControlPort requires ZeroC's ICE and associated
+libraries/headers/programs. ICE is generally installed into the
+standard paths if using a software repo (like apt-get, yum, etc.). If
+installed by hand, GNU Radio assumes ICE is installed into
+/opt/Ice-3.4.2. If this is not the case, you can tell GNU Radio where
+to find ICE by passing to cmake the following:
+
+ -DICE_MANUAL_INSTALL_PATH=<your path here>
+
+*/
diff --git a/docs/doxygen/other/main_page.dox b/docs/doxygen/other/main_page.dox
index abdc21b0c9..681dea41c8 100644
--- a/docs/doxygen/other/main_page.dox
+++ b/docs/doxygen/other/main_page.dox
@@ -68,7 +68,7 @@ done. A single source and sink are used with a FIR filter between
them.
\code
- from gnuradio import gr, filter
+ from gnuradio import gr, filter, analog
class my_topblock(gr.top_block):
def __init__(self):
@@ -77,7 +77,7 @@ them.
amp = 1
taps = filter.firdes.low_pass(1, 1, 0.1, 0.01)
- self.src = gr.noise_source_c(gr.GR_GAUSSIAN, amp)
+ self.src = analog.noise_source_c(gr.GR_GAUSSIAN, amp)
self.flt = filter.fir_filter_ccf(1, taps)
self.snk = gr.null_sink(gr.sizeof_gr_complex)
@@ -209,19 +209,19 @@ running and processing data, performing the reconfiguration, and then
restarting the graph by unlocking it.
The following example code shows a graph that first adds two
-gr_noise_source_c blocks and then replaces the gr_add_cc block with a
+analog::noise_source_c blocks and then replaces the gr_add_cc block with a
gr_sub_cc block to then subtract the sources.
\code
-from gnuradio import gr
+from gnuradio import gr, analog
import time
class mytb(gr.top_block):
def __init__(self):
gr.top_block.__init__(self)
- self.src0 = gr.noise_source_c(gr.GR_GAUSSIAN, 1)
- self.src1 = gr.noise_source_c(gr.GR_GAUSSIAN, 1)
+ self.src0 = analog.noise_source_c(gr.GR_GAUSSIAN, 1)
+ self.src1 = analog.noise_source_c(gr.GR_GAUSSIAN, 1)
self.add = gr.add_cc()
self.sub = gr.sub_cc()
self.head = gr.head(gr.sizeof_gr_complex, 1000000)
@@ -268,15 +268,15 @@ The following example expands the previous example but sets and resets
the max noutput_items both locally and globally.
\code
-from gnuradio import gr
+from gnuradio import gr, analog
import time
class mytb(gr.top_block):
def __init__(self):
gr.top_block.__init__(self)
- self.src0 = gr.noise_source_c(gr.GR_GAUSSIAN, 1)
- self.src1 = gr.noise_source_c(gr.GR_GAUSSIAN, 1)
+ self.src0 = analog.noise_source_c(gr.GR_GAUSSIAN, 1)
+ self.src1 = analog.noise_source_c(gr.GR_GAUSSIAN, 1)
self.add = gr.add_cc()
self.sub = gr.sub_cc()
self.head = gr.head(gr.sizeof_gr_complex, 1000000)
diff --git a/docs/doxygen/other/pfb_intro.dox b/docs/doxygen/other/pfb_intro.dox
index 01d08b0fad..504ae87b87 100644
--- a/docs/doxygen/other/pfb_intro.dox
+++ b/docs/doxygen/other/pfb_intro.dox
@@ -64,9 +64,9 @@ defined to use a sample rate of \p filter_size times the signal's
sampling rate.
A helpful wrapper for the arbitrary resampler is found in
-<b>gnuradio-core/src/python/gnuradio/blks2impl/pfb_arb_resampler.py</b>,
-which is exposed in Python as <b>blks2.pfb_arb_resampler_ccf</b> and
-<b>blks2.pfb_arb_resampler_fff</b>. This block is set up so that the
+<b>gr-filter/python/pfb.py</b>,
+which is exposed in Python as <b>filter.pfb.arb_resampler_ccf</b> and
+<b>filter.pfb.arb_resampler_fff</b>. This block is set up so that the
user only needs to pass it the real number \p rate as the resampling
rate. With just this information, this hierarchical block
automatically creates a filter that fully passes the signal bandwidth
@@ -91,6 +91,6 @@ channels.
NOTE: you need the Scipy and Matplotlib Python modules installed to
run this example.
-\include gnuradio-core/src/examples/pfb/channelize.py
+\include gr-filter/examples/channelize.py
*/