home.md

@@ -38,6 +38,7 @@
   - [set_log_mode](#set_log_mode)
   - [set_custom_logger](#set_custom_logger)
 
+ 
 # **General Example**
 
 Here is a small example that goes over most basic steps:
@@ -212,6 +213,7 @@ Can be converted to a dictionary.
         
 </table>
 
+
 ## **MeasureExternalTriggerQueueThread**
 
 <p class="func-header">
@@ -911,7 +913,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev
 ## **get_premade_processing_settings_list**
 
 <p class="func-header">
-    <i>def</i> <b>get_premade_processing_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3543">[source]</a>
+    <i>def</i> <b>get_premade_processing_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3544">[source]</a>
 </p>
 
 Get a list of names of all the available premade settings for processing.
@@ -935,7 +937,7 @@ Get a list of names of all the available premade settings for processing.
 ## **get_premade_recording_settings_list**
 
 <p class="func-header">
-    <i>def</i> <b>get_premade_recording_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3558">[source]</a>
+    <i>def</i> <b>get_premade_recording_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3559">[source]</a>
 </p>
 
 Get a list of names of all the available premade settings for recording.
@@ -959,7 +961,7 @@ Get a list of names of all the available premade settings for recording.
 ## **get_microphone_layout_list**
 
 <p class="func-header">
-    <i>def</i> <b>get_microphone_layout_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3573">[source]</a>
+    <i>def</i> <b>get_microphone_layout_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3574">[source]</a>
 </p>
 
 Get a list of names of all the available microphone layouts that are available for recording.
@@ -983,7 +985,7 @@ Get a list of names of all the available microphone layouts that are available f
 ## **prepare_processing**
 
 <p class="func-header">
-    <i>def</i> <b>prepare_processing</b>(<i>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3587">[source]</a>
+    <i>def</i> <b>prepare_processing</b>(<i>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3588">[source]</a>
 </p>
 
 Start the CUDA workers for looped measurements with processing enabled.
@@ -1019,7 +1021,7 @@ will prepare that one.
 ## **unload_processing**
 
 <p class="func-header">
-    <i>def</i> <b>unload_processing</b>(<i>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3630">[source]</a>
+    <i>def</i> <b>unload_processing</b>(<i>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3631">[source]</a>
 </p>
 
 Stop all CUDA workers of all workers or of one specified if the configuration name is provided.
@@ -1052,7 +1054,7 @@ stopped when your script ends.
 ## **get_raw_measurement**
 
 <p class="func-header">
-    <i>def</i> <b>get_raw_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3654">[source]</a>
+    <i>def</i> <b>get_raw_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3655">[source]</a>
 </p>
 
 Start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object.
@@ -1097,7 +1099,7 @@ measurement = rtisdev.get_raw_measurement(True)
 ## **get_signal_measurement**
 
 <p class="func-header">
-    <i>def</i> <b>get_signal_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3694">[source]</a>
+    <i>def</i> <b>get_signal_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3695">[source]</a>
 </p>
 
 Start an RTIS sonar measurement and process it with only PDM filtering
@@ -1145,7 +1147,7 @@ signal_measurement = rtisdev.get_signal_measurement(True)
 ## **get_processed_measurement**
 
 <p class="func-header">
-    <i>def</i> <b>get_processed_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3740">[source]</a>
+    <i>def</i> <b>get_processed_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3741">[source]</a>
 </p>
 
 Start an RTIS sonar measurement and process it and return the raw and processed data
@@ -1192,7 +1194,7 @@ processed_measurement = rtisdev.get_processed_measurement(True)
 ## **process_measurement**
 
 <p class="func-header">
-    <i>def</i> <b>process_measurement</b>(<i>measurement: RTISMeasurement, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3788">[source]</a>
+    <i>def</i> <b>process_measurement</b>(<i>measurement: RTISMeasurement, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3789">[source]</a>
 </p>
 
 Process a previously recorded raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object
@@ -1240,7 +1242,7 @@ processed_measurement = rtisdev.process_measurement(measurement)
 ## **set_counter**
 
 <p class="func-header">
-    <i>def</i> <b>set_counter</b>(<i>newCount: int=0</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3834">[source]</a>
+    <i>def</i> <b>set_counter</b>(<i>newCount: int=0</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3835">[source]</a>
 </p>
 
 Set the internal measurement counter of the sonar hardware.
@@ -1271,7 +1273,7 @@ Set the internal measurement counter of the sonar hardware.
 ## **set_behaviour**
 
 <p class="func-header">
-    <i>def</i> <b>set_behaviour</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3857">[source]</a>
+    <i>def</i> <b>set_behaviour</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3858">[source]</a>
 </p>
 
 Set the behaviour of the sonar hardware to passive or active. This is only necessary if using external
@@ -1305,7 +1307,7 @@ argument to define the sonar behaviour.
 ## **get_firmware_version**
 
 <p class="func-header">
-    <i>def</i> <b>get_firmware_version</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3882">[source]</a>
+    <i>def</i> <b>get_firmware_version</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3883">[source]</a>
 </p>
 
 Get the firmware version of the internal RTIS firmware used on the device.
@@ -1329,7 +1331,7 @@ Get the firmware version of the internal RTIS firmware used on the device.
 ## **create_measure_external_trigger_queue**
 
 <p class="func-header">
-    <i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue: Queue, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3897">[source]</a>
+    <i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue: Queue, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3898">[source]</a>
 </p>
 
 This will create and return a Multiprocessing Process
@@ -1382,7 +1384,7 @@ measure_thread.join()
 ## **create_measure_external_trigger_callback**
 
 <p class="func-header">
-    <i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback: Callable[[ RTISMeasurement], any], configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3972">[source]</a>
+    <i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback: Callable[[ RTISMeasurement], any], configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3973">[source]</a>
 </p>
 
 This will create and return a Multiprocessing Process
@@ -1441,7 +1443,7 @@ measure_thread.join()
 ## **create_processing_workers**
 
 <p class="func-header">
-    <i>def</i> <b>create_processing_workers</b>(<i>workerCount: int, inputQueue: Queue, outputQueue: Queue, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4056">[source]</a>
+    <i>def</i> <b>create_processing_workers</b>(<i>workerCount: int, inputQueue: Queue, outputQueue: Queue, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4057">[source]</a>
 </p>
 
 This will create and return a Multiprocessing Pool that will generate a chosen amount of processing
@@ -1512,7 +1514,7 @@ workersPool.terminate()
 ## **toggle_amplifier**
 
 <p class="func-header">
-    <i>def</i> <b>toggle_amplifier</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4131">[source]</a>
+    <i>def</i> <b>toggle_amplifier</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4132">[source]</a>
 </p>
 
 Enable/disable the high voltage amplifier's step up controller.
@@ -1545,7 +1547,7 @@ This will save on power usage and heat production.
 ## **toggle_external_triggers**
 
 <p class="func-header">
-    <i>def</i> <b>toggle_external_triggers</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4153">[source]</a>
+    <i>def</i> <b>toggle_external_triggers</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4154">[source]</a>
 </p>
 
 Enable/disable external triggers being able to start a measurement on the RTIS device.
@@ -1577,7 +1579,7 @@ They are disabled by default so have to be manually enabled.
 ## **reset_device**
 
 <p class="func-header">
-    <i>def</i> <b>reset_device</b>(<i>stm32pin: int=7</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4174">[source]</a>
+    <i>def</i> <b>reset_device</b>(<i>stm32pin: int=7</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4175">[source]</a>
 </p>
 
 The function to reset the RTIS device hardware.
@@ -1608,7 +1610,7 @@ The function to reset the RTIS device hardware.
 ## **set_log_mode**
 
 <p class="func-header">
-    <i>def</i> <b>set_log_mode</b>(<i>mode: int</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4220">[source]</a>
+    <i>def</i> <b>set_log_mode</b>(<i>mode: int</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4221">[source]</a>
 </p>
 
 The function to set the logging level of the RTIS Dev module.
@@ -1632,7 +1634,7 @@ The function to set the logging level of the RTIS Dev module.
 ## **set_custom_logger**
 
 <p class="func-header">
-    <i>def</i> <b>set_custom_logger</b>(<i>customLogger: logging.Logger</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4248">[source]</a>
+    <i>def</i> <b>set_custom_logger</b>(<i>customLogger: logging.Logger</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4249">[source]</a>
 </p>
 
 The function to set a custom logger to be used by RTIS Dev.