feat(NoiseJitterRemovalAgent): introduce an agent to reduce the amoun…

…t of noise and jitter in streamed sensor values

Merge pull request #263 from Met4FoF/noise_jitter_removal

README.md

@@ -172,6 +172,7 @@ get you started as quick as possible. You will find tutorials on how to set up:
 - [an advanced pipeline with multichannel signals](https://agentmet4fof.readthedocs.io/en/latest/agentMET4FOF_tutorials/tutorial_3_multi_channel.html)
 - [a simple metrological datastream](https://agentmet4fof.readthedocs.io/en/latest/agentMET4FOF_tutorials/tutorial_4_metrological_streams.html)
 - [pipelines to determine redundancy in sensor networks](https://agentmet4fof.readthedocs.io/en/latest/tutorials.html#working-with-signals-carrying-redundant-information)
+- [a pipeline to reduce noise and jitter in sensor readings](https://agentmet4fof.readthedocs.io/en/latest/tutorials.html#reducing-noise-and-jitter-in-signals)
 
 … and [more](https://agentmet4fof.readthedocs.io/en/latest/tutorials.html)!
 

agentMET4FOF/agents/base_agents.py

@@ -225,7 +225,7 @@ def log_info(self, message):
             print(e)
             return 1
 
-    def init_agent_loop(self, loop_wait: Optional[int] = None):
+    def init_agent_loop(self, loop_wait: Optional[float] = None):
         """
         Initiates the agent loop, which iterates every `loop_wait` seconds
 
@@ -234,7 +234,7 @@ def init_agent_loop(self, loop_wait: Optional[int] = None):
         Parameters
         ----------
         loop_wait : int, optional
-            The wait between each iteration of the loop
+            The wait between each iteration of the loop, defaults to 1.0
         """
 
         # most default: loop wait has not been set in init_parameters() not

agentMET4FOF/agents/metrological_base_agents.py

@@ -126,10 +126,10 @@ def on_received_message(self, message):
 
         Feeds ``default`` data into the buffer as a dictionary::
 
-        dict like {
-            "data": message["data"],
-            "metadata": message["metadata"],
-        }
+            dict like {
+                "data": message["data"],
+                "metadata": message["metadata"],
+            }
 
         and hands over 'plot' data to plot memory.
 

agentMET4FOF/agents/metrological_redundancy_agents.py

@@ -41,15 +41,15 @@ class RedundancyAgent(MetrologicalAgent):
 
     Please refer to other sections in this documentation for more information. A
     scientific publication explaining the ideas behind this agent can be found in
-    [Kok2020_1]_. Related work can be found in [Kok2020_2]_.
+    [Kok20201]_. Related work can be found in [Kok20202]_.
 
     The usage of the Redundancy Agent is illustrated with two examples contained in
     :ref:`two tutorials <redundancy_tutorials>`.
 
     References
     ----------
-    * Kok and Harris [Kok2020_1]_
-    * Kok and Harris [Kok2020_2]_
+    * Kok and Harris [Kok20201]_
+    * Kok and Harris [Kok20202]_
     """
 
     metadata: MetaData