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/file-io/doc/Doc_BoxAlgorithm_ElectrodeL...

Doc_BoxAlgorithm_ElectrodeLocalisationFileReader.dox-part 2.8KB
Raw Permalink Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 
  1. /**

  2.  * \page BoxAlgorithm_ElectrodeLocalisationFileReader Electrode localisation file reader

  3. __________________________________________________________________

  4. 

  5. Detailed description

  6. __________________________________________________________________

  7. 

  8.  * |OVP_DocBegin_BoxAlgorithm_ElectrodeLocalisationFileReader_Description|

  9.  * This box loads files holding the normalized coordinates of an electrode set.

  10.  * |OVP_DocEnd_BoxAlgorithm_ElectrodeLocalisationFileReader_Description|

  11. __________________________________________________________________

  12. 

  13. Outputs description

  14. __________________________________________________________________

  15. 

  16.  * |OVP_DocBegin_BoxAlgorithm_ElectrodeLocalisationFileReader_Outputs|

  17.  * |OVP_DocEnd_BoxAlgorithm_ElectrodeLocalisationFileReader_Outputs|

  18. 

  19.  * |OVP_DocBegin_BoxAlgorithm_ElectrodeLocalisationFileReader_Output1|

  20.  * The output channel localization information.

  21.  * |OVP_DocEnd_BoxAlgorithm_ElectrodeLocalisationFileReader_Output1|

  22. __________________________________________________________________

  23. 

  24. Settings description

  25. __________________________________________________________________

  26. 

  27.  * |OVP_DocBegin_BoxAlgorithm_ElectrodeLocalisationFileReader_Settings|

  28.  * |OVP_DocEnd_BoxAlgorithm_ElectrodeLocalisationFileReader_Settings|

  29. 

  30.  * |OVP_DocBegin_BoxAlgorithm_ElectrodeLocalisationFileReader_Setting1|

  31.  * The normalized coordinates file.

  32.  * |OVP_DocEnd_BoxAlgorithm_ElectrodeLocalisationFileReader_Setting1|

  33. __________________________________________________________________

  34. 

  35. Examples description

  36. __________________________________________________________________

  37. 

  38.  * |OVP_DocBegin_BoxAlgorithm_ElectrodeLocalisationFileReader_Examples|

  39.  * A default electrode set should be included in your BRAND_NAME distribution. Look for

  40.  * it in the <tt>share/electrode_sets</tt> directory of the source tree of this plugin.

  41.  * It comes as a \ref Doc_MatrixFileFormat "text file" which is quite self explanatory,

  42.  * open it in a text editor to edit it. Electrode names are specified in the header

  43.  * section of the matrix, while actual coordinates are stored in the buffer section.

  44.  * |OVP_DocEnd_BoxAlgorithm_ElectrodeLocalisationFileReader_Examples|

  45. __________________________________________________________________

  46. 

  47. Miscellaneous description

  48. __________________________________________________________________

  49. 

  50.  * |OVP_DocBegin_BoxAlgorithm_ElectrodeLocalisationFileReader_Miscellaneous|

  51.  * The coordinates loaded by this box are sent once only (static coordinates, e.g. EEG), as

  52.  * opposed to regularly (dynamic coordinates, e.g. MEG).

  53.  * The supported file format is the \ref Doc_MatrixFileFormat "BRAND_NAME matrix" file format.

  54.  * Electrode coordinates must be normalized cartesian coordinates in the following frame

  55.  * of reference : X right, Y front and Z up.

  56.  * |OVP_DocEnd_BoxAlgorithm_ElectrodeLocalisationFileReader_Miscellaneous|

  57.  */