GNU Radio 3.6.5 C++ API

gr_fastnoise_source_f.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 // WARNING: this file is machine generated. Edits will be overwritten
00024 
00025 #ifndef INCLUDED_GR_GR_FASTNOISE_SOURCE_F_H
00026 #define INCLUDED_GR_GR_FASTNOISE_SOURCE_F_H
00027 
00028 #include <gr_core_api.h>
00029 #include <gr_sync_block.h>
00030 #include <gr_noise_type.h>
00031 #include <gr_random.h>
00032 
00033 
00034 class gr_fastnoise_source_f;
00035 typedef boost::shared_ptr<gr_fastnoise_source_f> gr_fastnoise_source_f_sptr;
00036 
00037 /*! \brief Make a noise source
00038  * \param type  the random distribution to use (see gr_noise_type.h)
00039  * \param ampl  a scaling factor for the output
00040  * \param seed seed for random generators. Note that for uniform and
00041  * Gaussian distributions, this should be a negative number.
00042  * \param samples number of samples to pre-generate.
00043  */
00044 GR_CORE_API gr_fastnoise_source_f_sptr
00045 gr_make_fastnoise_source_f (gr_noise_type_t type, float ampl, long seed = 0, long samples=1024*16);
00046 
00047 /*!
00048  * \brief Random number source
00049  * \ingroup source_blk
00050  *
00051  * \details
00052  * Generate random values from different distributions.
00053  * Currently, only Gaussian and uniform are enabled.
00054  *
00055  * \param type  the random distribution to use (see gr_noise_type.h)
00056  * \param ampl  a scaling factor for the output
00057  * \param seed seed for random generators. Note that for uniform and
00058  * Gaussian distributions, this should be a negative number.
00059  * \param samples number of samples to pre-generate.
00060  */
00061 class GR_CORE_API gr_fastnoise_source_f : public gr_sync_block {
00062   friend GR_CORE_API gr_fastnoise_source_f_sptr
00063 
00064   gr_make_fastnoise_source_f (gr_noise_type_t type, float ampl, long seed, long samples);
00065 
00066   gr_noise_type_t       d_type;
00067   float                 d_ampl;
00068   gr_random             d_rng;
00069   std::vector<float> d_samples;
00070 
00071   gr_fastnoise_source_f (gr_noise_type_t type, float ampl, long seed = 0, long samples=1024*16);
00072 
00073  public:
00074   void set_type (gr_noise_type_t type) { d_type = type; generate(); }
00075   void set_amplitude (float ampl) { d_ampl = ampl; generate(); }
00076   void generate();
00077 
00078   gr_noise_type_t type () const { return d_type; }
00079   float amplitude () const { return d_ampl; }
00080 
00081   virtual int work (int noutput_items,
00082                          gr_vector_const_void_star &input_items,
00083                          gr_vector_void_star &output_items);
00084 };
00085 
00086 
00087 #endif