GNU Radio 3.7.2.1-77 C++ API
freq_xlating_fir_filter_scf.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2002,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
/*
24
* WARNING: This file is automatically generated by cmake.
25
* Any changes made to this file will be overwritten.
26
*/
27
28
#ifndef INCLUDED_FILTER_FREQ_XLATING_FIR_FILTER_SCF_H
29
#define INCLUDED_FILTER_FREQ_XLATING_FIR_FILTER_SCF_H
30
31
#include <
gnuradio/filter/api.h
>
32
#include <
gnuradio/sync_decimator.h
>
33
34
namespace
gr {
35
namespace
filter {
36
37
38
/*!
39
* \brief FIR filter combined with frequency translation with
40
* short input, gr_complex output and float taps
41
*
42
* \ingroup channelizers_blk
43
*
44
* This class efficiently combines a frequency translation
45
* (typically "down conversion") with a FIR filter (typically
46
* low-pass) and decimation. It is ideally suited for a "channel
47
* selection filter" and can be efficiently used to select and
48
* decimate a narrow band signal out of wide bandwidth input.
49
*
50
* Uses a single input array to produce a single output array.
51
* Additional inputs and/or outputs are ignored.
52
*/
53
class
FILTER_API
freq_xlating_fir_filter_scf
:
virtual
public
sync_decimator
54
{
55
public
:
56
// gr::filter::freq_xlating_fir_filter_scf::sptr
57
typedef
boost::shared_ptr<freq_xlating_fir_filter_scf>
sptr
;
58
59
/*!
60
* \brief FIR filter with short input, gr_complex output, and
61
* float taps that also frequency translates a signal from
62
* \p center_freq.
63
*
64
* Construct a FIR filter with the given taps and a composite
65
* frequency translation that shifts center_freq down to zero
66
* Hz. The frequency translation logically comes before the
67
* filtering operation.
68
*
69
* \param decimation set the integer decimation rate
70
* \param taps a vector/list of taps of type float
71
* \param center_freq Center frequency of signal to down convert from (Hz)
72
* \param sampling_freq Sampling rate of signal (in Hz)
73
*/
74
static
sptr
make(
int
decimation,
75
const
std::vector<float> &
taps
,
76
double
center_freq,
77
double
sampling_freq);
78
79
virtual
void
set_center_freq(
double
center_freq) = 0;
80
virtual
double
center_freq()
const
= 0;
81
82
virtual
void
set_taps(
const
std::vector<float> &
taps
) = 0;
83
virtual
std::vector<float>
taps
()
const
= 0;
84
};
85
86
}
/* namespace filter */
87
}
/* namespace gr */
88
89
#endif
/* INCLUDED_FILTER_FREQ_XLATING_FIR_FILTER_SCF_H */
gr-filter
include
gnuradio
filter
freq_xlating_fir_filter_scf.h
Generated by
1.8.3.1