Difference between revisions of "Multiply by Matrix"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Matrix multiplexer/multiplier: y(k) = A x(k)
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
This block is similar to gr::blocks::multiply_const_ff, the difference being it can handle several inputs and outputs, and the input-to-output relation can be described by the following mathematical equation:
 +
y(k) = A x(k)
 +
y in R^n, x in R^m, A in R^n*m
 +
y(k) and x(k) are column-vectors describing the elements on the input port at time step k(this is a sync block with no memory).
 +
 
 +
Examples for where to use this block include:
 +
* Switch matrices (i.e. switch which ports go where), assuming all ports run on the same rate
 +
* Simulation of static MIMO-Channels (in that case, A is the channel matrix)
 +
* Summing up streams with variable coefficients
 +
 
 +
This block as one input message port. A message sent to this port will be converted to a std::vector<std::vector<T> >, and then passed on to set_A(). If no conversion is possible, a warning is issued via the logging interface, and A remains unchanged.
 +
 
 +
Note : It is not possible to change the dimension of the matrix after initialization, as this affects the I/O signature! If a matrix of invalid size is passed to the block, an alert is raised via the logging interface, and A remains unchanged.
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Param 1 (''R'')
+
; Matrix A (''R'')
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
+
: The matrix
  
; Param 2
+
; TPP
: blah blah blah
+
: The tag propagation policy.  When setting the tag propagation policy to Matrix-defined, a tag is propagated from input k to output l, if A(l,k) != 0.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 32:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/multiply_matrix_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/multiply_matrix_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/multiply_matrix.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_multiply_matrix_xx.block.yml]

Revision as of 16:00, 23 August 2019

Matrix multiplexer/multiplier: y(k) = A x(k)

This block is similar to gr::blocks::multiply_const_ff, the difference being it can handle several inputs and outputs, and the input-to-output relation can be described by the following mathematical equation: y(k) = A x(k) y in R^n, x in R^m, A in R^n*m y(k) and x(k) are column-vectors describing the elements on the input port at time step k(this is a sync block with no memory).

Examples for where to use this block include:

  • Switch matrices (i.e. switch which ports go where), assuming all ports run on the same rate
  • Simulation of static MIMO-Channels (in that case, A is the channel matrix)
  • Summing up streams with variable coefficients

This block as one input message port. A message sent to this port will be converted to a std::vector<std::vector<T> >, and then passed on to set_A(). If no conversion is possible, a warning is issued via the logging interface, and A remains unchanged.

Note : It is not possible to change the dimension of the matrix after initialization, as this affects the I/O signature! If a matrix of invalid size is passed to the block, an alert is raised via the logging interface, and A remains unchanged.

Parameters

(R): Run-time adjustable

Matrix A (R)
The matrix
TPP
The tag propagation policy. When setting the tag propagation policy to Matrix-defined, a tag is propagated from input k to output l, if A(l,k) != 0.

Example Flowgraph

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]