init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,61 @@
+/**
+ * \page BoxAlgorithm_TimeSignal Time signal
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Description|
+ * This box generates a linear signal on a single channel.
+ * The box can be used in order to test some processings on a specific
+ * signal when no data is available. Each sample value of the generated
+ * signal exactly equals to time in second.
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Description|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Output1|
+ * This output contains the generated signal.
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Output1|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Setting1|
+ * The first setting indicates the samling frequency of the produced signal in Hz.
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Setting1|
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Setting2|
+ * The last setting indicates how many sample will be sent for each output chunk.
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Setting2|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Examples|
+ * In order to illustrate this case, just drag'n drop a \ref Doc_BoxAlgorithm_SignalDisplay
+ * box on the scenario and connect its input to a sinus oscillator box. You will be able to
+ * see the generated signal.
+ *
+ * For better use of this box, consider using an additional \ref Doc_BoxAlgorithm_SimpleDSP
+ * box. Put whatever function you like in this box configuration and visualize it with the
+ * \ref Doc_BoxAlgorithm_SignalDisplay.
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_TimeSignal_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_TimeSignal_Miscellaneous|
+ */
@@ -0,0 +1,66 @@
+.. _Doc_BoxAlgorithm_TimeSignal:
+
+Time signal
+===========
+
+.. container:: attribution
+
+   :Author:
+      Yann Renard
+   :Company:
+      INRIA/IRISA
+
+.. image:: images/Doc_BoxAlgorithm_TimeSignal.png
+
+This box generates a linear signal on a single channel.
+The box can be used in order to test some processings on a specific
+signal when no data is available. Each sample value of the generated
+signal exactly equals to time in second.
+
+Outputs
+-------
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Generated signal", "Signal"
+
+Generated signal
+~~~~~~~~~~~~~~~~
+
+This output contains the generated signal.
+
+.. _Doc_BoxAlgorithm_TimeSignal_Settings:
+
+Settings
+--------
+
+.. csv-table::
+   :header: "Setting Name", "Type", "Default Value"
+
+   "Sampling frequency", "Integer", "512"
+   "Generated epoch sample count", "Integer", "32"
+
+Sampling frequency
+~~~~~~~~~~~~~~~~~~
+
+The first setting indicates the samling frequency of the produced signal in Hz.
+
+Generated epoch sample count
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The last setting indicates how many sample will be sent for each output chunk.
+
+.. _Doc_BoxAlgorithm_TimeSignal_Examples:
+
+Examples
+--------
+
+In order to illustrate this case, just drag'n drop a :ref:`Doc_BoxAlgorithm_ContinuousOscilloscope`
+box on the scenario and connect its input to a sinus oscillator box. You will be able to
+see the generated signal.
+
+For better use of this box, consider using an additional :ref:`Doc_BoxAlgorithm_SimpleDSP`
+box. Put whatever function you like in this box configuration and visualize it with the
+:ref:`Doc_BoxAlgorithm_ContinuousOscilloscope`.
+