Box Artefact Detection By Amplitude

plugins/processing/artefact-detection/doc/Doc_BoxAlgorithm_ArtefactAmplitude.dox-part

+/**
+ * \page BoxAlgorithm_ArtefactAmplitude Artefact Amplitude
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Description|
+ Check if one element is higher than Max setting.\nThe signal is returned if no element exceeds the defined value.
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Inputs|
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Input1|
+The input signal on which the Artefact detection is used.
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Input1|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Output1|
+The input signal if there were no artefacts .
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Output1|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Setting1|
+ The amplitude threshold.
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Setting1|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ArtefactAmplitude_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_ArtefactAmplitude_Miscellaneous|
+ */