GNU Radio C++ API Reference: complex_to_mag_squared.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_BLOCKS_COMPLEX_TO_MAG_SQUARED_H
12#define INCLUDED_BLOCKS_COMPLEX_TO_MAG_SQUARED_H
13
14#include <gnuradio/blocks/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace blocks {
19
20/*!
21 * \brief complex in, magnitude squared out (float)
22 * \ingroup type_converters_blk
23 *
24 * \details
25 * Calculates the magnitude squared of the complex samples:
26 *
27 * \li output[0][m] = |input[0][m]|^2
28 *
29 * Or:
30 * \li output[0][m] = Re{input[0][m]}^2 + Im{input[0][m]}^2
31 *
32 * The input stream can be a vector of length \p vlen, and for
33 * each vector, each item is converted using the above
34 * function. So above, m is from 0 to noutput_items*vlen for each
35 * call to work.
36 */
37 class BLOCKS_API complex_to_mag_squared : virtual public sync_block
38{
39public:
40 // gr::blocks::complex_to_mag_squared_ff::sptr
41 typedef std::shared_ptr<complex_to_mag_squared> sptr;
42
43 /*!
44 * Build a complex to magnitude squared block.
45 *
46 * \param vlen vector len (default 1)
47 */
48 static sptr make(size_t vlen = 1);
49};
50
51} /* namespace blocks */
52} /* namespace gr */
53
54#endif /* INCLUDED_BLOCKS_COMPLEX_TO_MAG_SQUARED_H */
gr::blocks::complex_to_mag_squared
complex in, magnitude squared out (float)
Definition complex_to_mag_squared.h:38
gr::blocks::complex_to_mag_squared::sptr
std::shared_ptr< complex_to_mag_squared > sptr
Definition complex_to_mag_squared.h:41
gr::blocks::complex_to_mag_squared::make
static sptr make(size_t vlen=1)
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr::blocks
Definition abs_blk.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h