GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
fastnoise_source_f.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2013 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_FASTNOISE_SOURCE_F_H
26#define INCLUDED_ANALOG_FASTNOISE_SOURCE_F_H
27
28#include <gnuradio/analog/api.h>
30#include <gnuradio/sync_block.h>
31
32#include <vector>
33
34namespace gr {
35 namespace analog {
36
37 /*!
38 * \brief Random number source
39 * \ingroup source_blk
40 *
41 * \details
42 * Generate random values from different distributions.
43 * Currently, only Gaussian and uniform are enabled.
44 */
46 {
47 public:
48 // gr::analog::fastnoise_source_f::sptr
49 typedef boost::shared_ptr<fastnoise_source_f> sptr;
50
51 /*! \brief Make a fast noise source
52 * \param type the random distribution to use (see
53 * gnuradio/analog/noise_type.h)
54 * \param ampl the standard deviation of a 1-d noise process. If
55 * this is the complex source, this parameter is split
56 * among the real and imaginary parts:
57 * <pre>(ampl/sqrt(2))x + j(ampl/sqrt(2))y</pre>
58 * \param seed seed for random generators. Note that for uniform
59 * and Gaussian distributions, this should be a negative
60 * number.
61 * \param samples Number of samples to pre-generate
62 */
63 static sptr make(noise_type_t type, float ampl,
64 long seed = 0, long samples=1024*16);
65 virtual float sample() = 0;
66 virtual float sample_unbiased() = 0;
67 virtual const std::vector<float>& samples() const = 0;
68
69 /*!
70 * Set the noise type. Nominally from the
71 * gr::analog::noise_type_t selections, but only GR_GAUSSIAN and
72 * GR_UNIFORM are currently available.
73 */
74 virtual void set_type(noise_type_t type) = 0;
75
76 /*!
77 * Set the standard deviation (amplitude) of the 1-d noise
78 * process.
79 */
80 virtual void set_amplitude(float ampl) = 0;
81
82 virtual noise_type_t type() const = 0;
83 virtual float amplitude() const = 0;
84 };
85
86 } /* namespace analog */
87} /* namespace gr */
88
89
90#endif /* INCLUDED_ANALOG_FASTNOISE_SOURCE_F_H */
Random number source.
Definition: fastnoise_source_f.h:46
virtual void set_amplitude(float ampl)=0
virtual float amplitude() const =0
virtual const std::vector< float > & samples() const =0
virtual noise_type_t type() const =0
virtual float sample_unbiased()=0
virtual void set_type(noise_type_t type)=0
boost::shared_ptr< fastnoise_source_f > sptr
Definition: fastnoise_source_f.h:49
static sptr make(noise_type_t type, float ampl, long seed=0, long samples=1024 *16)
Make a fast noise source.
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