GNU Radio Manual and C++ API Reference  3.7.3
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
gr::blocks::complex_to_mag_squared Class Reference

complex in, magnitude squared out (float) More...

#include <gnuradio/blocks/complex_to_mag_squared.h>

Public Types

typedef boost::shared_ptr
< complex_to_mag_squared
sptr
 

Static Public Member Functions

static sptr make (size_t vlen=1)
 

Additional Inherited Members

- Public Member Functions inherited from gr::sync_block
virtual int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0
 just like gr::block::general_work, only this arranges to call consume_each for you More...
 
void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request. More...
 
int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items More...
 
int fixed_rate_ninput_to_noutput (int ninput)
 Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...
 
int fixed_rate_noutput_to_ninput (int noutput)
 Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...
 
- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
 
- Protected Member Functions inherited from gr::sync_block
 sync_block (void)
 
 sync_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
 
- Protected Attributes inherited from gr::block
std::vector< long > d_max_output_buffer
 
std::vector< long > d_min_output_buffer
 
gr::thread::mutex d_setlock
 
gr::logger_ptr d_logger
 
gr::logger_ptr d_debug_logger
 

Detailed Description

complex in, magnitude squared out (float)

Calculates the magnitude squared of the complex samples:

  • output[0][m] = |input[0][m]|^2

Or:

  • output[0][m] = Re{input[0][m]}^2 + Im{input[0][m]}^2

The input stream can be a vector of length vlen, and for each vector, each item is converted using the above function. So above, m is from 0 to noutput_items*vlen for each call to work.

Member Typedef Documentation

Member Function Documentation

static sptr gr::blocks::complex_to_mag_squared::make ( size_t  vlen = 1)
static

Build a complex to magnitude squared block.

Parameters
vlenvector len (default 1)

The documentation for this class was generated from the following file: