1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- /**
- * \page BoxAlgorithm_XDAWNTrainerDeprecated xDAWN Spatial Filter Trainer
- __________________________________________________________________
-
- Detailed description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Description|
- * This box can be used in order to compute a spatial filter in order to enhance the
- * detection of evoked response potentials. In order to compute such filter, this box
- * needs to receive the whole contain of a session on the first hand, and a succession
- * of evoked response potentials on the other hand. It then computes the averaged evoked
- * response potential computes the spatial filter that makes this averaged potential
- * appear in the whole signal. This can be used e.g. for better P300 signal detection.
- *
- * It is important to consider the fact that this box will have best results for a
- * reasonably big number of input channels, possibly all over the scalp (areas where
- * the evoked response potential can not be seen will be naturally used as references
- * to reduce noise). The spatial filter results in space reduction to only keep significant
- * channels for later detection. Consider using at least 4 times more input channels than
- * the number of output channels you want. For example, reducing 16 electrodes to 3 channels
- * for P300 detection is OK.
- *
- * For more details about xDAWN, see <a href="https://www.gipsa-lab.grenoble-inp.fr/~bertrand.rivet/references/Rivet2009a.pdf">Rivet et al. 2009</a>
- * or in case this links disappears, <a href="http://www.ncbi.nlm.nih.gov/pubmed/19174332">this website</a>.
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Description|
- __________________________________________________________________
-
- Inputs description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Inputs|
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Inputs|
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Input1|
- * This input receives the experiment stimulations. As soon as the "train"
- * stimulation is received, the spatial filter is computed.
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Input1|
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Input2|
- * This input should receive the whole signal of the session.
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Input2|
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Input3|
- * This input should receive the multiple evoked response potentials.
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Input3|
- __________________________________________________________________
-
- Outputs description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_CSPSpatialFilterTrainer_Outputs|
- * |OVP_DocEnd_BoxAlgorithm_CSPSpatialFilterTrainer_Outputs|
-
- * |OVP_DocBegin_BoxAlgorithm_CSPSpatialFilterTrainer_Output1|
- The xDAWN Trainer outputs the stimulation <b>OVTK_StimulationId_TrainCompleted</b> when the training process was successful. No output is produced if the process failed.
- * |OVP_DocEnd_BoxAlgorithm_CSPSpatialFilterTrainer_Output1|
- __________________________________________________________________
-
- Settings description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Settings|
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Settings|
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Setting1|
- * This setting contains the stimulation to use to trigger the training process.
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Setting1|
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Setting2|
- * This setting tells the box what configuration file to generate. This configuration file can
- * be used to set the correct values of a \ref Doc_BoxAlgorithm_SpatialFilter box.
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Setting2|
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Setting3|
- * This setting tells how many dimension should be kept out of the spatial filter.
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Setting3|
- __________________________________________________________________
-
- Examples description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Examples|
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Examples|
- __________________________________________________________________
-
- Miscellaneous description
- __________________________________________________________________
-
- * |OVP_DocBegin_BoxAlgorithm_XDAWNTrainerDeprecated_Miscellaneous|
- * |OVP_DocEnd_BoxAlgorithm_XDAWNTrainerDeprecated_Miscellaneous|
- */
|