This commit is contained in:
2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,120 @@
.. _Doc_BoxAlgorithm_2DTopography:
2D Topography
=============
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_2DTopography.png
The *2D Topography* box combines EEG measures with topological information.
The input, being signal, spectrum, or any other metric, is mapped to a 2 dimensional plane model of the scalp surface, rendered in a 3D context.
This box is provided with a preconfigured channel localisation file that contains the cartesian coordinates of every electrode positions of the extended 10-20 system.
The mapping is done according to these coordinates using spherical spline interpolation.
A color gradient is used to display the information, and can be customized at will to easily enhance or smooth the contrasts.
Several presets are available, to match the gradients you may be already familiar with when using existing softwares such as Matlab or Elan.
The color gradient is mapped to the current data scale, centered around 0.
The *2D Topography* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
Matrix
~~~~~~
The box input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_2DTopography_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input signal before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_2DTopography_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
For the 2D topography, please note that:
- **Select Channels** : the selected channel are symbolized with a small white cube, which turns grey when unselected.
Note that if the box receives a discontinuous data stream, such as a re-epoched signal through stimulation based epoching, the ERP replay features is exposed.
Using the ERP replay allows you to slowly visualize the last epoch received.
.. _Doc_BoxAlgorithm_2DTopography_Examples:
Examples
--------
In the following example, we compute the band power of the signal in the 8-15 Hz frequency range, and average it over the last 32 epochs received.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{2DTopography.mxs}.
.. figure:: images/2DTopography_Example.png
:alt: Example of scenario using the 2D topography
:align: center
Example of scenario using the 2D topography
@@ -0,0 +1,117 @@
.. _Doc_BoxAlgorithm_3DCubes:
3D Cubes
========
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_3DCubes.png
The *3D Cubes* box displays the data in a topographic view, where each channel (correctly identified and positionned thanks to a channel localisation file) is associated with a cube.
All the cubes are positionned in a 3D space according to the corresponding positions of the electrodes on the scalp.
The input data is displayed through 2 modalities:
- the **cubes color**
- the **cubes size**
The cube size varies according to the same - absolute - range as the color, i.e. high negative or positive values will be
displayed as big cube while values close to zero with be displayed as small cubes.
The *3D Cubes* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
Matrix
~~~~~~
The box input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_3DCubes_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_3DCubes_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
Note that if the box receives a discontinuous data stream, such as a re-epoched signal through stimulation based epoching, the ERP replay features is exposed.
Using the ERP replay allows you to slowly visualize the last epoch received.
.. _Doc_BoxAlgorithm_3DCubes_Examples:
Examples
--------
In the following example, we compute the band power of the signal in the 8-15 Hz frequency range, and average it over the last 32 epochs received.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{3DCubes.mxs}.
.. figure:: images/3DCubes_Example.png
:alt: Example of scenario using the 3D cubes
:align: center
Example of scenario using the 3D cubes
@@ -0,0 +1,109 @@
.. _Doc_BoxAlgorithm_3DTomographicVisualization:
3D Tomographic Visualization
============================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_3DTomographicVisualization.png
The *3D Tomographic Visualization* is designed to display the output of a signal filtered using the a tomographic reconstruction algorithm such as LORETA.
LORETA computes the spatial filter that transforms an input signal with :math:`C` channels/sensors to :math:`V =` 2394 sources.
These sources form a subdivision of the brain in 3 dimensions, each source being encoded as a small cube (7mm resolution) called *voxel*. The input to the box should thus be a matrix of 2394x3 values.
The *3D Tomographic Visualization* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
Matrix
~~~~~~
This box expects a source current density power stream coming from a LORETA transformation, ie matrices of :math:`V =` 2394 channels, one value per voxel of the reconstruction.
.. _Doc_BoxAlgorithm_3DTomographicVisualization_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_3DTomographicVisualization_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
Note that if the box receives a discontinuous data stream, such as a re-epoched signal through stimulation based epoching, the ERP replay features is exposed.
Using the ERP replay allows you to slowly visualize the last epoch received.
.. _Doc_BoxAlgorithm_3DTomographicVisualization_Examples:
Examples
--------
In the following example, we compute the alpha band power of the signal, and deduce the corresponding sources activity using
an inverse model of the headset (eLORETA), that outputs the source components along x, y and z axis and the source current density power.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{3DTomographicVisualization.mxs}.
.. figure:: images/3DTomographicVisualization_Example.png
:alt: Example of scenario using the 3D Tomographic Visualization
:align: center
Example of scenario using the 3D Tomographic Visualization
@@ -0,0 +1,120 @@
.. _Doc_BoxAlgorithm_3DTopography:
3D Topography
=============
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_3DTopography.png
The *3D Topography* box combines EEG measures with topological information.
The input, being signal, spectrum, or any other metric, is mapped to a 3D model of the scalp.
This box is provided with a preconfigured channel localisation file that contains the cartesian coordinates of every electrode positions of the extended 10-20 system.
The mapping is done according to these coordinates using spherical spline interpolation.
A color gradient is used to display the information, and can be customized at will to easily enhance or smooth the contrasts.
Several presets are available, to match the gradients you may be already familiar with when using existing softwares such as Matlab or Elan.
The color gradient is mapped to the current data scale, centered around 0.
The *3D Topography* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
Matrix
~~~~~~
The box input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_3DTopography_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input signal before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_3DTopography_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
For the 3D topography, please note that:
- **Select Channels** : the selected channel are symbolized with a small white cube, which turns grey when unselected.
Note that if the box receives a discontinuous data stream, such as a re-epoched signal through stimulation based epoching, the ERP replay features is exposed.
Using the ERP replay allows you to slowly visualize the last epoch received.
.. _Doc_BoxAlgorithm_3DTopography_Examples:
Examples
--------
In the following example, we compute the band power of the signal in the 8-15 Hz frequency range, and average it over the last 32 epochs received.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{3DTopography.mxs}.
.. figure:: images/3DTopography_Example.png
:alt: Example of scenario using the 3D topography
:align: center
Example of scenario using the 3D topography
@@ -0,0 +1,145 @@
.. _Doc_BoxAlgorithm_ContinuousBars:
Continuous Bars
===============
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_ContinuousBars.png
The Continuous Bars displays input data in form of **vertical level bars**, one bar per value, one bar series for each channel.
The display is done **continuously** , meaning that once the end of the horizontal scale is reached, it goes back to the origin.
For lisibility (and esthetical) purpose, the bars are colored in a custom gradient (from left to right).
The *Continuous Bars* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Streamed matrix"
"Markers", "Stimulations"
Matrix
~~~~~~
The first input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
Markers
~~~~~~~
The second input expect stimulations. They will be displayed as **colored vertical lines**.
.. _Doc_BoxAlgorithm_ContinuousBars_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Temporal Coherence", "Temporal Coherence", "Time Locked"
"Time Scale", "Float", "20"
"Matrix Count", "Integer", "50"
"Positive Data Only ?", "Boolean", "false"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Temporal Coherence
~~~~~~~~~~~~~~~~~~
Select *Time Locked* for a continuous data stream, and specify the *time scale* below.
Select *Independent* for a discontinuous data stream, and specify the *matrix count* below.
Time Scale
~~~~~~~~~~
The time scale in seconds, before the displays goes back to the origin.
Matrix Count
~~~~~~~~~~~~
The number of input matrices to receive before the displays goes back to the origin.
Positive Data Only ?
~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, the vertical scale is shifted so that 0 is at the bottom. Only positive values will be displayed.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_ContinuousBars_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_ContinuousBars_Examples:
Examples
--------
In the following example, we compute the band power of the bipolar channel C3-C4 in the 8-15 Hz frequency range, and average it over the last 32 epochs received.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{ContinuousBars.mxs}.
.. figure:: images/ContinuousBars_Example.png
:alt: Example of scenario using the Continuous Bars
:align: center
Example of scenario using the Continuous Bars
@@ -0,0 +1,120 @@
.. _Doc_BoxAlgorithm_ContinuousBitmap:
Continuous Bitmap
=================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_ContinuousBitmap.png
The *Continuous Bitmap* displays input data in form of a 2D map of colored blocks (or *bitmap*).
The display is done **continuously** , meaning that once the end of the horizontal scale is reached, it goes back to the origin.
The *Continuous Bitmap* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Streamed matrix"
"Markers", "Stimulations"
Matrix
~~~~~~
The first input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
Markers
~~~~~~~
The second input expect stimulations. They will be displayed as **red vertical lines**.
.. _Doc_BoxAlgorithm_ContinuousBitmap_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Temporal Coherence", "Temporal Coherence", "Time Locked"
"Time Scale", "Float", "20"
"Matrix Count", "Integer", "50"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Temporal Coherence
~~~~~~~~~~~~~~~~~~
Select *Time Locked* for a continuous data stream, and specify the *time scale* below.
Select *Independent* for a discontinuous data stream, and specify the *matrix count* below.
Time Scale
~~~~~~~~~~
The time scale in seconds, before the displays goes back to the origin.
Matrix Count
~~~~~~~~~~~~
The number of input matrices to receive before the displays goes back to the origin.
Gain
~~~~
If this checkbox is ticked, the vertical scale is shifted so that 0 is at the bottom. Only positive values will be displayed.
Caption
~~~~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Color
~~~~~
Label to be displayed on top of the visualization window.
.. _Doc_BoxAlgorithm_ContinuousBitmap_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_ContinuousBitmap_Examples:
Examples
--------
In the following example, we compute the band power of the input signal in the 8-15 Hz frequency range, and average it over the last 32 epochs received.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{ContinuousBitmap.mxs}.
.. figure:: images/ContinuousBitmap_Example.png
:alt: Example of scenario using the Continuous Bitmap
:align: center
Example of scenario using the Continuous Bitmap
@@ -0,0 +1,145 @@
.. _Doc_BoxAlgorithm_ContinuousMultiOscilloscope:
Continuous Multi Oscilloscope
=============================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_ContinuousMultiOscilloscope.png
The *Continuous Multi-Oscilloscope* displays temporal numerical data in the form of curves, on the same vertical axis.
Each channel is given a color according to a color gradient, rendered additively.
The display is done **continuously** , meaning that once the end of the horizontal scale is reached, it goes back to the origin.
The *Continuous Multi-Oscilloscope* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
"Markers", "Stimulations"
Matrix
~~~~~~
The first input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
Markers
~~~~~~~
The second input expect stimulations. They will be displayed as **red vertical lines**.
.. _Doc_BoxAlgorithm_ContinuousMultiOscilloscope_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Temporal Coherence", "Temporal Coherence", "Time Locked"
"Time Scale", "Float", "20"
"Matrix Count", "Integer", "50"
"Positive Data Only ?", "Boolean", "false"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Temporal Coherence
~~~~~~~~~~~~~~~~~~
Select *Time Locked* for a continuous data stream, and specify the *time scale* below.
Select *Independent* for a discontinuous data stream, and specify the *matrix count* below.
Time Scale
~~~~~~~~~~
The time scale in seconds, before the displays goes back to the origin.
Matrix Count
~~~~~~~~~~~~
The number of input matrices to receive before the displays goes back to the origin.
Positive Data Only ?
~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, the vertical scale is shifted so that 0 is at the bottom. Only positive values will be displayed.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_ContinuousMultiOscilloscope_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_ContinuousMultiOscilloscope_Examples:
Examples
--------
In the following example, we compute the band power of the input signal in the 8-15 Hz frequency range, and average it over the last 32 epochs received.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{ContinuousMultiOscilloscope.mxs}.
.. figure:: images/ContinuousMultiOscilloscope_Example.png
:alt: Example of scenario using the Continuous Multi-Oscilloscope
:align: center
Example of scenario using the Continuous Multi-Oscilloscope
@@ -0,0 +1,145 @@
.. _Doc_BoxAlgorithm_ContinuousOscilloscope:
Continuous Oscilloscope
=======================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_ContinuousOscilloscope.png
The *Continuous Oscilloscope* displays temporal numerical data in the form of curves, all the channels being distributed vertically, each one with its own horizontal axis.
Channel are given a color, overlaps are rendered additively.
The display is done **continuously** , meaning that once the end of the horizontal scale is reached, it goes back to the origin.
The *Continuous Oscilloscope* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
"Markers", "Stimulations"
Matrix
~~~~~~
The first input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
Markers
~~~~~~~
The second input expect stimulations. They will be displayed as **red vertical lines**.
.. _Doc_BoxAlgorithm_ContinuousOscilloscope_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Temporal Coherence", "Temporal Coherence", "Time Locked"
"Time Scale", "Float", "20"
"Matrix Count", "Integer", "50"
"Positive Data Only ?", "Boolean", "false"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Color", "Color", "${AdvancedViz_DefaultColor}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Temporal Coherence
~~~~~~~~~~~~~~~~~~
Select *Time Locked* for a continuous data stream, and specify the *time scale* below.
Select *Independent* for a discontinuous data stream, and specify the *matrix count* below.
Time Scale
~~~~~~~~~~
The time scale in seconds, before the displays goes back to the origin.
Matrix Count
~~~~~~~~~~~~
The number of input matrices to receive before the displays goes back to the origin.
Positive Data Only ?
~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, the vertical scale is shifted so that 0 is at the bottom. Only positive values will be displayed.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_ContinuousOscilloscope_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_ContinuousOscilloscope_Examples:
Examples
--------
In the following example, we filter the input signal in the 8-15 Hz frequency range and simply display it.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{ContinuousOscilloscope.mxs}.
.. figure:: images/ContinuousOscilloscope_Example.png
:alt: Example of scenario using the Continuous Oscilloscope
:align: center
Example of scenario using the Continuous Oscilloscope
@@ -0,0 +1,120 @@
.. _Doc_BoxAlgorithm_ContinuousXYZPlot:
Continuous XYZ Plot
===================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_ContinuousXYZPlot.png
The *Continuous XYZ Plot* displays temporal numerical data in a 2D (*resp.* 3D) space, consecutive rows of the input matrix being grouped by 2 (*resp.* 3) to form the 2D (*resp.* 3D) trajectories.
The display is done **continuously**, meaning that trajectories are persitent along time. Moreover, colors change as a function of time (samples order).
The *Continuous XYZ Plot* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
Matrix
~~~~~~
The first input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_ContinuousXYZPlot_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Temporal Coherence", "Temporal Coherence", "Time Locked"
"Time Scale", "Float", "20"
"Matrix Count", "Integer", "50"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Show Axis", "Boolean", "true"
"Use third channel as depth", "Boolean", "false"
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Temporal Coherence
~~~~~~~~~~~~~~~~~~
Select *Time Locked* for a continuous data stream, and specify the *time scale* below.
Select *Independent* for a discontinuous data stream, and specify the *matrix count* below.
Time Scale
~~~~~~~~~~
The time scale in seconds, before the displays goes back to the origin.
Matrix Count
~~~~~~~~~~~~
The number of input matrices to receive before the displays goes back to the origin.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Show Axis
~~~~~~~~~
If this checkbox is ticked, the axis and the grid are displayed.
Use third channel as depth
~~~~~~~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, trajectories are plotted in a 3D space, otherwise in a 2D space.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
.. _Doc_BoxAlgorithm_ContinuousXYZPlot_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
@@ -0,0 +1,122 @@
.. _Doc_BoxAlgorithm_InstantBars:
Instant Bars
============
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_InstantBars.png
The *Instant Bars* box displays input data in form of **vertical level bars**, one bar per value, one series of bar for each channel.
The display is done **instantly** , meaning that whenever a new data block arrives, it is displayed in the visualization windows, filling all the vertical space.
For lisibility (and esthetical) purpose, the bars are colored in a custom gradient (from left to right).
This box is especially suitable for displaying **spectrum**.
The *Instant Bars* box shares common concepts and settings with the other boxes of the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Spectrum"
Matrix
~~~~~~
The input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_InstantBars_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Positive Data Only ?", "Boolean", "false"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Positive Data Only ?
~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, the vertical scale is shifted so that 0 is at the bottom. Only positive values will be displayed.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_InstantBars_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_InstantBars_Examples:
Examples
--------
In the following example, we compute the FFT of the input EEG signal and display it.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{InstantBars.mxs}.
.. figure:: images/InstantBars_Example.png
:alt: Example of scenario using the Instant Bars to display spectrum
:align: center
Example of scenario using the Instant Bars to display spectrum
@@ -0,0 +1,102 @@
.. _Doc_BoxAlgorithm_InstantBitmap:
Instant Bitmap
==============
.. image:: images/Doc_BoxAlgorithm_InstantBitmap.png
The *Instant Bitmap* box displays input data in form of a 2D map of colored blocks (or *bitmap*).
The display is done **instantly** , meaning that whenever a new data block arrives, it is displayed in the visualization windows, filling all the horizontal space.
The bitmap colors are chosen according to a custom gradient.
The *Instant Bitmap* box shares common concepts and settings with the other boxes of the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Spectrum"
Matrix
~~~~~~
The input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_InstantBitmap_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_InstantBitmap_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_InstantBitmap_Examples:
Examples
--------
In the following example, we compute the FFT of the input EEG signal and display it.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{InstantBitmap.mxs}.
.. figure:: images/InstantBitmap_Example.png
:alt: Example of scenario using the Instant Bitmap to display spectrum
:align: center
Example of scenario using the Instant Bitmap to display spectrum
@@ -0,0 +1,104 @@
.. _Doc_BoxAlgorithm_InstantBitmap3DStream:
Instant Bitmap (3D Stream)
==========================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_InstantBitmap3DStream.png
The *Instant Bitmap (3D Stream)* box displays input data in form of 2D maps of colored blocks (or *bitmap*).
Each time a matrix is received, its contents are displayed to fill the visualization. Depending on the input type, the three dimensions of the matrix will be ordonned differently.
The bitmap colors are chosen according to a custom gradient.
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Time-frequency"
"Markers", "Stimulations"
Matrix
~~~~~~
The input matrices to be displayed. Currently this box supports only the Time-Frequency stream.
Markers
~~~~~~~
The second input expects stimulations. They will be displayed as **colored vertical lines**.
.. _Doc_BoxAlgorithm_InstantBitmap3DStream_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to ``Matlab`` and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_InstantBitmap3DStream_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_InstantBitmap3DStream_Examples:
Examples
--------
In the following example, we compute the Time-Frequency Analysis for a generated signal.
You can find a commented scenario in the provided sample set, the scenario file name is InstantBitmap3DStream.mxs.
.. figure:: images/InstantBitmap3DStream_Example.png
:alt: Example of scenario using the Instant Bitmap (3D Stream)
:align: center
Example of scenario using the Instant Bitmap (3D Stream)
@@ -0,0 +1,121 @@
.. _Doc_BoxAlgorithm_InstantMultiOscilloscope:
Instant Multi Oscilloscope
==========================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_InstantMultiOscilloscope.png
The *Instant Multi-Oscilloscope* displays temporal numerical data in the form of curves, on the same vertical axis.
Each channel is given a color according to a color gradient, rendered additively.
The display is done **instantly** , meaning that whenever a new data block arrives, it is displayed in the visualization windows, filling all the horizontal space.
The *Instant Multi-Oscilloscope* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
Matrix
~~~~~~
The input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_InstantMultiOscilloscope_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Positive Data Only ?", "Boolean", "false"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Positive Data Only ?
~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, the vertical scale is shifted so that 0 is at the bottom. Only positive values will be displayed.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_InstantMultiOscilloscope_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_InstantMultiOscilloscope_Examples:
Examples
--------
In the following example, we compute the FFT of the average right hand trial in a Motor Imagery session,
and visualize the spectrum around left and right motor cortices through 2 Laplacian filters around C3 and C4.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{InstantMultiOscilloscope.mxs}.
.. figure:: images/InstantMultiOscilloscope_Example.png
:alt: Example of scenario using the Instant Multi-Oscilloscope
:align: center
Example of scenario using the Instant Multi-Oscilloscope
@@ -0,0 +1,122 @@
.. _Doc_BoxAlgorithm_InstantOscilloscope:
Instant Oscilloscope
====================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_InstantOscilloscope.png
The *Instant Oscilloscope* displays temporal numerical data in the form of curves.
The display is done **instantly** , meaning that whenever a new data block arrives, it is displayed in the visualization windows, filling all the horizontal space.
The *Instant Oscilloscope* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
This box supports input modification: you can add or remove inputs at will.
Matrix
~~~~~~
The input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_InstantOscilloscope_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Positive Data Only ?", "Boolean", "false"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Color", "Color", "${AdvancedViz_DefaultColor}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Positive Data Only ?
~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, the vertical scale is shifted so that 0 is at the bottom. Only positive values will be displayed.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_InstantOscilloscope_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_InstantOscilloscope_Examples:
Examples
--------
In the following example, we compute the FFT of the average right hand trial in a Motor Imagery session,
and visualize the spectrum around left and right motor cortices through 2 Laplacian filters around C3 and C4.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{InstantOscilloscope.mxs}.
.. figure:: images/InstantOscilloscope_Example.png
:alt: Example of scenario using the Instant Oscilloscope
:align: center
Example of scenario using the Instant Oscilloscope
@@ -0,0 +1,101 @@
.. _Doc_BoxAlgorithm_InstantXYZPlot:
Instant XYZ Plot
================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_InstantXYZPlot.png
The *Instant XYZ Plot* displays temporal numerical data in a 2D (*resp.* 3D) space, consecutive rows of the input matrix being grouped by 2 (*resp.* 3) to form the 2D (*resp.* 3D) trajectories.
The display is done **instantly**, meaning that whenever a new data block arrives, it is displayed in the visualization windows, without previous trajectories. Moreover, colors change as a function of time (samples order).
The *Instant XYZ Plot* box shares common concepts and settings with the other boxes in the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Signal"
Matrix
~~~~~~
The input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
.. _Doc_BoxAlgorithm_InstantXYZPlot_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Gain", "Float", "1"
"Caption", "String", ""
"Translucency", "Float", "1"
"Show Axis", "Boolean", "true"
"Use third channel as depth", "Boolean", "false"
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Translucency
~~~~~~~~~~~~
This setting expect a value between 0 and 1, from transparent to opaque color rendering (nb: this value is the alpha component of the color).
Show Axis
~~~~~~~~~
If this checkbox is ticked, the axis and the grid are displayed.
Use third channel as depth
~~~~~~~~~~~~~~~~~~~~~~~~~~
If this checkbox is ticked, trajectories are plotted in a 3D space, otherwise in a 2D space.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
.. _Doc_BoxAlgorithm_InstantXYZPlot_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
@@ -0,0 +1,135 @@
.. _Doc_BoxAlgorithm_StackedBitmapHorizontal:
Stacked Bitmap (Horizontal)
===========================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_StackedBitmapHorizontal.png
The *Stacked Bitmap (Horizontal)* box displays input data in form of 2D maps of colored blocks (or *bitmap*).
All the bitmaps are stacked horizontally, starting from the left edge of the window.
Whenever a new data block arrives, it is added to the visualization windows. If the end of the matrix count scale is reached, it goes back to the origin.
The bitmap colors are chosen according to a custom gradient.
The *Stacked Bitmap (Horizontal)* box shares common concepts and settings with the other boxes of the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Streamed matrix"
"Markers", "Stimulations"
Matrix
~~~~~~
The first input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
Markers
~~~~~~~
The second input expect stimulations. They will be displayed as **colored vertical lines**.
.. _Doc_BoxAlgorithm_StackedBitmapHorizontal_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Temporal Coherence", "Temporal Coherence", "Time Locked"
"Time Scale", "Float", "20"
"Matrix Count", "Integer", "50"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Temporal Coherence
~~~~~~~~~~~~~~~~~~
Select *Time Locked* for a continuous data stream, and specify the *time scale* below.
Select *Independent* for a discontinuous data stream, and specify the *matrix count* below.
Time Scale
~~~~~~~~~~
The time scale in seconds, before the displays goes back to the origin.
Matrix Count
~~~~~~~~~~~~
The number of input matrices to receive before the displays goes back to the origin.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_StackedBitmapHorizontal_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_StackedBitmapHorizontal_Examples:
Examples
--------
In the following example, we compute the FFT of every right-hand trial in a Motor Imagery session, filtered spatially around the two motor cortices.
All the spectra are stacked on top of each other.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{StackedBitmapHorz.mxs}.
.. figure:: images/StackedBitmapHorz_Example.png
:alt: Example of scenario using the Stacked Bitmap (Horizontal)
:align: center
Example of scenario using the Stacked Bitmap (Horizontal)
@@ -0,0 +1,135 @@
.. _Doc_BoxAlgorithm_StackedBitmapVertical:
Stacked Bitmap (Vertical)
=========================
.. container:: attribution
:Author:
Yann Renard
:Company:
Mensia Technologies SA
.. image:: images/Doc_BoxAlgorithm_StackedBitmapVertical.png
The *Stacked Bitmap (Vertical)* box displays input data in form of 2D maps of colored blocks (or *bitmap*).
All the bitmaps are stacked vertically, starting from the bottom edge of the window.
Whenever a new data block arrives, it is added to the visualization windows. If the end of the matrix count scale is reached, it goes back to the origin.
The bitmap colors are chosen according to a custom gradient.
The *Stacked Bitmap (Vertical)* box shares common concepts and settings with the other boxes of the **Mensia Advanced Visualization Toolset**.
Additional information are available in the dedicated documentation pages:
- :ref:`Doc_Mensia_AdvViz_Concepts`
- :ref:`Doc_Mensia_AdvViz_Configuration`
Inputs
------
.. csv-table::
:header: "Input Name", "Stream Type"
"Matrix", "Streamed matrix"
"Markers", "Stimulations"
Matrix
~~~~~~
The first input can be a streamed matrix or any derived stream (Signal, Spectrum, Feature Vector).
Please set the input type according to the actual stream type connected.
Markers
~~~~~~~
The second input expect stimulations. They will be displayed as **colored vertical lines**.
.. _Doc_BoxAlgorithm_StackedBitmapVertical_Settings:
Settings
--------
.. csv-table::
:header: "Setting Name", "Type", "Default Value"
"Channel Localisation", "Filename", "${AdvancedViz_ChannelLocalisation}"
"Temporal Coherence", "Temporal Coherence", "Time Locked"
"Time Scale", "Float", "20"
"Matrix Count", "Integer", "50"
"Gain", "Float", "1"
"Caption", "String", ""
"Color", "Color Gradient", "${AdvancedViz_DefaultColorGradient}"
Channel Localisation
~~~~~~~~~~~~~~~~~~~~
The channel localisation file containing the cartesian coordinates of the electrodes to be displayed.
A default configuration file is provided, and its path stored in the configuration token ``${AdvancedViz_ChannelLocalisation}``.
Temporal Coherence
~~~~~~~~~~~~~~~~~~
Select *Time Locked* for a continuous data stream, and specify the *time scale* below.
Select *Independent* for a discontinuous data stream, and specify the *matrix count* below.
Time Scale
~~~~~~~~~~
The time scale in seconds, before the displays goes back to the origin.
Matrix Count
~~~~~~~~~~~~
The number of input matrices to receive before the displays goes back to the origin.
Gain
~~~~
Gain (floating-point scalar factor) to apply to the input values before display.
Caption
~~~~~~~
Label to be displayed on top of the visualization window.
Color
~~~~~
Color gradient to use. This setting can be set manually using the color gradient editor.
Several presets exist in form of configuration tokens ``${AdvancedViz_ColorGradient_X}``, where X can be:
- ``Matlab`` or ``Matlab_Discrete``
- ``Icon`` or ``Icon_Discrete``
- ``Elan`` or ``Elan_Discrete``
- ``Fire`` or ``Fire_Discrete``
- ``IceAndFire`` or ``IceAndFire_Discrete``
The default values ``AdvancedViz_DefaultColorGradient`` or ``AdvancedViz_DefaultColorGradient_Discrete`` are equal to </t>Matlab</tt> and ``Matlab_Discrete``.
An example of topography rendering using these color gradients can be found :ref:`Doc_Mensia_AdvViz_Configuration` "here".
.. _Doc_BoxAlgorithm_StackedBitmapVertical_VizSettings:
Visualization Settings
----------------------
At runtime, all the advanced visualization shared settings are exposed, as described in :ref:`Doc_Mensia_AdvViz_Configuration_RuntimeToolbar`.
.. _Doc_BoxAlgorithm_StackedBitmapVertical_Examples:
Examples
--------
In the following example, we compute the FFT of every right-hand trial in a Motor Imagery session, filtered spatially around the two motor cortices.
All the spectra are stacked on top of each other.
You can find a commented scenario in the provided sample set, the scenario file name is \textit{StackedBitmapVert.mxs}.
.. figure:: images/StackedBitmapVert_Example.png
:alt: Example of scenario using the Stacked Bitmap (Vertical)
:align: center
Example of scenario using the Stacked Bitmap (Vertical)