Weberni69795
/
BCIgui
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7 Commits
3 Branches
Branch: dev
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'dev'
${ noResults }
BCIgui/Masterarbeit/openvibe/sdk-master/plugins/processing/streaming/doc/Doc_BoxAlgorithm_SignalMerg...

Doc_BoxAlgorithm_SignalMerger.dox-part 2.5KB
Raw Permalink Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 
  1. /**

  2.  * \page BoxAlgorithm_SignalMerger Signal Merger

  3. __________________________________________________________________

  4. 

  5. Detailed description

  6. __________________________________________________________________

  7. 

  8.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Description|

  9.  * This box merges several input streams in a single output stream. For instance,

  10.  * if this box has two inputs with 8 channels each, the output will contain 16 channels.

  11.  *

  12.  * It important to note that the input streams must have the same structure. That is

  13.  * same sampling rate, same number of samples per buffer, and similar chunks dates.

  14.  *

  15.  * The output channel order is as follows :

  16.  *  - n channels from input 1 (in the same order as in input 1)

  17.  *  - m channels from input 2

  18.  *  - ...

  19.  *  - p channels from input N

  20.  *

  21.  * Such box has initially been proposed by Matthieu Goyat and Guillaume Lio but it

  22.  * has been completely reimplemented in march 2011 because of unpredictable behaviors in

  23.  * some conditions.

  24.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Description|

  25. __________________________________________________________________

  26. 

  27. Inputs description

  28. __________________________________________________________________

  29. 

  30.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Inputs|

  31.  * This box can receive as many inputs as necessary.

  32.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Inputs|

  33. 

  34.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Input1|

  35.  * The first input stream.

  36.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Input1|

  37. 

  38.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Input2|

  39.  * The second input stream.

  40.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Input2|

  41. __________________________________________________________________

  42. 

  43. Outputs description

  44. __________________________________________________________________

  45. 

  46.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Outputs|

  47.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Outputs|

  48. 

  49.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Output1|

  50.  * The output stream contains all the channels grabbed from the different input streams.

  51.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Output1|

  52. __________________________________________________________________

  53. 

  54. Examples description

  55. __________________________________________________________________

  56. 

  57.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Examples|

  58.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Examples|

  59. __________________________________________________________________

  60. 

  61. Miscellaneous description

  62. __________________________________________________________________

  63. 

  64.  * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Miscellaneous|

  65.  * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Miscellaneous|

  66.  */