| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576 |
- /**
- * \page BoxAlgorithm_BrainampFileReader Brainamp file reader
- __________________________________________________________________
-
- Detailed description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Description|
- * Loads experiment information, signal and stimulations data from Brainamp files.
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Description|
- __________________________________________________________________
-
- Outputs description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Outputs|
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Outputs|
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Output1|
- * This stream contains information about the experiment and subject.
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Output1|
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Output2|
- * Contains the signal information for the different channels (read from the GDF file).
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Output2|
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Output3|
- * Contains information about the stimulations that occurred during the experiment.
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Output3|
- __________________________________________________________________
-
- Settings description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Settings|
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Settings|
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Setting1|
- * This setting contains the name of the brainamp header file. The other files are deduced
- * from the header content (signal content and markers).
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Setting1|
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Setting2|
- * This setting sets the size of epochs to be generated by this box, in seconds.
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Setting2|
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Setting3|
- * Should stimuli in the file to be converted to OpenViBE stimuli? For
- * legacy reasons, the default is true. With false, the stimuli will
- * be delivered without any conversion.
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Setting3|
-
- __________________________________________________________________
-
- Examples description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Examples|
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Examples|
-
- __________________________________________________________________
-
- Miscellaneous description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_BrainampFileReader_Miscellaneous|
- * Experiment information is stored in a header file which the user needs to specify
- * when setting up the box. When started, the box then works up the names of two additional
- * files : a data file and a marker file. Signal data is retrieved from the data file,
- * stimulations from the marker file.
- *
- * The stimulation makers are transformed in §OpenViBE§ format with the
- * \c OVTK_StimulationId_Label base. See the \ref Doc_Stimulations page
- * for more details about §OpenViBE§ stimulations.
- * |OVP_DocEnd_BoxAlgorithm_BrainampFileReader_Miscellaneous|
- */
|
