PN Correlator: 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)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
PN code sequential search correlator.
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.
Receives complex baseband signal, outputs complex correlation against reference PN code, one sample per PN code period. The PN sequence is generated using a GLFSR.


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


; Param 1 (''R'')
; Degree
: 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).
: Degree of shift register must be in [1, 32]. If mask is 0, the degree determines a default mask (see digital_impl_glfsr.cc for the mapping).


; Param 2
; Mask
: blah blah blah
: Allows a user-defined bit mask for indexes of the shift register to feed back.
 
; Seed
: Initial setting for values in shift register.


== Example Flowgraph ==
== Example Flowgraph ==
 
[[File:Pn_correlator_fg.png|800px]]
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.
<p>This flowgraph can be downloaded from [[Media:Pn_correlator.grc]].</p>


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


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/pn_correlator_cc_impl.cc pn_correlator_cc_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/pn_correlator_cc_impl.h pn_correlator_cc_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/include/gnuradio/digital/pn_correlator_cc.h pn_correlator_cc.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/grc/digital_pn_correlator_cc.block.yml digital_pn_correlator_cc.block.yml]

Latest revision as of 19:02, 1 May 2025

PN code sequential search correlator.

Receives complex baseband signal, outputs complex correlation against reference PN code, one sample per PN code period. The PN sequence is generated using a GLFSR.

Parameters

Degree
Degree of shift register must be in [1, 32]. If mask is 0, the degree determines a default mask (see digital_impl_glfsr.cc for the mapping).
Mask
Allows a user-defined bit mask for indexes of the shift register to feed back.
Seed
Initial setting for values in shift register.

Example Flowgraph

Pn correlator fg.png

This flowgraph can be downloaded from Media:Pn_correlator.grc.

Source Files

C++ files
pn_correlator_cc_impl.cc
Header files
pn_correlator_cc_impl.h
Public header files
pn_correlator_cc.h
Block definition
digital_pn_correlator_cc.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=PN_Correlator&oldid=15006"