GNU Radio Manual and C++ API Reference  3.10.9.1
The Free & Open Software Radio Ecosystem
mmse_resampler_ff.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2007,2012-2013 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * SPDX-License-Identifier: GPL-3.0-or-later
8  *
9  */
10 
11 #ifndef INCLUDED_MMSE_RESAMPLER_FF_H
12 #define INCLUDED_MMSE_RESAMPLER_FF_H
13 
14 #include <gnuradio/block.h>
15 #include <gnuradio/filter/api.h>
16 
17 namespace gr {
18 namespace filter {
19 
20 /*!
21  * \brief Resampling MMSE filter with float input, float output
22  * \ingroup resamplers_blk
23  *
24  * \details
25  * The resampling ratio and mu parameters can be set with a pmt dict
26  * message. Keys are pmt symbols with the strings "resamp_ratio" and "mu"
27  * and values are pmt floats.
28  */
29 
30 class FILTER_API mmse_resampler_ff : virtual public block
31 {
32 public:
33  // gr::filter::mmse_resampler_ff::sptr
34  typedef std::shared_ptr<mmse_resampler_ff> sptr;
35 
36  /*!
37  * \brief Build the resampling MMSE filter (float input, float output)
38  *
39  * \param phase_shift The phase shift of the output signal to the input
40  * \param resamp_ratio The resampling ratio = input_rate / output_rate.
41  */
42  static sptr make(float phase_shift, float resamp_ratio);
43 
44  virtual float mu() const = 0;
45  virtual float resamp_ratio() const = 0;
46  virtual void set_mu(float mu) = 0;
47  virtual void set_resamp_ratio(float resamp_ratio) = 0;
48 };
49 
50 } /* namespace filter */
51 } /* namespace gr */
52 
53 #endif /* INCLUDED_MMSE_RESAMPLER_FF_H */
The abstract base class for all 'terminal' processing blocks.
Definition: gnuradio-runtime/include/gnuradio/block.h:63
Resampling MMSE filter with float input, float output.
Definition: mmse_resampler_ff.h:31
virtual float mu() const =0
virtual void set_mu(float mu)=0
std::shared_ptr< mmse_resampler_ff > sptr
Definition: mmse_resampler_ff.h:34
virtual float resamp_ratio() const =0
virtual void set_resamp_ratio(float resamp_ratio)=0
static sptr make(float phase_shift, float resamp_ratio)
Build the resampling MMSE filter (float input, float output)
#define FILTER_API
Definition: gr-filter/include/gnuradio/filter/api.h:18
GNU Radio logging wrapper.
Definition: basic_block.h:29