diff options
| author | Tom Rondeau <tom@trondeau.com> | 2013-11-23 20:01:19 -0500 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2013-11-23 20:01:19 -0500 |
| commit | 424c8d2ea4a48125ec3226af1514a5787c9a157e (patch) | |
| tree | d4e46bb8a2a3184e656a311d8c3f7427d647035b /gr-blocks/include/gnuradio/blocks/complex_to_mag.h | |
| parent | c76c10d43f0c7a086700fcc8c6dc8740243aa745 (diff) | |
docs: fixed/modifying/adding documentation for blocks a-l.
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/complex_to_mag.h')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/complex_to_mag.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/complex_to_mag.h b/gr-blocks/include/gnuradio/blocks/complex_to_mag.h index 9089b7ce6f..d6023a7681 100644 --- a/gr-blocks/include/gnuradio/blocks/complex_to_mag.h +++ b/gr-blocks/include/gnuradio/blocks/complex_to_mag.h @@ -32,6 +32,19 @@ namespace gr { /*! * \brief complex in, magnitude out (float) * \ingroup type_converters_blk + * + * \details + * Calculates the magnitude of the complex samples: + * + * \li output[0][m] = |input[0][m]| + * + * Or: + * \li output[0][m] = sqrt(Re{input[0][m]}^2 + Im{input[0][m]}^2) + * + * The input stream can be a vector of length \p 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. */ class BLOCKS_API complex_to_mag : virtual public sync_block { |