summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/gr/index.rst
blob: 3d32599f1dd36b52441922c7c3e8bbe2e580011a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
gnuradio.gr
===========

.. automodule:: gnuradio.gr

Signal Processing Blocks
------------------------

Top Block and Hierarchical Block Base Classes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autosummary::
   :nosignatures:
   
   gnuradio.gr.top_block
   gnuradio.gr.hier_block2

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
   gnuradio.gr.vector_source_i
   gnuradio.gr.vector_source_s
   gnuradio.gr.file_descriptor_source
   gnuradio.gr.file_source
   gnuradio.gr.message_source
   gnuradio.gr.udp_source
   gnuradio.gr.wavfile_source

Signal Sinks
^^^^^^^^^^^^

.. autosummary::
   :nosignatures:

   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
   gnuradio.gr.vector_sink_f
   gnuradio.gr.vector_sink_i
   gnuradio.gr.vector_sink_s
   gnuradio.gr.file_descriptor_sink
   gnuradio.gr.file_sink
   gnuradio.gr.histo_sink_f
   gnuradio.gr.message_sink
   gnuradio.gr.oscope_sink_f
   gnuradio.gr.udp_sink
   gnuradio.gr.wavfile_sink

Filters
^^^^^^^

.. autosummary::
   :nosignatures:

   gnuradio.gr.fft_filter_ccc
   gnuradio.gr.fft_filter_fff
   gnuradio.gr.filter_delay_fc
   gnuradio.gr.fir_filter_ccc
   gnuradio.gr.fir_filter_ccf
   gnuradio.gr.fir_filter_fcc
   gnuradio.gr.fir_filter_fff
   gnuradio.gr.fir_filter_fsf
   gnuradio.gr.fir_filter_scc
   gnuradio.gr.fractional_interpolator_cc
   gnuradio.gr.fractional_interpolator_ff
   gnuradio.gr.freq_xlating_fir_filter_ccc
   gnuradio.gr.freq_xlating_fir_filter_ccf
   gnuradio.gr.freq_xlating_fir_filter_fcc
   gnuradio.gr.freq_xlating_fir_filter_fcf
   gnuradio.gr.freq_xlating_fir_filter_scc
   gnuradio.gr.freq_xlating_fir_filter_scf
   gnuradio.gr.hilbert_fc
   gnuradio.gr.iir_filter_ffd
   gnuradio.gr.interp_fir_filter_ccc
   gnuradio.gr.interp_fir_filter_ccf
   gnuradio.gr.interp_fir_filter_fcc
   gnuradio.gr.interp_fir_filter_fff
   gnuradio.gr.interp_fir_filter_fsf
   gnuradio.gr.interp_fir_filter_scc
   gnuradio.gr.rational_resampler_base_ccc
   gnuradio.gr.rational_resampler_base_ccf
   gnuradio.gr.rational_resampler_base_fcc
   gnuradio.gr.rational_resampler_base_fff
   gnuradio.gr.rational_resampler_base_fsf
   gnuradio.gr.rational_resampler_base_scc
   gnuradio.gr.single_pole_iir_filter_cc
   gnuradio.gr.single_pole_iir_filter_ff
   gnuradio.gr.moving_average_cc
   gnuradio.gr.moving_average_ff
   gnuradio.gr.moving_average_ii
   gnuradio.gr.moving_average_ss
   gnuradio.gr.pfb_arb_resampler_ccf
   gnuradio.gr.pfb_channelizer_ccf
   gnuradio.gr.pfb_clock_sync_ccf
   gnuradio.gr.pfb_clock_sync_fff
   gnuradio.gr.pfb_decimator_ccf
   gnuradio.gr.pfb_interpolator_ccf

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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. 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
^^^^^^^^^^^^^^^

.. 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
^^^^^^^^^^^^^^^^

.. 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
   gnuradio.gr.complex_to_imag
   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
   gnuradio.gr.unpacked_to_packed_bb
   gnuradio.gr.unpacked_to_packed_ii
   gnuradio.gr.unpacked_to_packed_ss

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
   gnuradio.gr.mute_ss
   gnuradio.gr.peak_detector_fb
   gnuradio.gr.peak_detector_ib
   gnuradio.gr.peak_detector_sb
   gnuradio.gr.sample_and_hold_bb
   gnuradio.gr.sample_and_hold_ff
   gnuradio.gr.sample_and_hold_ii
   gnuradio.gr.sample_and_hold_ss

Fourier Transform
^^^^^^^^^^^^^^^^^

.. autosummary::
   :nosignatures:

   gnuradio.gr.goertzel_fc
   gnuradio.gr.fft_vcc
   gnuradio.gr.fft_vfc

Miscellaneous Blocks
^^^^^^^^^^^^^^^^^^^^

.. autosummary::
   :nosignatures:

   gnuradio.gr.copy
   gnuradio.gr.delay
   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

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
---------------------

.. autosummary::
   :nosignatures:

   gnuradio.gr.firdes
   gnuradio.gr.remez

Miscellaneous
-------------

.. autosummary::
   :nosignatures:

   gnuradio.gr.feval_dd
   gnuradio.gr.feval_cc
   gnuradio.gr.feval_ll
   gnuradio.gr.feval
   gnuradio.gr.prefs
   gnuradio.gr.test
   gnuradio.gr.message
   gnuradio.gr.msg_queue
   gnuradio.gr.enable_realtime_scheduling

Implementation Details
----------------------

.. autosummary::
   :nosignatures:

   gnuradio.gr.block_detail
   gnuradio.gr.buffer
   gnuradio.gr.dispatcher
   gnuradio.gr.single_threaded_scheduler