Difference between revisions of "Correlation Estimator"

From GNU Radio
Jump to: navigation, 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...")
 
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Correlates the input signal against the provided vector of samples and outputs a phase and symbol timing estimate.
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.
 
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Param 1 (''R'')
+
; Symbols
: 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).
+
: Set of symbols to correlate against (e.g., a sync word).
 +
 
 +
; Samples per Symbol
 +
: Samples per symbol
 +
 
 +
; Tag Marking Delay (''R'')
 +
: Tag marking delay in samples after the corr_start tag
 +
 
 +
; Threshold (''R'')
 +
: Threshold of correlator, relative to a 100% correlation (1.0). Default is 0.9.
  
; Param 2
+
; Threshold Method
: blah blah blah
+
: Method for computing threshold.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==

Latest revision as of 23:55, 17 August 2019

Correlates the input signal against the provided vector of samples and outputs a phase and symbol timing estimate.

Parameters[edit]

(R): Run-time adjustable

Symbols
Set of symbols to correlate against (e.g., a sync word).
Samples per Symbol
Samples per symbol
Tag Marking Delay (R)
Tag marking delay in samples after the corr_start tag
Threshold (R)
Threshold of correlator, relative to a 100% correlation (1.0). Default is 0.9.
Threshold Method
Method for computing threshold.

Example Flowgraph[edit]

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.

Source Files[edit]

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO