summaryrefslogtreecommitdiff
path: root/gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h
diff options
context:
space:
mode:
authorJohnathan Corgan <johnathan@corganlabs.com>2013-05-13 07:36:16 +1000
committerJohnathan Corgan <johnathan@corganlabs.com>2013-05-13 07:36:16 +1000
commita4fe510a69190162452889cd629fa258084f46ff (patch)
tree4da725d8bad7641fb8d9db8b153e61beb313715d /gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h
parentc7a2cecdd4e9e04d66b4b20b9debce86696e6290 (diff)
parent2405532f945576470d1915a4668b91ff35c05775 (diff)
Merge branch 'next' into runtime_pimpl
Conflicts: gr-blocks/swig/blocks_swig0.i gr-digital/lib/ofdm_chanest_vcvc_impl.cc gr-digital/lib/ofdm_frame_equalizer_vcvc_impl.cc gr-digital/lib/ofdm_frame_equalizer_vcvc_impl.h gr-digital/lib/ofdm_sync_sc_cfb_impl.cc gr-digital/lib/packet_header_default.cc gr-digital/lib/packet_headerparser_b_impl.cc
Diffstat (limited to 'gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h')
-rw-r--r--gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h b/gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h
index e3f9975d8f..4ccc3896c9 100644
--- a/gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h
+++ b/gr-digital/include/gnuradio/digital/ofdm_chanest_vcvc.h
@@ -32,9 +32,8 @@ namespace gr {
/*!
* \brief Estimate channel and coarse frequency offset for OFDM from preambles
* \ingroup ofdm_blk
- * \ingroup synchronizers_blk
+ * \ingroup syncronizers_blk
*
- * \details
* Input: OFDM symbols (in frequency domain). The first one (or two) symbols are expected
* to be synchronisation symbols, which are used to estimate the coarse freq offset
* and the initial equalizer taps (these symbols are removed from the stream).
@@ -45,7 +44,9 @@ namespace gr {
* 'ofdm_sync_carr_offset' (integer), the coarse frequency offset as number of carriers,
* and 'ofdm_sync_eq_taps' (complex vector).
* Any tags attached to the synchronisation symbols are attached to the first data
- * symbol. All other tags are propagated normally.
+ * symbol. All other tags are propagated as expected.
+ *
+ * Note: The vector on ofdm_sync_eq_taps is already frequency-corrected, whereas the rest is not.
*
* This block assumes the frequency offset is even (i.e. an integer multiple of 2).
*
@@ -58,7 +59,7 @@ namespace gr {
public:
typedef boost::shared_ptr<ofdm_chanest_vcvc> sptr;
- /*
+ /*!
* \param sync_symbol1 First synchronisation symbol in the frequency domain. Its length must be
* the FFT length. For Schmidl & Cox synchronisation, every second sub-carrier
* has to be zero.