diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-03-07 10:30:32 -0500 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-03-07 10:30:32 -0500 |
| commit | 1ed37a35647ba0fbefcc2f0fa02748e77405d0ee (patch) | |
| tree | c47b42d9da6d41163adbf7141e89e25b4f731dcc | |
| parent | 242997af1838146a56547d8ac9e2719eadebe66f (diff) | |
blocks: did my best to provide some documentation for the bin_statistics block.
| -rw-r--r-- | gr-blocks/include/blocks/bin_statistics_f.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/gr-blocks/include/blocks/bin_statistics_f.h b/gr-blocks/include/blocks/bin_statistics_f.h index 2fc603067b..a73afc82d6 100644 --- a/gr-blocks/include/blocks/bin_statistics_f.h +++ b/gr-blocks/include/blocks/bin_statistics_f.h @@ -52,6 +52,17 @@ namespace gr { // gr::blocks::bin_statistics_f::sptr typedef boost::shared_ptr<bin_statistics_f> sptr; + /*! + * Build a bin statistics block. See qa_bin_statistics.py and + * gr-uhd/examples/python/usrp_spectrum_sense.py for examples of + * its use, specifically how to use the callback function. + * + * \param vlen vector length + * \param msgq message queue + * \param tune a gr_feval_dd callback function + * \param tune_delay number of samples for the tune delay + * \param dwell_delay number of samples for the dwell delay + */ static sptr make(unsigned int vlen, // vector length gr_msg_queue_sptr msgq, gr_feval_dd *tune, // callback |