init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,62 @@
+/**
+ * \page BoxAlgorithm_ASRProcessor ASR Processor
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Description|
+ Artifact Subspace Reconstruction (ASR) Trainer (see \ref CASR::process).
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Inputs|
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Input1|
+The input signal on which the Artifact reconstruction is used.
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Input1|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Output1|
+  Send \"OVTK_StimulationId_TrainCompleted\" if signal is reconstructed.
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Output1|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Output2|
+ The reconstructed signal if needed, the input signal otherwise.
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Output2|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Setting1|
+ ASR model Filename.
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Setting1|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRProcessor_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_ASRProcessor_Miscellaneous|
+ */
@@ -0,0 +1,78 @@
+/**
+ * \page BoxAlgorithm_ASRTrainer ASR Trainer
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Description|
+ Artifact Subspace Reconstruction (ASR) Trainer (see \ref CASR::train).
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Inputs|
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Input1|
+Stimulation to start the training.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Input1|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Input1|
+The input signal.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Input1|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Output1|
+Send \"OVTK_StimulationId_TrainCompleted\" when training is completed.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Output1|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Setting1|
+ ASR model Filename.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Setting1|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Setting2|
+ Stimulation that starts the training.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Setting2|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Setting3|
+ The Metric to use : Riemman or Euclidian.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Setting3|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Setting4|
+ The Channel ratio to reconstruct at maximum in [0;1] 0 for no reconstruction, 1 to allow reconstruction of all channels.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Setting4|
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Setting5|
+ The Rejection Limit of ASR model.
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Setting5|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ASRTrainer_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_ASRTrainer_Miscellaneous|
+ */
@@ -0,0 +1,58 @@
+/**
+ * \page BoxAlgorithm_ArtifactAmplitude Artifact Amplitude
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Description|
+ Check if one element is higher than Max setting.\nThe signal is returned if no element exceeds the defined value.
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Inputs|
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Input1|
+The input signal on which the Artifact detection is used.
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Input1|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Output1|
+The input signal if there were no artifacts .
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Output1|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Setting1|
+ The amplitude threshold.
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Setting1|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtifactAmplitude_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_ArtifactAmplitude_Miscellaneous|
+ */