init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,82 @@
+.. _Doc_BoxAlgorithm_ClockStimulator:
+
+Clock stimulator
+================
+
+.. container:: attribution
+
+   :Author:
+      Yann Renard
+   :Company:
+      INRIA/IRISA
+
+.. image:: images/Doc_BoxAlgorithm_ClockStimulator.png
+
+Triggers stimulation at fixed frequency
+
+This box produces stimulations at specific times depending on
+its configuration. The stimulation interval is fixed.
+
+It is important to underline that this box runs as fast as possible
+thus producing empty :ref:`Doc_Streams_Stimulation` chunks when needed.
+
+Outputs
+-------
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Generated stimulations", "Stimulations"
+
+Generated stimulations
+~~~~~~~~~~~~~~~~~~~~~~
+
+This output contains the generated stimulation stream.
+
+.. _Doc_BoxAlgorithm_ClockStimulator_Settings:
+
+Settings
+--------
+
+.. csv-table::
+   :header: "Setting Name", "Type", "Default Value"
+
+   "Interstimulation interval (in sec)", "Float", "1.0"
+   "Stimulation", "Stimulation", "OVTK_StimulationId_Label_00"
+
+Interstimulation interval (in sec)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The first setting :math:`i` informs the box how often it should produce stimulations, with :math:`i > 0`.
+
+Stimulation
+~~~~~~~~~~~
+
+The second setting gives the stimulation code to trigger.
+
+.. _Doc_BoxAlgorithm_ClockStimulator_Examples:
+
+Examples
+--------
+
+In the designer, drag'n drop a :ref:`Doc_BoxAlgorithm_StimulationListener`
+and connect it to a clock stimulator box. Configure it to your preferred
+active log level, press start and see what happens.
+
+The output should like this :
+
+.. code::
+
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 4294967296 (0x100000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 8589934592 (0x200000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 12884901888 (0x300000000) and duration 0 (0x0)
+   ...
+
+.. _Doc_BoxAlgorithm_ClockStimulator_Miscellaneous:
+
+Miscellaneous
+-------------
+
+Notice that no stimulation is sent a time 0. The first stimulation to be sent
+has the inter stimulation duration as date.
+
@@ -0,0 +1,57 @@
+.. _Doc_BoxAlgorithm_PlayerController:
+
+Player Controller
+=================
+
+.. container:: attribution
+
+   :Author:
+      Yann Renard
+   :Company:
+      INRIA
+
+
+.. image:: images/Doc_BoxAlgorithm_PlayerController.png
+
+This box can execute one of these actions on the current player instance on a trigger:
+
+- Play
+- Fast Forward
+- Pause
+- Stop
+
+The box triggers upon receiving a specific stimulation on the Stimulations
+input.
+
+Due to the nature of the triggers, Play and Fast Forward actions can only be
+used while the player is actually playing or in fast forward.
+
+Inputs
+------
+
+.. csv-table::
+   :header: "Input Name", "Stream Type"
+
+   "Stimulations", "Stimulations"
+
+.. _Doc_BoxAlgorithm_PlayerController_Settings:
+
+Settings
+--------
+
+.. csv-table::
+   :header: "Setting Name", "Type", "Default Value"
+
+   "Stimulation name", "Stimulation", "OVTK_StimulationId_Label_00"
+   "Action to perform", "Player Action", "Pause"
+
+Stimulation name
+~~~~~~~~~~~~~~~~
+
+Input stimulation to react to
+
+Action to perform
+~~~~~~~~~~~~~~~~~
+
+Scenario player action to perform when stimulation is received. The options are 'forward', 'pause', 'play' and 'stop'.
+
@@ -0,0 +1,102 @@
+.. _Doc_BoxAlgorithm_StimulationMultiplexer:
+
+Stimulation multiplexer
+=======================
+
+.. container:: attribution
+
+   :Author:
+      Yann Renard
+   :Company:
+      INRIA/IRISA
+
+
+.. image:: images/Doc_BoxAlgorithm_StimulationMultiplexer.png
+
+The stimulations are ordered according to their start date. Thus each time all the input have chunks covering a period of time, a new output chunk is sent. This box may eventually produce output chunk reflecting a different duration depending on the inputs.
+
+The Stimulation multiplexer box algorithm merges several stimulation streams
+into one stimulation stream. The contained stimulations are ordered
+according to their start date. Thus each time all the input have chunks
+covering a period of time, a new output chunk is sent. This box may eventually
+produce output chunk reflecting a different duration depending on the inputs.
+
+Inputs
+------
+
+.. csv-table::
+   :header: "Input Name", "Stream Type"
+
+   "Input stimulations 1", "Stimulations"
+   "Input stimulations 2", "Stimulations"
+
+This box can receive as many input as necessary. All the inputs
+will be of type :ref:`Doc_Streams_Stimulation` in order to
+be parsed by this the reader. Every input have to be connected
+for this box to work correctly
+
+Input stimulations 1
+~~~~~~~~~~~~~~~~~~~~
+
+This is the first default input of this box.
+
+Input stimulations 2
+~~~~~~~~~~~~~~~~~~~~
+
+This is the second default input of this box.
+
+Outputs
+-------
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Multiplexed stimulations", "Stimulations"
+
+Multiplexed stimulations
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The output of this box is a new :ref:`Doc_Streams_Stimulation`
+that contains all the stimulation of respective inputs. The
+input streams are multiplexed in a single stream ordering the
+stimulations according to their starting time.
+
+.. _Doc_BoxAlgorithm_StimulationMultiplexer_Examples:
+
+Examples
+--------
+
+To illustrate this box, just drag'n drop a :ref:`Doc_BoxAlgorithm_KeyboardStimulator`,
+a :ref:`Doc_BoxAlgorithm_ClockStimulator` and a :ref:`Doc_BoxAlgorithm_StimulationListener`
+box. Connect the two stimulation generators to your stimulation
+multiplexer and connect the output of the stimulation multiplexer
+to the stimulation listener. Leave the default parameters for all
+of those boxes, except the clock stimulator which you'll configure
+with an \e OVTK_StimulationId_Beep stimulation. Now pres 'start'.
+
+You should see something like this :
+
+.. code::
+
+   ...
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33282 (0x8202)[OVTK_StimulationId_Beep] at date 4294967296 (0x100000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33025 (0x8101)[OVTK_StimulationId_Label_01] at date 8187281408 (0x1e8000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33282 (0x8202)[OVTK_StimulationId_Beep] at date 8589934592 (0x200000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 8992587776 (0x218000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33026 (0x8102)[OVTK_StimulationId_Label_02] at date 12213813248 (0x2d8000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33282 (0x8202)[OVTK_StimulationId_Beep] at date 12884901888 (0x300000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33282 (0x8202)[OVTK_StimulationId_Beep] at date 17179869184 (0x400000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 18924699648 (0x468000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33282 (0x8202)[OVTK_StimulationId_Beep] at date 21474836480 (0x500000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33027 (0x8103)[OVTK_StimulationId_Label_03] at date 23756537856 (0x588000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 24561844224 (0x5b8000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33282 (0x8202)[OVTK_StimulationId_Beep] at date 25769803776 (0x600000000) and duration 0 (0x0)
+   [  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33282 (0x8202)[OVTK_StimulationId_Beep] at date 30064771072 (0x700000000) and duration 0 (0x0)
+   ...
+
+In this session, I pressed \e z, \e z and \e a successively, causing
+an \e OVTK_StimulationId_Label_0x stimulation to be sent at key pressed
+time, and an \e OVTK_StimulationId_Label_00 stimulation to be sent at key
+release time. Inserted in those stimulations are several \e OVTK_StimulationId_Beep
+stimulations coming from the clock stimulator.
+
@@ -0,0 +1,107 @@
+.. _Doc_BoxAlgorithm_StimulationVoter:
+
+Stimulation Voter
+=================
+
+.. container:: attribution
+
+   :Author:
+      Jussi T. Lindgren
+   :Company:
+      Inria
+
+.. image:: images/Doc_BoxAlgorithm_StimulationVoter.png
+
+Votes the most frequent stimulus ID in a given time window. Outputs the winning stimulus type. Several options are possible. To process multiple inputs, use Stimulation Multiplexer first.
+
+This box reads all the incoming stimuli a stimulus channel and returns the stimulus ID with the highest number of occurrences. Some constraints can be specified as box parameters.
+
+Inputs
+------
+
+.. csv-table::
+   :header: "Input Name", "Stream Type"
+
+   "Stimulus input", "Stimulations"
+
+Collects the stimuli from a single input. To use several inputs, combine them first with Stimulation Multiplexer. 
+
+Stimulus input
+~~~~~~~~~~~~~~
+
+Input stream, can include any stimuli.
+
+Outputs
+-------
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Selected stimulus", "Stimulations"
+
+Selected stimulus
+~~~~~~~~~~~~~~~~~
+
+The output sends a new stimulation as soon as the most frequent stimulus type passes the criteria specified by the box parameters.
+
+.. _Doc_BoxAlgorithm_StimulationVoter_Settings:
+
+Settings
+--------
+
+.. csv-table::
+   :header: "Setting Name", "Type", "Default Value"
+
+   "Number of stimuli required for vote", "Integer", "4"
+   "Time window (secs)", "Float", "2"
+   "Clear votes", "Clear votes", "After output"
+   "Output timestamp", "Output time", "Time of last voting stimulus"
+   "Reject class label", "Stimulation", "OVTK_StimulationId_Label_00"
+   "Reject class can win", "Reject can win", "No"
+
+Number of stimuli required for vote
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Minimum number of incoming stimulus required to be inside the time window to carry out a vote.
+
+Time window (secs)
+~~~~~~~~~~~~~~~~~~
+
+The length of the time window. Stimuli are discarded after they drop outside the time window.
+
+Clear votes
+~~~~~~~~~~~
+
+You can specify that stimuli can either vote as long as they remain inside the time window,
+or that they are discarded after they participate in a single successful vote.
+
+Output timestamp
+~~~~~~~~~~~~~~~~
+
+The output stimulus can be tagged with either the time of vote, the time of the last occurrence of the winning stimulus type, or the time of the last stimulus that participated in the vote.
+
+Reject class label
+~~~~~~~~~~~~~~~~~~
+
+Specifies the class interpreted as the 'rejected' class.
+
+Reject class can win
+~~~~~~~~~~~~~~~~~~~~
+
+If set to 'no', 'rejected' class never wins the votes and is never returned as output.
+
+.. _Doc_BoxAlgorithm_StimulationVoter_Examples:
+
+Examples
+--------
+
+Possible usages include aggregating classifier outputs by making a majority vote over them.
+
+.. _Doc_BoxAlgorithm_StimulationVoter_Miscellaneous:
+
+Miscellaneous
+-------------
+
+This algorithm is similar to the Voting Classifier but it allows more parameters. Also, all stimulus available at 
+time step *t* are used to carry out the vote at time step *t*. On the other hand, Stimulation Voter only supports input streams of type Stimulus.
+
@@ -0,0 +1,72 @@
+.. _Doc_BoxAlgorithm_StreamEndDetector:
+
+Stream End Detector
+===================
+
+.. container:: attribution
+
+   :Author:
+      Jozef Legeny
+   :Company:
+      Mensia Technologies
+
+
+This box waits until it receives an End chunk in the incoming stream and sends
+a stimulation once it receives it.
+
+
+.. _Doc_BoxAlgorithm_StreamEndDetector_Inputs:
+
+Inputs
+------
+
+This box receives a single input of arbitrary type derived from EBML. It does
+not do any specific decoding.
+
+.. csv-table::
+   :header: "Input Name", "Stream Type"
+
+   "EBML Stream", "EBML stream"
+
+
+.. _Doc_BoxAlgorithm_StreamEndDetector_Outputs:
+
+Outputs
+-------
+
+This box will output a single stimulation after receiving the End chunk. Before
+outputting the stimulation, the stream will contain empty chunks in sync with
+the input stream.
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Output Stimulations", "Stimulations"
+
+
+.. _Doc_BoxAlgorithm_StreamEndDetector_Settings:
+
+Settings
+--------
+
+.. csv-table::
+   :header: "Setting Name", "Type", "Default Value"
+
+   "Stimulation name", "Stimulation", "OVTK_StimulationId_Label_00"
+
+.. _Doc_BoxAlgorithm_StreamEndDetector_Setting_1:
+
+Stimulation name
+~~~~~~~~~~~~~~~~
+
+Name or identifier of the stimulation to be sent by this box.
+
+.. _Doc_BoxAlgorithm_StreamEndDetector_Examples:
+
+Examples
+--------
+
+It can be combined with :ref:`Doc_BoxAlgorithm_PlayerController` to stop a
+scenario on file end.
+
+
@@ -0,0 +1,66 @@
+.. _Doc_BoxAlgorithm_Timeout:
+
+Timeout
+=======
+
+.. container:: attribution
+
+   :Author:
+      Jozef Legény
+   :Company:
+      Inria
+
+.. image:: images/Doc_BoxAlgorithm_Timeout.png
+
+Sends a stimulation after a period of time without receiving signal. Useful for stopping scenarios after hardware disconnection.
+
+This box will send a stimulation on its output after it stops receiving an input. The user
+can set a duration to wait before considering the output inactive.
+
+Inputs
+------
+
+.. csv-table::
+   :header: "Input Name", "Stream Type"
+
+   "Input Stream", "Streamed matrix"
+
+Input Stream
+~~~~~~~~~~~~
+
+Streamed Matrix input to be monitored.
+
+Outputs
+-------
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Output Stimulations", "Stimulations"
+
+Output Stimulations
+~~~~~~~~~~~~~~~~~~~
+
+Output stimulation. One stimulation will be sent after the timeout is reached.
+
+.. _Doc_BoxAlgorithm_Timeout_Settings:
+
+Settings
+--------
+
+.. csv-table::
+   :header: "Setting Name", "Type", "Default Value"
+
+   "Timeout delay", "Integer", "5"
+   "Output Stimulation", "Stimulation", "OVTK_StimulationId_Label_00"
+
+Timeout delay
+~~~~~~~~~~~~~
+
+Timeout value. Duration (in seconds) to wait after the last received chunk before the input is considered inactive.
+
+Output Stimulation
+~~~~~~~~~~~~~~~~~~
+
+Sitmulation ID to send.
+