gr-baz Package
baz_colouriser.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,2012 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_BAZ_COLOURISER_H
24 #define INCLUDED_BAZ_COLOURISER_H
25 
26 #include <gnuradio/block.h>
27 
28 namespace gr {
29  namespace baz {
30 
31  /*!
32  * \brief Detect the peak of a signal
33  * \ingroup peak_detectors_blk
34  *
35  * \details
36  * If a peak is detected, this block outputs a 1,
37  * or it outputs 0's.
38  */
39  class BAZ_API colouriser : virtual public block
40  {
41  public:
42  // gr::baz::colouriser::sptr
43  typedef boost::shared_ptr<colouriser> sptr;
44 
45  static sptr make(float ref_lvl = 1.0, float dyn_rng = 1.0, int vlen_in = 1, bool verbose = false);
46 
47  virtual void set_dyn_rng(float dyn_rng) = 0;
48  virtual void set_ref_lvl(float ref_lvl) = 0;
49 
50  //virtual float gain() const = 0;
51  };
52 
53  } /* namespace baz */
54 } /* namespace gr */
55 
56 #endif /* INCLUDED_BAZ_COLOURISER_H */
Definition: baz_additive_scrambler_bb.h:28
#define BAZ_API
Definition: config.h:8
boost::shared_ptr< colouriser > sptr
Definition: baz_colouriser.h:43
Detect the peak of a signal.
Definition: baz_colouriser.h:39