GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
fractional_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 * 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_FRACTIONAL_RESAMPLER_FF_H
24#define INCLUDED_FRACTIONAL_RESAMPLER_FF_H
25
26#include <gnuradio/block.h>
27#include <gnuradio/filter/api.h>
28
29namespace gr {
30namespace filter {
31
32/*!
33 * \brief Resampling MMSE filter with float input, float output
34 * \ingroup resamplers_blk
35 *
36 * \details
37 * The resampling ratio and mu parameters can be set with a pmt dict
38 * message. Keys are pmt symbols with the strings "resamp_ratio" and "mu"
39 * and values are pmt floats.
40 */
41
43{
44public:
45 // gr::filter::fractional_resampler_ff::sptr
46 typedef boost::shared_ptr<fractional_resampler_ff> sptr;
47
48 /*!
49 * \brief Build the resampling MMSE filter (float input, float output)
50 *
51 * \param phase_shift The phase shift of the output signal to the input
52 * \param resamp_ratio The resampling ratio = input_rate / output_rate.
53 */
54 static sptr make(float phase_shift, float resamp_ratio);
55
56 virtual float mu() const = 0;
57 virtual float resamp_ratio() const = 0;
58 virtual void set_mu(float mu) = 0;
59 virtual void set_resamp_ratio(float resamp_ratio) = 0;
60};
61
62} /* namespace filter */
63} /* namespace gr */
64
65#endif /* INCLUDED_FRACTIONAL_RESAMPLER_FF_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
Resampling MMSE filter with float input, float output.
Definition: fractional_resampler_ff.h:43
virtual void set_resamp_ratio(float resamp_ratio)=0
boost::shared_ptr< fractional_resampler_ff > sptr
Definition: fractional_resampler_ff.h:46
virtual float resamp_ratio() const =0
virtual float mu() const =0
static sptr make(float phase_shift, float resamp_ratio)
Build the resampling MMSE filter (float input, float output)
virtual void set_mu(float mu)=0
#define FILTER_API
Definition: gr-filter/include/gnuradio/filter/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45