GNU Radio 3.7.2.1 C++ API
complex_to_mag_squared.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 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
#ifndef INCLUDED_BLOCKS_COMPLEX_TO_MAG_SQUARED_H
24
#define INCLUDED_BLOCKS_COMPLEX_TO_MAG_SQUARED_H
25
26
#include <
gnuradio/blocks/api.h
>
27
#include <
gnuradio/sync_block.h
>
28
29
namespace
gr {
30
namespace
blocks {
31
32
/*!
33
* \brief complex in, magnitude squared out (float)
34
* \ingroup type_converters_blk
35
*
36
* \details
37
* Calculates the magnitude squared of the complex samples:
38
*
39
* \li output[0][m] = |input[0][m]|^2
40
*
41
* Or:
42
* \li output[0][m] = Re{input[0][m]}^2 + Im{input[0][m]}^2
43
*
44
* The input stream can be a vector of length \p vlen, and for
45
* each vector, each item is converted using the above
46
* function. So above, m is from 0 to noutput_items*vlen for each
47
* call to work.
48
*/
49
class
BLOCKS_API
complex_to_mag_squared
:
virtual
public
sync_block
50
{
51
public
:
52
// gr::blocks::complex_to_mag_squared_ff::sptr
53
typedef
boost::shared_ptr<complex_to_mag_squared>
sptr
;
54
55
/*!
56
* Build a complex to magnitude squared block.
57
*
58
* \param vlen vector len (default 1)
59
*/
60
static
sptr
make(
size_t
vlen=1);
61
};
62
63
}
/* namespace blocks */
64
}
/* namespace gr */
65
66
#endif
/* INCLUDED_BLOCKS_COMPLEX_TO_MAG_SQUARED_H */
gnuradio
gr-blocks
include
gnuradio
blocks
complex_to_mag_squared.h
Generated by
1.8.3.1