GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
noise_source_f.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,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// WARNING: this file is machine generated. Edits will be overwritten
24
25#ifndef INCLUDED_ANALOG_NOISE_SOURCE_F_H
26#define INCLUDED_ANALOG_NOISE_SOURCE_F_H
27
28#include <gnuradio/analog/api.h>
30#include <gnuradio/sync_block.h>
31
32namespace gr {
33 namespace analog {
34
35 /*!
36 * \brief Random number source
37 * \ingroup waveform_generators_blk
38 *
39 * \details
40 * Generate random values from different distributions.
41 * Currently, only Gaussian and uniform are enabled.
42 */
43 class ANALOG_API noise_source_f : virtual public sync_block
44 {
45 public:
46 // gr::analog::noise_source_f::sptr
47 typedef boost::shared_ptr<noise_source_f> sptr;
48
49 /*! Build a noise source
50 * \param type the random distribution to use (see
51 * gnuradio/analog/noise_type.h)
52 * \param ampl the standard deviation of a 1-d noise process. If
53 * this is the complex source, this parameter is split
54 * among the real and imaginary parts:
55 * <pre>(ampl/sqrt(2))x + j(ampl/sqrt(2))y</pre>
56 * \param seed seed for random generators. Note that for uniform
57 * and Gaussian distributions, this should be a negative
58 * number.
59 */
60 static sptr make(noise_type_t type, float ampl, long seed=0);
61
62 /*!
63 * Set the noise type. Nominally from the
64 * gr::analog::noise_type_t selections, but only GR_GAUSSIAN and
65 * GR_UNIFORM are currently available.
66 */
67 virtual void set_type(noise_type_t type) = 0;
68
69 /*!
70 * Set the standard deviation (amplitude) of the 1-d noise
71 * process.
72 */
73 virtual void set_amplitude(float ampl) = 0;
74
75 virtual noise_type_t type() const = 0;
76 virtual float amplitude() const = 0;
77 };
78
79 } /* namespace analog */
80} /* namespace gr */
81
82#endif /* INCLUDED_ANALOG_NOISE_SOURCE_F_H */
Random number source.
Definition: noise_source_f.h:44
virtual void set_amplitude(float ampl)=0
virtual void set_type(noise_type_t type)=0
boost::shared_ptr< noise_source_f > sptr
Definition: noise_source_f.h:47
virtual noise_type_t type() const =0
virtual float amplitude() const =0
static sptr make(noise_type_t type, float ampl, long seed=0)
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30
noise_type_t
Definition: noise_type.h:29
Include this header to use the message passing features.
Definition: basic_block.h:45