diff options
Diffstat (limited to 'docs')
32 files changed, 349 insertions, 615 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..59ee96d7f9 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) @@ -201,7 +201,7 @@ buffer, which may be different than what was initially specified. It is possible to reconfigure the flowgraph at runtime. The reconfiguration is meant for changes in the flowgraph structure, not individual parameter settings of the blocks. For example, changing the -constant in a gr_add_const_cc block can be done while the flowgraph is +constant in a gr::blocks::add_const_cc block can be done while the flowgraph is running using the 'set_k(k)' method. Reconfiguration is done by locking the flowgraph, which stops it from @@ -209,21 +209,22 @@ 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 -gr_sub_cc block to then subtract the sources. +gr::analog::noise_source_c blocks and then replaces the +gr::blocks::add_cc block with a gr::blocks::sub_cc block to then +subtract the sources. \code -from gnuradio import gr +from gnuradio import gr, analog, blocks 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.add = gr.add_cc() - self.sub = gr.sub_cc() + self.src0 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.src1 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.add = blocks.add_cc() + self.sub = blocks.sub_cc() self.head = gr.head(gr.sizeof_gr_complex, 1000000) self.snk = gr.file_sink(gr.sizeof_gr_complex, "output.32fc") @@ -268,17 +269,17 @@ 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, blocks 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.add = gr.add_cc() - self.sub = gr.sub_cc() + self.src0 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.src1 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.add = blocks.add_cc() + self.sub = blocks.sub_cc() self.head = gr.head(gr.sizeof_gr_complex, 1000000) self.snk = gr.file_sink(gr.sizeof_gr_complex, "output.32fc") diff --git a/docs/doxygen/other/metadata.dox b/docs/doxygen/other/metadata.dox index b527b21008..76553c696a 100644 --- a/docs/doxygen/other/metadata.dox +++ b/docs/doxygen/other/metadata.dox @@ -106,7 +106,7 @@ interface. The file metadata consists of a static mandatory header and a dynamic optional extras header. Each header is a separate PMT dictionary. Headers are created by building a PMT dictionary -(pmt::pmt_make_dict) of key:value pairs, then the dictionary is +(pmt::make_dict) of key:value pairs, then the dictionary is serialized into a string to be written to file. The header is always the same length that is predetermined by the version of the header (this must be known already). The header will then indicate if there @@ -117,27 +117,26 @@ we use PMT operators. For example, we create a simplified version of the header in C++ like this: \code - using namespace pmt; const char METADATA_VERSION = 0x0; - pmt_t header; - header = pmt_make_dict(); - header = pmt_dict_add(header, mp("version"), mp(METADATA_VERSION)); - header = pmt_dict_add(header, mp("rx_rate"), mp(samp_rate)); - std::string hdr_str = pmt_serialize_str(header); + pmt::pmt_t header; + header = pmt::make_dict(); + header = pmt::dict_add(header, pmt::mp("version"), pmt::mp(METADATA_VERSION)); + header = pmt::dict_add(header, pmt::mp("rx_rate"), pmt::mp(samp_rate)); + std::string hdr_str = pmt::serialize_str(header); \endcode -The call to pmt::pmt_dict_add adds a new key:value pair to the +The call to pmt::dict_add adds a new key:value pair to the dictionary. Notice that it both takes and returns the 'header' variable. This is because we are actually creating a new dictionary with this function, so we just assign it to the same variable. The 'mp' functions are convenience functions provided by the PMT library. They interpret the data type of the value being inserted and -call the correct 'pmt_from_xxx' function. For more direct control over +call the correct 'pmt::from_xxx' function. For more direct control over the data type, see PMT functions in pmt.h, such as -pmt::pmt_from_uint64 or pmt::pmt_from_double. +pmt::from_uint64 or pmt::from_double. -We finish this off by using pmt::pmt_serialize_str to convert the PMT +We finish this off by using pmt::serialize_str to convert the PMT dictionary into a specialized string format that makes it easy to write to a file. @@ -153,10 +152,10 @@ Assuming that 'std::string str' contains the full string as read from a file, we can access the dictionary in C++ like this: \code - pmt_t hdr = pmt_deserialize_str(str); - if(pmt_dict_has_key(hdr, pmt_string_to_symbol("strt"))) { - pmt_t r = pmt_dict_ref(hdr, pmt_string_to_symbol("strt"), PMT_NIL); - uint64_t seg_start = pmt_to_uint64(r); + pmt::pmt_t hdr = pmt::deserialize_str(str); + if(pmt::dict_has_key(hdr, pmt::string_to_symbol("strt"))) { + pmt::pmt_t r = pmt::dict_ref(hdr, pmt::string_to_symbol("strt"), pmt::PMT_NIL); + uint64_t seg_start = pmt::to_uint64(r); uint64_t extra_len = seg_start - METADATA_HEADER_SIZE; } \endcode @@ -221,7 +220,7 @@ a PMT dictionary of key:value pairs. The extras header can contain anything and can grow while a program is running. We can insert extra data into the header at the beginning if we -wish. All we need to do is use the pmt::pmt_dict_add function to insert +wish. All we need to do is use the pmt::dict_add function to insert our hand-made metadata. This can be useful to add our own markers and information. @@ -239,7 +238,7 @@ When reading out data from the extras, we do not necessarily know the data type of the PMT value. The key is always a PMT symbol, but the value can be any other PMT type. There are PMT functions that allow us to query the PMT to test if it is a particular type. We also have the -ability to do pmt::pmt_print on any PMT object to print it to +ability to do pmt::print on any PMT object to print it to screen. Before converting from a PMT to it's natural data type, it is necessary to know the data type. @@ -313,12 +312,12 @@ encoded as a vector of uint16 with [day, month, year]. from gruel import pmt from gnuradio import blocks - key = pmt.pmt_intern("date") - val = pmt.pmt_init_u16vector(3, [13,12,2012]) + key = pmt.intern("date") + val = pmt.init_u16vector(3, [13,12,2012]) - extras = pmt.pmt_make_dict() - extras = pmt.pmt_dict_add(extras, key, val) - extras_str = pmt.pmt_serialize_str(extras) + extras = pmt.make_dict() + extras = pmt.dict_add(extras, key, val) + extras_str = pmt.serialize_str(extras) self.sink = blocks.file_meta_sink(gr.sizeof_gr_complex, "/tmp/metadat_file.out", samp_rate, 1, diff --git a/docs/doxygen/other/msg_passing.dox b/docs/doxygen/other/msg_passing.dox index aea0ac94ae..7035f291e4 100644 --- a/docs/doxygen/other/msg_passing.dox +++ b/docs/doxygen/other/msg_passing.dox @@ -83,7 +83,7 @@ received by \b dbg on port \a print. Note here how we are just using strings to define the ports, not PMT symbols. This is a convenience to the user to be able to more easily type in the port names (for reference, you can create a PMT symbol in Python using the -pmt::pmt_intern function as pmt.pmt_intern("string")). +pmt::intern function as pmt.intern("string")). Users can also query blocks for the names of their input and output ports using the following API calls: @@ -157,13 +157,13 @@ void gr_message_debug::print(pmt::pmt_t msg) { std::cout << "***** MESSAGE DEBUG PRINT ********\n"; - pmt::pmt_print(msg); + pmt::print(msg); std::cout << "**********************************\n"; } \endcode The function simply takes in the PMT message and prints it. The method -pmt::pmt_print is a function in the PMT library to print the +pmt::print is a function in the PMT library to print the PMT in a friendly, (mostly) pretty manner. The gr_tagged_stream_to_pdu block only defines a single @@ -196,11 +196,11 @@ gr_tagged_stream_to_pdu::send_message function that is shown below. void gr_tagged_stream_to_pdu::send_meassage() { - if(pmt::pmt_length(d_pdu_vector) != d_pdu_length) { + if(pmt::length(d_pdu_vector) != d_pdu_length) { throw std::runtime_error("msg length not correct"); } - pmt::pmt_t msg = pmt::pmt_cons(d_pdu_meta, + pmt::pmt_t msg = pmt::cons(d_pdu_meta, d_pdu_vector); message_port_pub(pdu_port_id, msg); @@ -247,9 +247,9 @@ flowgraph. These PDUs could come from another block or flowgraph, but here, we will create and insert them by hand. \code - port = pmt.pmt_intern("pdus") - msg = pmt.pmt_cons(pmt.PMT_NIL, - pmt.pmt_make_u8vector(16, 0xFF)) + port = pmt.intern("pdus") + msg = pmt.cons(pmt.PMT_NIL, + pmt.make_u8vector(16, 0xFF)) src.to_basic_block()._post(port, msg) \endcode 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 */ diff --git a/docs/doxygen/other/pmt.dox b/docs/doxygen/other/pmt.dox index 61b73bca13..ba97863a08 100644 --- a/docs/doxygen/other/pmt.dox +++ b/docs/doxygen/other/pmt.dox @@ -66,25 +66,25 @@ underneath is still a C++ typed object, and so the right type of set/get function must be used for the data type. Typically, a PMT object can be made from a scalar item using a call -like "pmt::pmt_from_<type>". Similarly, when getting data out of a -PMT, we use a call like "pmt::pmt_to_<type>". For example: +like "pmt::from_<type>". Similarly, when getting data out of a +PMT, we use a call like "pmt::to_<type>". For example: \code double a = 1.2345; -pmt::pmt_t pmt_a = pmt::pmt_from_double(a); -double b = pmt::pmt_to_double(pmt_a); +pmt::pmt_t pmt_a = pmt::from_double(a); +double b = pmt::to_double(pmt_a); int c = 12345; -pmt::pmt_t pmt_c = pmt::pmt_from_long(c); -int d = pmt::pmt_to_long(pmt_c); +pmt::pmt_t pmt_c = pmt::from_long(c); +int d = pmt::to_long(pmt_c); \endcode As a side-note, making a PMT from a complex number is not obvious: \code std::complex<double> a(1.2, 3.4); -pmt::pmt_t pmt_a = pmt::pmt_make_rectangular(a.real(), b.imag()); -std::complex<double> b = pmt::pmt_to_complex(pmt_a); +pmt::pmt_t pmt_a = pmt::make_rectangular(a.real(), b.imag()); +std::complex<double> b = pmt::to_complex(pmt_a); \endcode Pairs, dictionaries, and vectors have different constructors and ways @@ -100,17 +100,17 @@ new symbol from a string, if that string already exists in the hash table, the constructor will return a reference to the existing PMT. We create strings with the following functions, where the second -function, pmt::pmt_intern, is simply an alias of the first. +function, pmt::intern, is simply an alias of the first. \code -pmt::pmt_t str0 = pmt::pmt_string_to_symbol(std::string("some string")); -pmt::pmt_t str1 = pmt::pmt_intern(std::string("some string")); +pmt::pmt_t str0 = pmt::string_to_symbol(std::string("some string")); +pmt::pmt_t str1 = pmt::intern(std::string("some string")); \endcode The string can be retrieved using the inverse function: \code -std::string s = pmt::pmt_symbol_to_string(str0); +std::string s = pmt::symbol_to_string(str0); \endcode @@ -118,28 +118,28 @@ std::string s = pmt::pmt_symbol_to_string(str0); The PMT library comes with a number of functions to test and compare PMT objects. In general, for any PMT data type, there is an equivalent -"pmt::pmt_is_<type>". We can use these to test the PMT before trying +"pmt::is_<type>". We can use these to test the PMT before trying to access the data inside. Expanding our examples above, we have: \code -pmt::pmt_t str0 = pmt::pmt_string_to_symbol(std::string("some string")); -if(pmt::pmt_is_symbol(str0)) - std::string s = pmt::pmt_symbol_to_string(str0); +pmt::pmt_t str0 = pmt::string_to_symbol(std::string("some string")); +if(pmt::is_symbol(str0)) + std::string s = pmt::symbol_to_string(str0); double a = 1.2345; -pmt::pmt_t pmt_a = pmt::pmt_from_double(a); -if(pmt::pmt_is_double(pmt_a)) - double b = pmt::pmt_to_double(pmt_a); +pmt::pmt_t pmt_a = pmt::from_double(a); +if(pmt::is_double(pmt_a)) + double b = pmt::to_double(pmt_a); int c = 12345; -pmt::pmt_t pmt_c = pmt::pmt_from_long(c); -if(pmt::pmt_is_long(pmt_a)) - int d = pmt::pmt_to_long(pmt_c); +pmt::pmt_t pmt_c = pmt::from_long(c); +if(pmt::is_long(pmt_a)) + int d = pmt::to_long(pmt_c); \\ This will fail the test. Otherwise, trying to coerce \b pmt_c as a \\ double when internally it is a long will result in an exception. -if(pmt::pmt_is_double(pmt_a)) - double d = pmt::pmt_to_double(pmt_c); +if(pmt::is_double(pmt_a)) + double d = pmt::to_double(pmt_c); \endcode @@ -156,15 +156,15 @@ returned dictionary is a new PMT with the changes made there. The following is a list of PMT dictionary functions. Click through to get more information on what each does. -- bool pmt::pmt_is_dict(const pmt_t &obj) -- pmt_t pmt::pmt_make_dict() -- pmt_t pmt::pmt_dict_add(const pmt_t &dict, const pmt_t &key, const pmt_t &value) -- pmt_t pmt::pmt_dict_delete(const pmt_t &dict, const pmt_t &key) -- bool pmt::pmt_dict_has_key(const pmt_t &dict, const pmt_t &key) -- pmt_t pmt::pmt_dict_ref(const pmt_t &dict, const pmt_t &key, const pmt_t ¬_found) -- pmt_t pmt::pmt_dict_items(pmt_t dict) -- pmt_t pmt::pmt_dict_keys(pmt_t dict) -- pmt_t pmt::pmt_dict_values(pmt_t dict) +- bool pmt::is_dict(const pmt_t &obj) +- pmt_t pmt::make_dict() +- pmt_t pmt::dict_add(const pmt_t &dict, const pmt_t &key, const pmt_t &value) +- pmt_t pmt::dict_delete(const pmt_t &dict, const pmt_t &key) +- bool pmt::dict_has_key(const pmt_t &dict, const pmt_t &key) +- pmt_t pmt::dict_ref(const pmt_t &dict, const pmt_t &key, const pmt_t ¬_found) +- pmt_t pmt::dict_items(pmt_t dict) +- pmt_t pmt::dict_keys(pmt_t dict) +- pmt_t pmt::dict_values(pmt_t dict) This example does some basic manipulations of PMT dictionaries in Python. Notice that we pass the dictionary \a a and return the results @@ -175,39 +175,39 @@ variables small. \code from gruel import pmt -key0 = pmt.pmt_intern("int") -val0 = pmt.pmt_from_long(123) -val1 = pmt.pmt_from_long(234) +key0 = pmt.intern("int") +val0 = pmt.from_long(123) +val1 = pmt.from_long(234) -key1 = pmt.pmt_intern("double") -val2 = pmt.pmt_from_double(5.4321) +key1 = pmt.tern("double") +val2 = pmt.om_double(5.4321) # Make an empty dictionary -a = pmt.pmt_make_dict() +a = pmt.make_dict() # Add a key:value pair to the dictionary -a = pmt.pmt_dict_add(a, key0, val0) -pmt.pmt_print(a) +a = pmt.dict_add(a, key0, val0) +print a # Add a new value to the same key; # new dict will still have one item with new value -a = pmt.pmt_dict_add(a, key0, val1) -pmt.pmt_print(a) +a = pmt.dict_add(a, key0, val1) +print a # Add a new key:value pair -a = pmt.pmt_dict_add(a, key1, val2) -pmt.pmt_print(a) +a = pmt.dict_add(a, key1, val2) +print a # Test if we have a key, then delete it -print pmt.pmt_dict_has_key(a, key1) -a = pmt.pmt_dict_delete(a, key1) -print pmt.pmt_dict_has_key(a, key1) +print pmt.dict_has_key(a, key1) +a = pmt.dict_delete(a, key1) +print pmt.dict_has_key(a, key1) -ref = pmt.pmt_dict_ref(a, key0, pmt.PMT_NIL) -pmt.pmt_print(ref) +ref = pmt.dict_ref(a, key0, pmt.PMT_NIL) +print ref # The following should never print -if(pmt.pmt_dict_has_key(a, key0) and pmt.pmt_eq(ref, pmt.PMT_NIL)): +if(pmt.dict_has_key(a, key0) and pmt.eq(ref, pmt.PMT_NIL)): print "Trouble! We have key0, but it returned PMT_NIL" \endcode @@ -232,29 +232,29 @@ both signed and unsigned. Vectors have a well-defined interface that allows us to make, set, get, and fill them. We can also get the length of a vector with -pmt::pmt_length. +pmt::length. For standard vectors, these functions look like: -- bool pmt::pmt_is_vector(pmt_t x) -- pmt_t pmt::pmt_make_vector(size_t k, pmt_t fill) -- pmt_t pmt::pmt_vector_ref(pmt_t vector, size_t k) -- void pmt::pmt_vector_set(pmt_t vector, size_t k, pmt_t obj) -- void pmt::pmt_vector_fill(pmt_t vector, pmt_t fill) +- bool pmt::is_vector(pmt_t x) +- pmt_t pmt::make_vector(size_t k, pmt_t fill) +- pmt_t pmt::vector_ref(pmt_t vector, size_t k) +- void pmt::vector_set(pmt_t vector, size_t k, pmt_t obj) +- void pmt::vector_fill(pmt_t vector, pmt_t fill) Uniform vectors have the same types of functions, but they are data type-dependent. The following list tries to explain them where you substitute the specific data type prefix for \a dtype (prefixes being: u8, u16, u32, u64, s8, s16, s32, s64, f32, f64, c32, c64). -- bool pmt::pmt_is_(dtype)vector(pmt_t x) -- pmt_t pmt::pmt_make_(dtype)vector(size_t k, (dtype) fill) -- pmt_t pmt::pmt_init_(dtype)vector(size_t k, const (dtype*) data) -- pmt_t pmt::pmt_init_(dtype)vector(size_t k, const std::vector<dtype> data) -- pmt_t pmt::pmt_(dtype)vector_ref(pmt_t vector, size_t k) -- void pmt::pmt_(dtype)vector_set(pmt_t vector, size_t k, (dtype) x) -- const dtype* pmt::pmt_(dtype)vector_elements(pmt_t vector, size_t &len) -- dtype* pmt::pmt_(dtype)vector_writable_elements(pmt_t vector, size_t &len) +- bool pmt::is_(dtype)vector(pmt_t x) +- pmt_t pmt::make_(dtype)vector(size_t k, (dtype) fill) +- pmt_t pmt::init_(dtype)vector(size_t k, const (dtype*) data) +- pmt_t pmt::init_(dtype)vector(size_t k, const std::vector<dtype> data) +- pmt_t pmt::(dtype)vector_ref(pmt_t vector, size_t k) +- void pmt::(dtype)vector_set(pmt_t vector, size_t k, (dtype) x) +- const dtype* pmt::(dtype)vector_elements(pmt_t vector, size_t &len) +- dtype* pmt::(dtype)vector_writable_elements(pmt_t vector, size_t &len) \b Note: We break the contract with vectors. The 'set' functions actually change the data underneath. It is important to keep track of @@ -276,12 +276,12 @@ Pairs are inspired by LISP 'cons' data types, so you will find the language here comes from LISP. A pair is just a pair of PMT objects. They are manipulated using the following functions: -- bool pmt::pmt_is_pair (const pmt_t &obj): Return true if obj is a pair, else false -- pmt_t pmt::pmt_cons(const pmt_t &x, const pmt_t &y): construct new pair -- pmt_t pmt::pmt_car(const pmt_t &pair): get the car of the pair (first object) -- pmt_t pmt::pmt_cdr(const pmt_t &pair): get the cdr of the pair (second object) -- void pmt::pmt_set_car(pmt_t pair, pmt_t value): Stores value in the car field -- void pmt::pmt_set_cdr(pmt_t pair, pmt_t value): Stores value in the cdr field +- bool pmt::is_pair(const pmt_t &obj): Return true if obj is a pair, else false +- pmt_t pmt::cons(const pmt_t &x, const pmt_t &y): construct new pair +- pmt_t pmt::car(const pmt_t &pair): get the car of the pair (first object) +- pmt_t pmt::cdr(const pmt_t &pair): get the cdr of the pair (second object) +- void pmt::set_car(pmt_t pair, pmt_t value): Stores value in the car field +- void pmt::set_cdr(pmt_t pair, pmt_t value): Stores value in the cdr field \section serdes Serializing and Deserializing @@ -293,10 +293,10 @@ string and then methods to deserialize the string buffer or string back into a PMT. We use this extensively in the metadata files (see \ref page_metadata). -- bool pmt::pmt_serialize(pmt_t obj, std::streambuf &sink) -- std::string pmt::pmt_serialize_str(pmt_t obj) -- pmt_t pmt::pmt_deserialize(std::streambuf &source) -- pmt_t pmt::pmt_deserialize_str(std::string str) +- bool pmt::serialize(pmt_t obj, std::streambuf &sink) +- std::string pmt::serialize_str(pmt_t obj) +- pmt_t pmt::deserialize(std::streambuf &source) +- pmt_t pmt::deserialize_str(std::string str) For example, we will serialize the data above to make it into a string ready to be written to a file and then deserialize it back to its @@ -305,26 +305,26 @@ original PMT. \code from gruel import pmt -key0 = pmt.pmt_intern("int") -val0 = pmt.pmt_from_long(123) +key0 = pmt.intern("int") +val0 = pmt.from_long(123) -key1 = pmt.pmt_intern("double") -val1 = pmt.pmt_from_double(5.4321) +key1 = pmt.intern("double") +val1 = pmt.from_double(5.4321) # Make an empty dictionary -a = pmt.pmt_make_dict() +a = pmt.make_dict() # Add a key:value pair to the dictionary -a = pmt.pmt_dict_add(a, key0, val0) -a = pmt.pmt_dict_add(a, key1, val1) +a = pmt.dict_add(a, key0, val0) +a = pmt.dict_add(a, key1, val1) -pmt.pmt_print(a) +print a -ser_str = pmt.pmt_serialize_str(a) +ser_str = pmt.serialize_str(a) print ser_str -b = pmt.pmt_deserialize_str(ser_str) -pmt.pmt_print(b) +b = pmt.deserialize_str(ser_str) +print b \endcode @@ -335,13 +335,17 @@ string. This is only done here as a test. \section printing Printing -We have used the pmt::pmt_print function in these examples to nicely -print the contents of a PMT. Another way to print the contents is -using the overloaded "<<" operator with a stream buffer object. In -C++, we can inline print the contents of a PMT like: +In Python, the __repr__ function of a PMT object is overloaded to call +'pmt::write_string'. This means that any time we call a formatted +printing operation on a PMT object, the PMT library will properly +format the object for display. + +In C++, we can use the 'pmt::print(object)' function or print the +contents is using the overloaded "<<" operator with a stream buffer +object. In C++, we can inline print the contents of a PMT like: \code -pmt::pmt_t a pmt::pmt_from_double(1.0); +pmt::pmt_t a pmt::from_double(1.0); std::cout << "The PMT a contains " << a << std::endl; \endcode diff --git a/docs/exploring-gnuradio/dial_tone.py b/docs/exploring-gnuradio/dial_tone.py index cabfa0864d..ba43c43bfc 100755 --- a/docs/exploring-gnuradio/dial_tone.py +++ b/docs/exploring-gnuradio/dial_tone.py @@ -1,6 +1,6 @@ #!/usr/bin/env python # -# Copyright 2004,2007 Free Software Foundation, Inc. +# Copyright 2004,2007,2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # @@ -22,22 +22,23 @@ from gnuradio import gr from gnuradio import audio +from gnuradio import analog -def build_graph (): +def build_graph(): sampling_freq = 32000 ampl = 0.1 - tb = gr.top_block () - src0 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 350, ampl) - src1 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 440, ampl) - dst = audio.sink (sampling_freq) - tb.connect (src0, (dst, 0)) - tb.connect (src1, (dst, 1)) + tb = gr.top_block() + src0 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 350, ampl) + src1 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 440, ampl) + dst = audio.sink(sampling_freq) + tb.connect(src0, (dst, 0)) + tb.connect(src1, (dst, 1)) return tb if __name__ == '__main__': - tb = build_graph () - tb.start () - raw_input ('Press Enter to quit: ') - tb.stop () + tb = build_graph() + tb.start() + raw_input('Press Enter to quit: ') + tb.stop() diff --git a/docs/exploring-gnuradio/dial_tone_example.xml b/docs/exploring-gnuradio/dial_tone_example.xml index 14ea68039e..5d193df776 100644 --- a/docs/exploring-gnuradio/dial_tone_example.xml +++ b/docs/exploring-gnuradio/dial_tone_example.xml @@ -5,24 +5,25 @@ from gnuradio import gr from gnuradio import audio +from gnuradio import analog def build_graph (): sampling_freq = 48000 ampl = 0.1 - fg = gr.flow_graph () - src0 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 350, ampl) - src1 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 440, ampl) - dst = audio.sink (sampling_freq) - fg.connect ((src0, 0), (dst, 0)) - fg.connect ((src1, 0), (dst, 1)) + fg = gr.flow_graph() + src0 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 350, ampl) + src1 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 440, ampl) + dst = audio.sink(sampling_freq) + fg.connect((src0, 0), (dst, 0)) + fg.connect((src1, 0), (dst, 1)) return fg if __name__ == '__main__': - fg = build_graph () - fg.start () - raw_input ('Press Enter to quit: ') - fg.stop () + fg = build_graph() + fg.start() + raw_input('Press Enter to quit: ') + fg.stop() </programlisting> </example> diff --git a/docs/exploring-gnuradio/exploring-gnuradio.xml b/docs/exploring-gnuradio/exploring-gnuradio.xml index 286ca86095..5b70d4d0bf 100644 --- a/docs/exploring-gnuradio/exploring-gnuradio.xml +++ b/docs/exploring-gnuradio/exploring-gnuradio.xml @@ -180,7 +180,7 @@ right.</para> <para>We start by creating a flow graph to hold the blocks and connections between them. The two sine waves are generated by the -gr.sig_source_f calls. The f suffix indicates that the source produces +analog.sig_source_f calls. The f suffix indicates that the source produces floats. One sine wave is at 350 Hz, and the other is at 440 Hz. Together, they sound like the US dial tone.</para> diff --git a/docs/exploring-gnuradio/fm_demod.py b/docs/exploring-gnuradio/fm_demod.py index 0071fd751e..7b19cd826a 100755 --- a/docs/exploring-gnuradio/fm_demod.py +++ b/docs/exploring-gnuradio/fm_demod.py @@ -1,18 +1,19 @@ #!/usr/bin/env python from gnuradio import gr +from gnuradio import analog from gnuradio import audio from gnuradio import mc4020 import sys -def high_speed_adc (fg, input_rate): +def high_speed_adc(fg, input_rate): # return gr.file_source (gr.sizeof_short, "dummy.dat", False) - return mc4020.source (input_rate, mc4020.MCC_CH3_EN | mc4020.MCC_ALL_1V) + return mc4020.source(input_rate, mc4020.MCC_CH3_EN | mc4020.MCC_ALL_1V) # # return a gr.flow_graph # -def build_graph (freq1, freq2): +def build_graph(freq1, freq2): input_rate = 20e6 cfir_decimation = 125 audio_decimation = 5 @@ -20,35 +21,35 @@ def build_graph (freq1, freq2): quad_rate = input_rate / cfir_decimation audio_rate = quad_rate / audio_decimation - fg = gr.flow_graph () + fg = gr.flow_graph() # use high speed ADC as input source - src = high_speed_adc (fg, input_rate) + src = high_speed_adc(fg, input_rate) # compute FIR filter taps for channel selection channel_coeffs = \ - gr.firdes.low_pass (1.0, # gain - input_rate, # sampling rate - 250e3, # low pass cutoff freq - 8*100e3, # width of trans. band - gr.firdes.WIN_HAMMING) + filter.firdes.low_pass(1.0, # gain + input_rate, # sampling rate + 250e3, # low pass cutoff freq + 8*100e3, # width of trans. band + filter.firdes.WIN_HAMMING) # input: short; output: complex chan_filter1 = \ - gr.freq_xlating_fir_filter_scf (cfir_decimation, - channel_coeffs, - freq1, # 1st station freq - input_rate) + filter.freq_xlating_fir_filter_scf(cfir_decimation, + channel_coeffs, + freq1, # 1st station freq + input_rate) - (head1, tail1) = build_pipeline (fg, quad_rate, audio_decimation) + (head1, tail1) = build_pipeline(fg, quad_rate, audio_decimation) # sound card as final sink - audio_sink = audio.sink (int (audio_rate)) + audio_sink = audio.sink(int (audio_rate)) # now wire it all together - fg.connect (src, chan_filter1) - fg.connect (chan_filter1, head1) - fg.connect (tail1, (audio_sink, 0)) + fg.connect(src, chan_filter1) + fg.connect(chan_filter1, head1) + fg.connect(tail1, (audio_sink, 0)) # two stations at once? if freq2: @@ -57,20 +58,20 @@ def build_graph (freq1, freq2): # input: short; output: complex chan_filter2 = \ - gr.freq_xlating_fir_filter_scf (cfir_decimation, - channel_coeffs, - freq2, # 2nd station freq - input_rate) + filter.freq_xlating_fir_filter_scf(cfir_decimation, + channel_coeffs, + freq2, # 2nd station freq + input_rate) - (head2, tail2) = build_pipeline (fg, quad_rate, audio_decimation) + (head2, tail2) = build_pipeline(fg, quad_rate, audio_decimation) - fg.connect (src, chan_filter2) - fg.connect (chan_filter2, head2) - fg.connect (tail2, (audio_sink, 1)) + fg.connect(src, chan_filter2) + fg.connect(chan_filter2, head2) + fg.connect(tail2, (audio_sink, 1)) return fg -def build_pipeline (fg, quad_rate, audio_decimation): +def build_pipeline(fg, quad_rate, audio_decimation): '''Given a flow_graph, fg, construct a pipeline for demodulating a broadcast FM signal. The input is the downconverteed complex baseband @@ -84,67 +85,67 @@ def build_pipeline (fg, quad_rate, audio_decimation): volume = 1.0 # input: complex; output: float - fm_demod = gr.quadrature_demod_cf (volume*fm_demod_gain) + fm_demod = analog.quadrature_demod_cf(volume*fm_demod_gain) # compute FIR filter taps for audio filter width_of_transition_band = audio_rate / 32 - audio_coeffs = gr.firdes.low_pass (1.0, # gain - quad_rate, # sampling rate - audio_rate/2 - width_of_transition_band, - width_of_transition_band, - gr.firdes.WIN_HAMMING) + audio_coeffs = filter.firdes.low_pass(1.0, # gain + quad_rate, # sampling rate + audio_rate/2 - width_of_transition_band, + width_of_transition_band, + filter.firdes.WIN_HAMMING) # input: float; output: float - audio_filter = gr.fir_filter_fff (audio_decimation, audio_coeffs) + audio_filter = filter.fir_filter_fff(audio_decimation, audiocoeffs) - fg.connect (fm_demod, audio_filter) + fg.connect(fm_demod, audio_filter) return ((fm_demod, 0), (audio_filter, 0)) -def main (args): - nargs = len (args) +def main(args): + nargs = len(args) if nargs == 1: - freq1 = float (args[0]) * 1e6 + freq1 = float(args[0]) * 1e6 freq2 = None elif nargs == 2: - freq1 = float (args[0]) * 1e6 - freq2 = float (args[1]) * 1e6 + freq1 = float(args[0]) * 1e6 + freq2 = float(args[1]) * 1e6 else: - sys.stderr.write ('usage: fm_demod freq1 [freq2]\n') - sys.exit (1) + sys.stderr.write('usage: fm_demod freq1 [freq2]\n') + sys.exit(1) # connect to RF front end - rf_front_end = gr.microtune_4937_eval_board () - if not rf_front_end.board_present_p (): + rf_front_end = gr.microtune_4937_eval_board() + if not rf_front_end.board_present_p(): raise IOError, 'RF front end not found' # set front end gain - rf_front_end.set_AGC (300) - IF_freq = rf_front_end.get_output_freq () + rf_front_end.set_AGC(300) + IF_freq = rf_front_end.get_output_freq() IF_freq = 5.75e6 if not freq2: # one station - rf_front_end.set_RF_freq (freq1) - fg = build_graph (IF_freq, None) + rf_front_end.set_RF_freq(freq1) + fg = build_graph(IF_freq, None) else: # two stations - if abs (freq1 - freq2) > 5.5e6: + if abs(freq1 - freq2) > 5.5e6: raise IOError, 'freqs too far apart' target_freq = (freq1 + freq2) / 2 - actual_freq = rf_front_end.set_RF_freq (target_freq) + actual_freq = rf_front_end.set_RF_freq(target_freq) #actual_freq = target_freq - fg = build_graph (IF_freq + freq1 - actual_freq, - IF_freq + freq2 - actual_freq) + fg = build_graph(IF_freq + freq1 - actual_freq, + IF_freq + freq2 - actual_freq) - fg.start () # fork thread(s) and return - raw_input ('Press Enter to quit: ') - fg.stop () + fg.start() # fork thread(s) and return + raw_input('Press Enter to quit: ') + fg.stop() if __name__ == '__main__': - main (sys.argv[1:]) + main(sys.argv[1:]) diff --git a/docs/exploring-gnuradio/fm_demod_example.xml b/docs/exploring-gnuradio/fm_demod_example.xml index b417da0a81..05c2ee163b 100644 --- a/docs/exploring-gnuradio/fm_demod_example.xml +++ b/docs/exploring-gnuradio/fm_demod_example.xml @@ -4,6 +4,8 @@ #!/usr/bin/env python from gnuradio import gr +from gnuradio import filter +from gnuradio import analog from gnuradio import audio from gnuradio import mc4020 import sys @@ -30,28 +32,28 @@ def build_graph (freq1, freq2): # compute FIR filter taps for channel selection channel_coeffs = \ - gr.firdes.low_pass (1.0, # gain - input_rate, # sampling rate - 250e3, # low pass cutoff freq - 8*100e3, # width of trans. band - gr.firdes.WIN_HAMMING) + filter.firdes.low_pass(1.0, # gain + input_rate, # sampling rate + 250e3, # low pass cutoff freq + 8*100e3, # width of trans. band + filter.firdes.WIN_HAMMING) # input: short; output: complex chan_filter1 = \ - gr.freq_xlating_fir_filter_scf (cfir_decimation, - channel_coeffs, - freq1, # 1st station freq - input_rate) + filter.freq_xlating_fir_filter_scf(cfir_decimation, + channel_coeffs, + freq1, # 1st station freq + input_rate) - (head1, tail1) = build_pipeline (fg, quad_rate, audio_decimation) + (head1, tail1) = build_pipeline(fg, quad_rate, audio_decimation) # sound card as final sink - audio_sink = audio.sink (int (audio_rate)) + audio_sink = audio.sink(int (audio_rate)) # now wire it all together - fg.connect (src, chan_filter1) - fg.connect (chan_filter1, head1) - fg.connect (tail1, (audio_sink, 0)) + fg.connect(src, chan_filter1) + fg.connect(chan_filter1, head1) + fg.connect(tail1, (audio_sink, 0)) return fg @@ -69,20 +71,20 @@ def build_pipeline (fg, quad_rate, audio_decimation): volume = 1.0 # input: complex; output: float - fm_demod = gr.quadrature_demod_cf (volume*fm_demod_gain) + fm_demod = analog.quadrature_demod_cf(volume*fm_demod_gain) # compute FIR filter taps for audio filter width_of_transition_band = audio_rate / 32 - audio_coeffs = gr.firdes.low_pass (1.0, # gain - quad_rate, # sampling rate - audio_rate/2 - width_of_transition_band, - width_of_transition_band, - gr.firdes.WIN_HAMMING) + audio_coeffs = filter.firdes.low_pass(1.0, # gain + quad_rate, # sampling rate + audio_rate/2 - width_of_transition_band, + width_of_transition_band, + filter.firdes.WIN_HAMMING) # input: float; output: float - audio_filter = gr.fir_filter_fff (audio_decimation, audio_coeffs) + audio_filter = filter.fir_filter_fff(audio_decimation, audio_coeffs) - fg.connect (fm_demod, audio_filter) + fg.connect(fm_demod, audio_filter) return ((fm_demod, 0), (audio_filter, 0)) @@ -90,34 +92,34 @@ def main (args): nargs = len (args) if nargs == 1: # get station frequency from command line - freq1 = float (args[0]) * 1e6 + freq1 = float(args[0]) * 1e6 else: - sys.stderr.write ('usage: fm_demod freq\n') - sys.exit (1) + sys.stderr.write('usage: fm_demod freq\n') + sys.exit(1) # connect to RF front end - rf_front_end = gr.microtune_4937_eval_board () - if not rf_front_end.board_present_p (): + rf_front_end = gr.microtune_4937_eval_board() + if not rf_front_end.board_present_p(): raise IOError, 'RF front end not found' # set front end gain - rf_front_end.set_AGC (300) + rf_front_end.set_AGC(300) # determine the front end's "Intermediate Frequency" - IF_freq = rf_front_end.get_output_freq () # 5.75e6 + IF_freq = rf_front_end.get_output_freq() # 5.75e6 # Tell the front end to tune to freq1. # I.e., freq1 is translated down to the IF frequency - rf_front_end.set_RF_freq (freq1) + rf_front_end.set_RF_freq(freq1) # build the flow graph - fg = build_graph (IF_freq, None) + fg = build_graph(IF_freq, None) - fg.start () # fork thread(s) and return - raw_input ('Press Enter to quit: ') - fg.stop () + fg.start() # fork thread(s) and return + raw_input('Press Enter to quit: ') + fg.stop() if __name__ == '__main__': - main (sys.argv[1:]) + main(sys.argv[1:]) </programlisting> </example> diff --git a/docs/sphinx/source/blks2/blks.rst b/docs/sphinx/source/blks2/blks.rst deleted file mode 100644 index c28c7af0f8..0000000000 --- a/docs/sphinx/source/blks2/blks.rst +++ /dev/null @@ -1,31 +0,0 @@ -gnuradio.blks2: Signal Processing Blocks -======================================== - -.. autopyblock:: gnuradio.blks2.am_demod_cf -.. autopyblock:: gnuradio.blks2.ctcss_gen_f -.. autopyblock:: gnuradio.blks2.demod_10k0a3e_cf -.. autopyblock:: gnuradio.blks2.demod_200kf3e_cf -.. autopyblock:: gnuradio.blks2.demod_20k0f3e_cf -.. autopyblock:: gnuradio.blks2.fm_demod_cf -.. autopyblock:: gnuradio.blks2.logpwrfft_c -.. autopyblock:: gnuradio.blks2.logpwrfft_f -.. autopyblock:: gnuradio.blks2.pfb_arb_resampler_ccf -.. autopyblock:: gnuradio.blks2.pfb_arb_resampler_fff -.. autopyblock:: gnuradio.blks2.pfb_channelizer_ccf -.. autopyblock:: gnuradio.blks2.pfb_decimator_ccf -.. autopyblock:: gnuradio.blks2.pfb_interpolator_ccf -.. autopyblock:: gnuradio.blks2.rational_resampler_ccc -.. autopyblock:: gnuradio.blks2.rational_resampler_ccf -.. autopyblock:: gnuradio.blks2.rational_resampler_fff -.. autopyblock:: gnuradio.blks2.analysis_filterbank -.. autopyblock:: gnuradio.blks2.fm_deemph -.. autopyblock:: gnuradio.blks2.fm_preemph -.. autopyblock:: gnuradio.blks2.nbfm_rx -.. autopyblock:: gnuradio.blks2.nbfm_tx -.. autopyblock:: gnuradio.blks2.stream_to_vector_decimator -.. autopyblock:: gnuradio.blks2.standard_squelch -.. autopyblock:: gnuradio.blks2.synthesis_filterbank -.. autopyblock:: gnuradio.blks2.wfm_rcv -.. autopyblock:: gnuradio.blks2.wfm_rcv_fmdet -.. autopyblock:: gnuradio.blks2.wfm_rcv_pll -.. autopyblock:: gnuradio.blks2.wfm_tx diff --git a/docs/sphinx/source/blks2/index.rst b/docs/sphinx/source/blks2/index.rst deleted file mode 100644 index 4df8e5a796..0000000000 --- a/docs/sphinx/source/blks2/index.rst +++ /dev/null @@ -1,47 +0,0 @@ -gnuradio.blks2 -============== - -.. automodule:: gnuradio.blks2 - -Signal Processing Blocks ------------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blks2.am_demod_cf - gnuradio.blks2.ctcss_gen_f - gnuradio.blks2.demod_10k0a3e_cf - gnuradio.blks2.demod_200kf3e_cf - gnuradio.blks2.demod_20k0f3e_cf - gnuradio.blks2.fm_demod_cf - gnuradio.blks2.logpwrfft_c - gnuradio.blks2.logpwrfft_f - gnuradio.blks2.pfb_arb_resampler_ccf - gnuradio.blks2.pfb_arb_resampler_fff - gnuradio.blks2.pfb_channelizer_ccf - gnuradio.blks2.pfb_decimator_ccf - gnuradio.blks2.pfb_interpolator_ccf - gnuradio.blks2.rational_resampler_ccc - gnuradio.blks2.rational_resampler_ccf - gnuradio.blks2.rational_resampler_fff - gnuradio.blks2.analysis_filterbank - gnuradio.blks2.fm_deemph - gnuradio.blks2.fm_preemph - gnuradio.blks2.nbfm_rx - gnuradio.blks2.nbfm_tx - gnuradio.blks2.stream_to_vector_decimator - gnuradio.blks2.standard_squelch - gnuradio.blks2.synthesis_filterbank - gnuradio.blks2.wfm_rcv - gnuradio.blks2.wfm_rcv_fmdet - gnuradio.blks2.wfm_rcv_pll - gnuradio.blks2.wfm_tx - -Utility Functions ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blks2.design_filter diff --git a/docs/sphinx/source/blks2/utilities.rst b/docs/sphinx/source/blks2/utilities.rst deleted file mode 100644 index 3ce068fb41..0000000000 --- a/docs/sphinx/source/blks2/utilities.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.blks2: Utility Functions -================================= - -.. autoclass:: gnuradio.blks2.design_filter diff --git a/docs/sphinx/source/digital/blocks.rst b/docs/sphinx/source/digital/blocks.rst index 68ec8dad1c..32eb25608b 100644 --- a/docs/sphinx/source/digital/blocks.rst +++ b/docs/sphinx/source/digital/blocks.rst @@ -17,6 +17,25 @@ gnuradio.digital: Signal Processing Blocks .. autooldblock:: gnuradio.digital.gmskmod_bc .. autooldblock:: gnuradio.digital.probe_mpsk_snr_est_c .. autooldblock:: gnuradio.digital.cpmmod_bc +.. autooldblock:: gnuradio.digital.glfsr_source_b +.. autooldblock:: gnuradio.digital.glfsr_source_f +.. autooldblock:: gnuradio.digital.framer_sink_1 +.. autooldblock:: gnuradio.digital.framer_sink_1 +.. autooldblock:: gnuradio.digital.additive_scrambler_bb +.. autooldblock:: gnuradio.digital.descrambler_bb +.. autooldblock:: gnuradio.digital.diff_decoder_bb +.. autooldblock:: gnuradio.digital.diff_encoder_bb +.. autooldblock:: gnuradio.digital.map_bb +.. autooldblock:: gnuradio.digital.scrambler_bb +.. autooldblock:: gnuradio.digital.pn_correlator_cc +.. autooldblock:: gnuradio.digital.simple_framer +.. autooldblock:: gnuradio.digital.bytes_to_syms +.. autooldblock:: gnuradio.digital.chunks_to_symbols_bc +.. autooldblock:: gnuradio.digital.chunks_to_symbols_bf +.. autooldblock:: gnuradio.digital.chunks_to_symbols_ic +.. autooldblock:: gnuradio.digital.chunks_to_symbols_if +.. autooldblock:: gnuradio.digital.chunks_to_symbols_sc +.. autooldblock:: gnuradio.digital.chunks_to_symbols_sf .. autopyblock:: gnuradio.digital.generic_demod .. autopyblock:: gnuradio.digital.generic_mod .. autopyblock:: gnuradio.digital.bpsk.dbpsk_demod diff --git a/docs/sphinx/source/digital/index.rst b/docs/sphinx/source/digital/index.rst index da5227e455..14c84fe4bb 100644 --- a/docs/sphinx/source/digital/index.rst +++ b/docs/sphinx/source/digital/index.rst @@ -25,6 +25,24 @@ Signal Processing Blocks gnuradio.digital.gmskmod_bc gnuradio.digital.probe_mpsk_snr_est_c gnuradio.digital.cpmmod_bc + gnuradio.digital.glfsr_source_b + gnuradio.digital.glfsr_source_f + gnuradio.digital.framer_sink_1 + gnuradio.digital.additive_scrambler_bb + gnuradio.digital.descrambler_bb + gnuradio.digital.diff_decoder_bb + gnuradio.digital.diff_encoder_bb + gnuradio.digital.map_bb + gnuradio.digital.scrambler_bb + gnuradio.digital.pn_correlator_cc + gnuradio.digital.simple_framer + gnuradio.digital.bytes_to_syms + gnuradio.digital.chunks_to_symbols_bc + gnuradio.digital.chunks_to_symbols_bf + gnuradio.digital.chunks_to_symbols_ic + gnuradio.digital.chunks_to_symbols_if + gnuradio.digital.chunks_to_symbols_sc + gnuradio.digital.chunks_to_symbols_sf gnuradio.digital.generic_demod gnuradio.digital.generic_mod gnuradio.digital.bpsk.dbpsk_demod @@ -83,8 +101,6 @@ Modulation Utilties :nosignatures: gnuradio.digital.utils.gray_code.gray_code - gnuradio.digital.utils.mod_codes.GRAY_CODE - gnuradio.digital.utils.mod_codes.NO_CODE gnuradio.digital.modulation_utils.add_type_1_constellation gnuradio.digital.modulation_utils.add_type_1_demod gnuradio.digital.modulation_utils.add_type_1_mod @@ -92,6 +108,9 @@ Modulation Utilties gnuradio.digital.modulation_utils.type_1_demods gnuradio.digital.modulation_utils.type_1_mods +.. gnuradio.digital.utils.mod_codes.GRAY_CODE +.. gnuradio.digital.utils.mod_codes.NO_CODE + Packet Utilities ---------------- diff --git a/docs/sphinx/source/gr/coding_blk.rst b/docs/sphinx/source/gr/coding_blk.rst index e50b990bcd..da8cacf2b4 100644 --- a/docs/sphinx/source/gr/coding_blk.rst +++ b/docs/sphinx/source/gr/coding_blk.rst @@ -1,11 +1,5 @@ gnuradio.gr: Information Coding and Decoding ============================================ -.. autooldblock:: gnuradio.gr.additive_scrambler_bb -.. autooldblock:: gnuradio.gr.descrambler_bb -.. autooldblock:: gnuradio.gr.diff_decoder_bb -.. autooldblock:: gnuradio.gr.diff_encoder_bb .. autooldblock:: gnuradio.gr.fake_channel_encoder_pp .. autooldblock:: gnuradio.gr.fake_channel_decoder_pp -.. autooldblock:: gnuradio.gr.map_bb -.. autooldblock:: gnuradio.gr.scrambler_bb diff --git a/docs/sphinx/source/gr/converter_blk.rst b/docs/sphinx/source/gr/converter_blk.rst index 790109a94f..98cfcfee9f 100644 --- a/docs/sphinx/source/gr/converter_blk.rst +++ b/docs/sphinx/source/gr/converter_blk.rst @@ -1,8 +1,6 @@ gnuradio.gr: Type Conversions ============================= -.. autooldblock:: gnuradio.gr.bytes_to_syms -.. autooldblock:: gnuradio.gr.char_to_float .. autooldblock:: gnuradio.gr.complex_to_interleaved_short .. autooldblock:: gnuradio.gr.complex_to_float .. autooldblock:: gnuradio.gr.complex_to_real @@ -10,20 +8,7 @@ gnuradio.gr: Type Conversions .. autooldblock:: gnuradio.gr.complex_to_mag .. autooldblock:: gnuradio.gr.complex_to_mag_squared .. autooldblock:: gnuradio.gr.complex_to_arg -.. autooldblock:: gnuradio.gr.float_to_char -.. autooldblock:: gnuradio.gr.float_to_complex -.. autooldblock:: gnuradio.gr.float_to_short -.. autooldblock:: gnuradio.gr.float_to_uchar -.. autooldblock:: gnuradio.gr.interleaved_short_to_complex -.. autooldblock:: gnuradio.gr.short_to_float -.. autooldblock:: gnuradio.gr.uchar_to_float .. autooldblock:: gnuradio.gr.unpack_k_bits_bb -.. autooldblock:: gnuradio.gr.chunks_to_symbols_bc -.. autooldblock:: gnuradio.gr.chunks_to_symbols_bf -.. autooldblock:: gnuradio.gr.chunks_to_symbols_ic -.. autooldblock:: gnuradio.gr.chunks_to_symbols_if -.. autooldblock:: gnuradio.gr.chunks_to_symbols_sc -.. autooldblock:: gnuradio.gr.chunks_to_symbols_sf .. autooldblock:: gnuradio.gr.packed_to_unpacked_bb .. autooldblock:: gnuradio.gr.packed_to_unpacked_ii .. autooldblock:: gnuradio.gr.packed_to_unpacked_ss diff --git a/docs/sphinx/source/gr/demodulation_blk.rst b/docs/sphinx/source/gr/demodulation_blk.rst deleted file mode 100644 index 4f800b642b..0000000000 --- a/docs/sphinx/source/gr/demodulation_blk.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.gr: Demodulation -========================= - -.. autooldblock:: gnuradio.gr.quadrature_demod_cf diff --git a/docs/sphinx/source/gr/filter_design.rst b/docs/sphinx/source/gr/filter_design.rst deleted file mode 100644 index 6ab23c50bf..0000000000 --- a/docs/sphinx/source/gr/filter_design.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Digital Filter Design -================================== - -.. autoclass:: gnuradio.gr.firdes - :members: - -.. autofunction:: gnuradio.gr.remez diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst index 3d32599f1d..6d09b861ef 100644 --- a/docs/sphinx/source/gr/index.rst +++ b/docs/sphinx/source/gr/index.rst @@ -21,18 +21,8 @@ Signal Sources .. autosummary:: :nosignatures: - gnuradio.gr.glfsr_source_b - gnuradio.gr.glfsr_source_f gnuradio.gr.lfsr_32k_source_s gnuradio.gr.null_source - gnuradio.gr.noise_source_c - gnuradio.gr.noise_source_f - gnuradio.gr.noise_source_i - gnuradio.gr.noise_source_s - gnuradio.gr.sig_source_c - gnuradio.gr.sig_source_f - gnuradio.gr.sig_source_i - gnuradio.gr.sig_source_s gnuradio.gr.vector_source_b gnuradio.gr.vector_source_c gnuradio.gr.vector_source_f @@ -53,12 +43,7 @@ Signal Sinks gnuradio.gr.bin_statistics_f gnuradio.gr.check_counting_s gnuradio.gr.check_lfsr_32k_s - gnuradio.gr.framer_sink_1 gnuradio.gr.null_sink - gnuradio.gr.packet_sink - gnuradio.gr.probe_avg_mag_sqrd_c - gnuradio.gr.probe_avg_mag_sqrd_cf - gnuradio.gr.probe_avg_mag_sqrd_f gnuradio.gr.probe_signal_f gnuradio.gr.vector_sink_b gnuradio.gr.vector_sink_c @@ -129,80 +114,9 @@ Mathematics .. autosummary:: :nosignatures: - gnuradio.gr.conjugate_cc - gnuradio.gr.nlog10_ff gnuradio.gr.rms_cf gnuradio.gr.rms_ff - gnuradio.gr.add_cc - gnuradio.gr.add_const_cc - gnuradio.gr.add_const_ff - gnuradio.gr.add_const_ii - gnuradio.gr.add_const_sf - gnuradio.gr.add_const_ss - gnuradio.gr.add_const_vcc - gnuradio.gr.add_const_vff - gnuradio.gr.add_const_vii - gnuradio.gr.add_const_vss - gnuradio.gr.add_ff - gnuradio.gr.add_ii - gnuradio.gr.add_ss - gnuradio.gr.and_bb - gnuradio.gr.and_const_bb - gnuradio.gr.and_const_ii - gnuradio.gr.and_const_ss - gnuradio.gr.and_ii - gnuradio.gr.and_ss - gnuradio.gr.divide_cc - gnuradio.gr.divide_ff - gnuradio.gr.divide_ii - gnuradio.gr.divide_ss - gnuradio.gr.integrate_cc - gnuradio.gr.integrate_ff - gnuradio.gr.integrate_ii - gnuradio.gr.integrate_ss - gnuradio.gr.multiply_cc - gnuradio.gr.multiply_const_cc - gnuradio.gr.multiply_const_ff - gnuradio.gr.multiply_const_ii - gnuradio.gr.multiply_const_ss - gnuradio.gr.multiply_const_vcc - gnuradio.gr.multiply_const_vff - gnuradio.gr.multiply_const_vii - gnuradio.gr.multiply_const_vss - gnuradio.gr.multiply_ff - gnuradio.gr.multiply_ii - gnuradio.gr.multiply_ss - gnuradio.gr.not_bb - gnuradio.gr.not_ii - gnuradio.gr.not_ss - gnuradio.gr.or_bb - gnuradio.gr.or_ii - gnuradio.gr.or_ss - gnuradio.gr.sub_cc - gnuradio.gr.sub_ff - gnuradio.gr.sub_ii - gnuradio.gr.sub_ss - gnuradio.gr.xor_bb - gnuradio.gr.xor_ii - gnuradio.gr.xor_ss - -Modulation -^^^^^^^^^^ -.. autosummary:: - :nosignatures: - - gnuradio.gr.cpfsk_bc - gnuradio.gr.frequency_modulator_fc - gnuradio.gr.phase_modulator_fc - -Demodulation -^^^^^^^^^^^^ - -.. autosummary:: - :nosignatures: - - gnuradio.gr.quadrature_demod_cf Information Coding and Decoding ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -210,14 +124,8 @@ Information Coding and Decoding .. autosummary:: :nosignatures: - gnuradio.gr.additive_scrambler_bb - gnuradio.gr.descrambler_bb - gnuradio.gr.diff_decoder_bb - gnuradio.gr.diff_encoder_bb gnuradio.gr.fake_channel_encoder_pp gnuradio.gr.fake_channel_decoder_pp - gnuradio.gr.map_bb - gnuradio.gr.scrambler_bb Synchronization ^^^^^^^^^^^^^^^ @@ -225,12 +133,7 @@ Synchronization .. autosummary:: :nosignatures: - gnuradio.gr.pll_carriertracking_cc - gnuradio.gr.pll_freqdet_cf - gnuradio.gr.pll_refout_cc - gnuradio.gr.pn_correlator_cc gnuradio.gr.simple_correlator - gnuradio.gr.simple_framer Type Conversions ^^^^^^^^^^^^^^^^ @@ -238,8 +141,6 @@ Type Conversions .. autosummary:: :nosignatures: - gnuradio.gr.bytes_to_syms - gnuradio.gr.char_to_float gnuradio.gr.complex_to_interleaved_short gnuradio.gr.complex_to_float gnuradio.gr.complex_to_real @@ -247,20 +148,7 @@ Type Conversions gnuradio.gr.complex_to_mag gnuradio.gr.complex_to_mag_squared gnuradio.gr.complex_to_arg - gnuradio.gr.float_to_char - gnuradio.gr.float_to_complex - gnuradio.gr.float_to_short - gnuradio.gr.float_to_uchar - gnuradio.gr.interleaved_short_to_complex - gnuradio.gr.short_to_float - gnuradio.gr.uchar_to_float gnuradio.gr.unpack_k_bits_bb - gnuradio.gr.chunks_to_symbols_bc - gnuradio.gr.chunks_to_symbols_bf - gnuradio.gr.chunks_to_symbols_ic - gnuradio.gr.chunks_to_symbols_if - gnuradio.gr.chunks_to_symbols_sc - gnuradio.gr.chunks_to_symbols_sf gnuradio.gr.packed_to_unpacked_bb gnuradio.gr.packed_to_unpacked_ii gnuradio.gr.packed_to_unpacked_ss @@ -274,18 +162,8 @@ Signal Level Control (AGC) .. autosummary:: :nosignatures: - gnuradio.gr.agc2_cc - gnuradio.gr.agc2_ff - gnuradio.gr.agc_cc - gnuradio.gr.agc_ff - gnuradio.gr.ctcss_squelch_ff - gnuradio.gr.dpll_bb - gnuradio.gr.feedforward_agc_cc gnuradio.gr.peak_detector2_fb - gnuradio.gr.pwr_squelch_cc - gnuradio.gr.pwr_squelch_ff gnuradio.gr.regenerate_bb - gnuradio.gr.simple_squelch_cc gnuradio.gr.mute_cc gnuradio.gr.mute_ff gnuradio.gr.mute_ii @@ -319,7 +197,6 @@ Miscellaneous Blocks gnuradio.gr.kludge_copy gnuradio.gr.nop gnuradio.gr.pa_2x2_phase_combiner - gnuradio.gr.repeat gnuradio.gr.threshold_ff gnuradio.gr.throttle gnuradio.gr.channel_model @@ -330,17 +207,8 @@ Slicing and Dicing Streams .. autosummary:: :nosignatures: - gnuradio.gr.deinterleave gnuradio.gr.head - gnuradio.gr.interleave - gnuradio.gr.keep_one_in_n gnuradio.gr.skiphead - gnuradio.gr.stream_to_streams - gnuradio.gr.stream_to_vector - gnuradio.gr.streams_to_stream - gnuradio.gr.streams_to_vector - gnuradio.gr.vector_to_stream - gnuradio.gr.vector_to_streams Digital Filter Design --------------------- diff --git a/docs/sphinx/source/gr/level_blk.rst b/docs/sphinx/source/gr/level_blk.rst index d6c565c65d..0eacb67230 100644 --- a/docs/sphinx/source/gr/level_blk.rst +++ b/docs/sphinx/source/gr/level_blk.rst @@ -1,18 +1,9 @@ gnuradio.gr: Signal Level Control (AGC) ======================================= -.. autooldblock:: gnuradio.gr.agc2_cc -.. autooldblock:: gnuradio.gr.agc2_ff -.. autooldblock:: gnuradio.gr.agc_cc -.. autooldblock:: gnuradio.gr.agc_ff -.. autooldblock:: gnuradio.gr.ctcss_squelch_ff .. autooldblock:: gnuradio.gr.dpll_bb -.. autooldblock:: gnuradio.gr.feedforward_agc_cc .. autooldblock:: gnuradio.gr.peak_detector2_fb -.. autooldblock:: gnuradio.gr.pwr_squelch_cc -.. autooldblock:: gnuradio.gr.pwr_squelch_ff .. autooldblock:: gnuradio.gr.regenerate_bb -.. autooldblock:: gnuradio.gr.simple_squelch_cc .. autooldblock:: gnuradio.gr.mute_cc .. autooldblock:: gnuradio.gr.mute_ff .. autooldblock:: gnuradio.gr.mute_ii diff --git a/docs/sphinx/source/gr/math_blk.rst b/docs/sphinx/source/gr/math_blk.rst index 7b9437f995..208318def2 100644 --- a/docs/sphinx/source/gr/math_blk.rst +++ b/docs/sphinx/source/gr/math_blk.rst @@ -1,59 +1,5 @@ gnuradio.gr: Mathematics ======================== -.. autooldblock:: gnuradio.gr.conjugate_cc -.. autooldblock:: gnuradio.gr.nlog10_ff .. autooldblock:: gnuradio.gr.rms_cf .. autooldblock:: gnuradio.gr.rms_ff -.. autooldblock:: gnuradio.gr.add_cc -.. autooldblock:: gnuradio.gr.add_const_cc -.. autooldblock:: gnuradio.gr.add_const_ff -.. autooldblock:: gnuradio.gr.add_const_ii -.. autooldblock:: gnuradio.gr.add_const_sf -.. autooldblock:: gnuradio.gr.add_const_ss -.. autooldblock:: gnuradio.gr.add_const_vcc -.. autooldblock:: gnuradio.gr.add_const_vff -.. autooldblock:: gnuradio.gr.add_const_vii -.. autooldblock:: gnuradio.gr.add_const_vss -.. autooldblock:: gnuradio.gr.add_ff -.. autooldblock:: gnuradio.gr.add_ii -.. autooldblock:: gnuradio.gr.add_ss -.. autooldblock:: gnuradio.gr.and_bb -.. autooldblock:: gnuradio.gr.and_const_bb -.. autooldblock:: gnuradio.gr.and_const_ii -.. autooldblock:: gnuradio.gr.and_const_ss -.. autooldblock:: gnuradio.gr.and_ii -.. autooldblock:: gnuradio.gr.and_ss -.. autooldblock:: gnuradio.gr.divide_cc -.. autooldblock:: gnuradio.gr.divide_ff -.. autooldblock:: gnuradio.gr.divide_ii -.. autooldblock:: gnuradio.gr.divide_ss -.. autooldblock:: gnuradio.gr.integrate_cc -.. autooldblock:: gnuradio.gr.integrate_ff -.. autooldblock:: gnuradio.gr.integrate_ii -.. autooldblock:: gnuradio.gr.integrate_ss -.. autooldblock:: gnuradio.gr.multiply_cc -.. autooldblock:: gnuradio.gr.multiply_const_cc -.. autooldblock:: gnuradio.gr.multiply_const_ff -.. autooldblock:: gnuradio.gr.multiply_const_ii -.. autooldblock:: gnuradio.gr.multiply_const_ss -.. autooldblock:: gnuradio.gr.multiply_const_vcc -.. autooldblock:: gnuradio.gr.multiply_const_vff -.. autooldblock:: gnuradio.gr.multiply_const_vii -.. autooldblock:: gnuradio.gr.multiply_const_vss -.. autooldblock:: gnuradio.gr.multiply_ff -.. autooldblock:: gnuradio.gr.multiply_ii -.. autooldblock:: gnuradio.gr.multiply_ss -.. autooldblock:: gnuradio.gr.not_bb -.. autooldblock:: gnuradio.gr.not_ii -.. autooldblock:: gnuradio.gr.not_ss -.. autooldblock:: gnuradio.gr.or_bb -.. autooldblock:: gnuradio.gr.or_ii -.. autooldblock:: gnuradio.gr.or_ss -.. autooldblock:: gnuradio.gr.sub_cc -.. autooldblock:: gnuradio.gr.sub_ff -.. autooldblock:: gnuradio.gr.sub_ii -.. autooldblock:: gnuradio.gr.sub_ss -.. autooldblock:: gnuradio.gr.xor_bb -.. autooldblock:: gnuradio.gr.xor_ii -.. autooldblock:: gnuradio.gr.xor_ss diff --git a/docs/sphinx/source/gr/misc_blk.rst b/docs/sphinx/source/gr/misc_blk.rst index c69293056c..56bcb7fbde 100644 --- a/docs/sphinx/source/gr/misc_blk.rst +++ b/docs/sphinx/source/gr/misc_blk.rst @@ -6,7 +6,6 @@ gnuradio.gr: Miscellaneous Blocks .. autooldblock:: gnuradio.gr.kludge_copy .. autooldblock:: gnuradio.gr.nop .. autooldblock:: gnuradio.gr.pa_2x2_phase_combiner -.. autooldblock:: gnuradio.gr.repeat .. autooldblock:: gnuradio.gr.threshold_ff .. autooldblock:: gnuradio.gr.throttle .. autooldblock:: gnuradio.gr.channel_model diff --git a/docs/sphinx/source/gr/modulation_blk.rst b/docs/sphinx/source/gr/modulation_blk.rst deleted file mode 100644 index 1fff4614ca..0000000000 --- a/docs/sphinx/source/gr/modulation_blk.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.gr: Modulation -======================= - -.. autooldblock:: gnuradio.gr.cpfsk_bc -.. autooldblock:: gnuradio.gr.frequency_modulator_fc -.. autooldblock:: gnuradio.gr.phase_modulator_fc diff --git a/docs/sphinx/source/gr/sink_blk.rst b/docs/sphinx/source/gr/sink_blk.rst index 7608ff09b0..5e396d895a 100644 --- a/docs/sphinx/source/gr/sink_blk.rst +++ b/docs/sphinx/source/gr/sink_blk.rst @@ -4,12 +4,7 @@ gnuradio.gr: Signal Sinks .. autooldblock:: gnuradio.gr.bin_statistics_f .. autooldblock:: gnuradio.gr.check_counting_s .. autooldblock:: gnuradio.gr.check_lfsr_32k_s -.. autooldblock:: gnuradio.gr.framer_sink_1 .. autooldblock:: gnuradio.gr.null_sink -.. autooldblock:: gnuradio.gr.packet_sink -.. autooldblock:: gnuradio.gr.probe_avg_mag_sqrd_c -.. autooldblock:: gnuradio.gr.probe_avg_mag_sqrd_cf -.. autooldblock:: gnuradio.gr.probe_avg_mag_sqrd_f .. autooldblock:: gnuradio.gr.probe_signal_f .. autooldblock:: gnuradio.gr.vector_sink_b .. autooldblock:: gnuradio.gr.vector_sink_c diff --git a/docs/sphinx/source/gr/slicedice_blk.rst b/docs/sphinx/source/gr/slicedice_blk.rst index e845627aad..9ade1667d5 100644 --- a/docs/sphinx/source/gr/slicedice_blk.rst +++ b/docs/sphinx/source/gr/slicedice_blk.rst @@ -1,14 +1,5 @@ gnuradio.gr: Slicing and Dicing Streams ======================================= -.. autooldblock:: gnuradio.gr.deinterleave .. autooldblock:: gnuradio.gr.head -.. autooldblock:: gnuradio.gr.interleave -.. autooldblock:: gnuradio.gr.keep_one_in_n .. autooldblock:: gnuradio.gr.skiphead -.. autooldblock:: gnuradio.gr.stream_to_streams -.. autooldblock:: gnuradio.gr.stream_to_vector -.. autooldblock:: gnuradio.gr.streams_to_stream -.. autooldblock:: gnuradio.gr.streams_to_vector -.. autooldblock:: gnuradio.gr.vector_to_stream -.. autooldblock:: gnuradio.gr.vector_to_streams diff --git a/docs/sphinx/source/gr/source_blk.rst b/docs/sphinx/source/gr/source_blk.rst index df873bcf74..8e9f67980c 100644 --- a/docs/sphinx/source/gr/source_blk.rst +++ b/docs/sphinx/source/gr/source_blk.rst @@ -1,18 +1,8 @@ gnuradio.gr: Signal Sources =========================== -.. autooldblock:: gnuradio.gr.glfsr_source_b -.. autooldblock:: gnuradio.gr.glfsr_source_f .. autooldblock:: gnuradio.gr.lfsr_32k_source_s .. autooldblock:: gnuradio.gr.null_source -.. autooldblock:: gnuradio.gr.noise_source_c -.. autooldblock:: gnuradio.gr.noise_source_f -.. autooldblock:: gnuradio.gr.noise_source_i -.. autooldblock:: gnuradio.gr.noise_source_s -.. autooldblock:: gnuradio.gr.sig_source_c -.. autooldblock:: gnuradio.gr.sig_source_f -.. autooldblock:: gnuradio.gr.sig_source_i -.. autooldblock:: gnuradio.gr.sig_source_s .. autooldblock:: gnuradio.gr.vector_source_b .. autooldblock:: gnuradio.gr.vector_source_c .. autooldblock:: gnuradio.gr.vector_source_f diff --git a/docs/sphinx/source/gr/sync_blk.rst b/docs/sphinx/source/gr/sync_blk.rst index be9f908f73..d5e3c3d7c5 100644 --- a/docs/sphinx/source/gr/sync_blk.rst +++ b/docs/sphinx/source/gr/sync_blk.rst @@ -1,9 +1,4 @@ gnuradio.gr: Synchronization ============================ -.. autooldblock:: gnuradio.gr.pll_carriertracking_cc -.. autooldblock:: gnuradio.gr.pll_freqdet_cf -.. autooldblock:: gnuradio.gr.pll_refout_cc -.. autooldblock:: gnuradio.gr.pn_correlator_cc .. autooldblock:: gnuradio.gr.simple_correlator -.. autooldblock:: gnuradio.gr.simple_framer diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 38d859aafd..988b6554c5 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -11,13 +11,10 @@ Core Framework gnuradio.gr gnuradio.digital - gnuradio.blks2 gnuradio.audio gnuradio.trellis gnuradio.wavelet gnuradio.fft - gnuradio.window - gnuradio.optfir gnuradio.gr_unittest gnuradio.qtgui gnuradio.wxgui @@ -27,14 +24,11 @@ Core Framework gnuradio.gr <gr/index> gnuradio.digital <digital/index> - gnuradio.blks2 <blks2/index> gnuradio.audio <audio/index> gnuradio.gr_unittest <gr_unittest/index> - gnuradio.optfir <optfir/index> gnuradio.trellis <trellis/index> gnuradio.wavelet <wavelet> gnuradio.fft <fft> - gnuradio.window <window/index> gnuradio.qtgui <qtgui/index> gnuradio.wxgui <wxgui/index> diff --git a/docs/sphinx/source/qtgui/index.rst b/docs/sphinx/source/qtgui/index.rst index 83bdedca89..c6311d381a 100644 --- a/docs/sphinx/source/qtgui/index.rst +++ b/docs/sphinx/source/qtgui/index.rst @@ -3,7 +3,7 @@ gnuradio.qtgui .. automodule:: gnuradio.qtgui -.. autooldblock:: gnuradio.qtgui.sink_c -.. autooldblock:: gnuradio.qtgui.sink_f -.. autooldblock:: gnuradio.qtgui.time_sink_c -.. autooldblock:: gnuradio.qtgui.time_sink_f +.. autoblock:: gnuradio.qtgui.sink_c +.. autoblock:: gnuradio.qtgui.sink_f +.. autoblock:: gnuradio.qtgui.time_sink_c +.. autoblock:: gnuradio.qtgui.time_sink_f diff --git a/docs/sphinx/source/wavelet.rst b/docs/sphinx/source/wavelet.rst index 5236c4dbb2..679bab70c0 100644 --- a/docs/sphinx/source/wavelet.rst +++ b/docs/sphinx/source/wavelet.rst @@ -3,6 +3,6 @@ gnuradio.wavelet .. automodule:: gnuradio.wavelet -.. autooldblock:: gnuradio.wavelet.squash_ff -.. autooldblock:: gnuradio.wavelet.wavelet_ff -.. autooldblock:: gnuradio.wavelet.wvps_ff +.. autoblock:: gnuradio.wavelet.squash_ff +.. autoblock:: gnuradio.wavelet.wavelet_ff +.. autoblock:: gnuradio.wavelet.wvps_ff |