Skip to content

GitLab

Home · Changes

Page history
Update home authored by Wouter Jansen's avatar Wouter Jansen
Hide whitespace changes
Inline Side-by-side
home.md
View page @ d271cdab
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
## **RTISMeasurement** ## **RTISMeasurement**
<p class="func-header"> <p class="func-header">
<i>class</i> <b>RTISMeasurement</b>(<i>id, timestamp, behaviour, index, rawData, processedData=None </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L100">[source]</a> <i>class</i> <b>RTISMeasurement</b>(<i>id, timestamp, behaviour, index, rawData, processedData=None </i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L100">[source]</a>
</p> </p>
Class storing all data and information on an RTIS device measurement. Class storing all data and information on an RTIS device measurement.
...@@ -82,7 +82,7 @@ Class storing all data and information on an RTIS device measurement. ...@@ -82,7 +82,7 @@ Class storing all data and information on an RTIS device measurement.
<p class="func-header"> <p class="func-header">
<i></i> <b>update_processed_data</b>(<i>self, processedData</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L162">[source]</a> <i></i> <b>update_processed_data</b>(<i>self, processedData</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L162">[source]</a>
</p> </p>
If only the processData needs to be updated, use this function. If only the processData needs to be updated, use this function.
...@@ -106,7 +106,7 @@ If only the processData needs to be updated, use this function. ...@@ -106,7 +106,7 @@ If only the processData needs to be updated, use this function.
## **RTISSettings** ## **RTISSettings**
<p class="func-header"> <p class="func-header">
<i>class</i> <b>RTISSettings</b>(<i>firmwareVersion</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L175">[source]</a> <i>class</i> <b>RTISSettings</b>(<i>firmwareVersion</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L175">[source]</a>
</p> </p>
Class describing all the processing and recording settings related to RTIS devices. Class describing all the processing and recording settings related to RTIS devices.
...@@ -120,11 +120,10 @@ Can be converted to a dictionary. ...@@ -120,11 +120,10 @@ Can be converted to a dictionary.
</table> </table>
## **MeasureExternalTriggerQueueThread** ## **MeasureExternalTriggerQueueThread**
<p class="func-header"> <p class="func-header">
<i>class</i> <b>MeasureExternalTriggerQueueThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L327">[source]</a> <i>class</i> <b>MeasureExternalTriggerQueueThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L327">[source]</a>
</p> </p>
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger. The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
...@@ -162,7 +161,7 @@ measure_thread.join() ...@@ -162,7 +161,7 @@ measure_thread.join()
<p class="func-header"> <p class="func-header">
<i></i> <b>set_queue</b>(<i>self, dataQueue</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L358">[source]</a> <i></i> <b>set_queue</b>(<i>self, dataQueue</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L358">[source]</a>
</p> </p>
Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) objects on. Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) objects on.
...@@ -186,7 +185,7 @@ Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasureme ...@@ -186,7 +185,7 @@ Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasureme
<p class="func-header"> <p class="func-header">
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L369">[source]</a> <i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L369">[source]</a>
</p> </p>
Stop the measurement thread gracefully. Stop the measurement thread gracefully.
...@@ -203,7 +202,7 @@ Stop the measurement thread gracefully. ...@@ -203,7 +202,7 @@ Stop the measurement thread gracefully.
<p class="func-header"> <p class="func-header">
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L376">[source]</a> <i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L376">[source]</a>
</p> </p>
Get status of the thread if it should be stopped or not. Get status of the thread if it should be stopped or not.
...@@ -220,7 +219,7 @@ Get status of the thread if it should be stopped or not. ...@@ -220,7 +219,7 @@ Get status of the thread if it should be stopped or not.
<p class="func-header"> <p class="func-header">
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L382">[source]</a> <i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L382">[source]</a>
</p> </p>
Main thread function to run continuously. Should not be used. Use `start()` instead. Main thread function to run continuously. Should not be used. Use `start()` instead.
...@@ -237,7 +236,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst ...@@ -237,7 +236,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst
## **MeasureExternalTriggerCallbackThread** ## **MeasureExternalTriggerCallbackThread**
<p class="func-header"> <p class="func-header">
<i>class</i> <b>MeasureExternalTriggerCallbackThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L428">[source]</a> <i>class</i> <b>MeasureExternalTriggerCallbackThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L428">[source]</a>
</p> </p>
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger. The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
...@@ -281,7 +280,7 @@ measure_thread.join() ...@@ -281,7 +280,7 @@ measure_thread.join()
<p class="func-header"> <p class="func-header">
<i></i> <b>set_callback</b>(<i>self, callback</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L465">[source]</a> <i></i> <b>set_callback</b>(<i>self, callback</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L465">[source]</a>
</p> </p>
...@@ -305,7 +304,7 @@ measure_thread.join() ...@@ -305,7 +304,7 @@ measure_thread.join()
<p class="func-header"> <p class="func-header">
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L476">[source]</a> <i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L476">[source]</a>
</p> </p>
Stop the measurement thread gracefully. Stop the measurement thread gracefully.
...@@ -322,7 +321,7 @@ Stop the measurement thread gracefully. ...@@ -322,7 +321,7 @@ Stop the measurement thread gracefully.
<p class="func-header"> <p class="func-header">
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L483">[source]</a> <i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L483">[source]</a>
</p> </p>
Get status of the thread if it should be stopped or not. Get status of the thread if it should be stopped or not.
...@@ -339,7 +338,7 @@ Get status of the thread if it should be stopped or not. ...@@ -339,7 +338,7 @@ Get status of the thread if it should be stopped or not.
<p class="func-header"> <p class="func-header">
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L489">[source]</a> <i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L489">[source]</a>
</p> </p>
Main thread function to run continuously. Should not be used. Use `start()` instead. Main thread function to run continuously. Should not be used. Use `start()` instead.
...@@ -358,7 +357,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst ...@@ -358,7 +357,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst
## **open_connection** ## **open_connection**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>open_connection</b>(<i>port='/dev/ttyACM0'</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1529">[source]</a> <i>def</i> <b>open_connection</b>(<i>port='/dev/ttyACM0'</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1529">[source]</a>
</p> </p>
The function to connect to the port of the RTIS Hardware. The function to connect to the port of the RTIS Hardware.
...@@ -389,7 +388,7 @@ The function to connect to the port of the RTIS Hardware. ...@@ -389,7 +388,7 @@ The function to connect to the port of the RTIS Hardware.
## **close_connection** ## **close_connection**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>close_connection</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1575">[source]</a> <i>def</i> <b>close_connection</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1575">[source]</a>
</p> </p>
The public function to manually close the connection to the RTIS device. The public function to manually close the connection to the RTIS device.
...@@ -413,7 +412,7 @@ The public function to manually close the connection to the RTIS device. ...@@ -413,7 +412,7 @@ The public function to manually close the connection to the RTIS device.
## **set_recording_settings** ## **set_recording_settings**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>set_recording_settings</b>(<i>premade=None, jsonPath=None, callCustom=None, microphoneSamples=163840, microphoneSampleFrequency=4500000, callSampleFrequency=450000, callDuration=2.5, callMinimumFrequency= 25000, callMaximumFrequency=50000, callEmissions=1</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1601">[source]</a> <i>def</i> <b>set_recording_settings</b>(<i>premade=None, jsonPath=None, callCustom=None, microphoneSamples=163840, microphoneSampleFrequency=4500000, callSampleFrequency=450000, callDuration=2.5, callMinimumFrequency= 25000, callMaximumFrequency=50000, callEmissions=1</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1601">[source]</a>
</p> </p>
The function to set the recording settings. All parameters are optional and most have default values. The function to set the recording settings. All parameters are optional and most have default values.
...@@ -542,7 +541,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv") ...@@ -542,7 +541,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv")
## **set_processing_settings** ## **set_processing_settings**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>set_processing_settings</b>(<i>premade=None, jsonPath=None, customPath=None, microphoneLayout='eRTIS_V3.14159265', mode=1, directions=181, minRange= 0.5, maxRange=5, microphoneSampleFrequency=4500000, pdmEnable=True, matchedFilterEnable=True, beamformingEnable=True, enveloppeEnable=True, cleanEnable=True, preloadToggle=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1761">[source]</a> <i>def</i> <b>set_processing_settings</b>(<i>premade=None, jsonPath=None, customPath=None, microphoneLayout='eRTIS_V3.14159265', mode=1, directions=181, minRange= 0.5, maxRange=5, microphoneSampleFrequency=4500000, pdmEnable=True, matchedFilterEnable=True, beamformingEnable=True, enveloppeEnable=True, cleanEnable=True, preloadToggle=True</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1761">[source]</a>
</p> </p>
The function to set the processing settings. All parameters are optional and most have default values. The function to set the processing settings. All parameters are optional and most have default values.
...@@ -705,7 +704,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder") ...@@ -705,7 +704,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder")
## **get_current_settings** ## **get_current_settings**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>get_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1958">[source]</a> <i>def</i> <b>get_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1958">[source]</a>
</p> </p>
The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current DSP Settings. The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current DSP Settings.
...@@ -729,7 +728,7 @@ The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-so ...@@ -729,7 +728,7 @@ The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-so
## **set_settings_from_class** ## **set_settings_from_class**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>set_settings_from_class</b>(<i>settings</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1975">[source]</a> <i>def</i> <b>set_settings_from_class</b>(<i>settings</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1975">[source]</a>
</p> </p>
The high level function to set the wanted DSP settings from an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object. These can be created The high level function to set the wanted DSP settings from an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object. These can be created
...@@ -761,7 +760,7 @@ with the get_custom_settings() or get_settings() functions. ...@@ -761,7 +760,7 @@ with the get_custom_settings() or get_settings() functions.
## **get_premade_processing_settings_list** ## **get_premade_processing_settings_list**
<p class="func-header"> <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/RTISDev2.py#L2004">[source]</a> <i>def</i> <b>get_premade_processing_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2004">[source]</a>
</p> </p>
The function to get a list of names of all the available premade settings for processing. The function to get a list of names of all the available premade settings for processing.
...@@ -785,7 +784,7 @@ The function to get a list of names of all the available premade settings for pr ...@@ -785,7 +784,7 @@ The function to get a list of names of all the available premade settings for pr
## **get_premade_recording_settings_list** ## **get_premade_recording_settings_list**
<p class="func-header"> <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/RTISDev2.py#L2019">[source]</a> <i>def</i> <b>get_premade_recording_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2019">[source]</a>
</p> </p>
The function to get a list of names of all the available premade settings for recording. The function to get a list of names of all the available premade settings for recording.
...@@ -809,7 +808,7 @@ The function to get a list of names of all the available premade settings for re ...@@ -809,7 +808,7 @@ The function to get a list of names of all the available premade settings for re
## **prepare_processing** ## **prepare_processing**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>prepare_processing</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2033">[source]</a> <i>def</i> <b>prepare_processing</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2033">[source]</a>
</p> </p>
The high level function to start the CUDA workers for looped measurements. Not required for processing! The high level function to start the CUDA workers for looped measurements. Not required for processing!
...@@ -834,7 +833,7 @@ But speeds up the workflow significantly if doing many measurements. ...@@ -834,7 +833,7 @@ But speeds up the workflow significantly if doing many measurements.
## **unload_processing** ## **unload_processing**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>unload_processing</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2063">[source]</a> <i>def</i> <b>unload_processing</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2063">[source]</a>
</p> </p>
The high level function to stop the CUDA workers. Only required if actually using preloading of workers. The high level function to stop the CUDA workers. Only required if actually using preloading of workers.
...@@ -858,7 +857,7 @@ The high level function to stop the CUDA workers. Only required if actually usin ...@@ -858,7 +857,7 @@ The high level function to stop the CUDA workers. Only required if actually usin
## **get_raw_measurement** ## **get_raw_measurement**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2076">[source]</a> <i>def</i> <b>get_raw_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2076">[source]</a>
</p> </p>
The high level function to start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object. The high level function to start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object.
...@@ -897,7 +896,7 @@ measurement = rtisdev.get_raw_measurement(True) ...@@ -897,7 +896,7 @@ measurement = rtisdev.get_raw_measurement(True)
## **get_signal_measurement** ## **get_signal_measurement**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2110">[source]</a> <i>def</i> <b>get_signal_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2110">[source]</a>
</p> </p>
The high level function to start an RTIS sonar measurement and process it with only PDM filtering The high level function to start an RTIS sonar measurement and process it with only PDM filtering
...@@ -938,7 +937,7 @@ signal_measurement = rtisdev.get_signal_measurement(True) ...@@ -938,7 +937,7 @@ signal_measurement = rtisdev.get_signal_measurement(True)
## **get_processed_measurement** ## **get_processed_measurement**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>get_processed_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2153">[source]</a> <i>def</i> <b>get_processed_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2153">[source]</a>
</p> </p>
The high level function to start an RTIS sonar measurement and process it and return the raw and processed data The high level function to start an RTIS sonar measurement and process it and return the raw and processed data
...@@ -979,7 +978,7 @@ processed_measurement = rtisdev.get_processed_measurement(True) ...@@ -979,7 +978,7 @@ processed_measurement = rtisdev.get_processed_measurement(True)
## **process_measurement** ## **process_measurement**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>process_measurement</b>(<i>measurement</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2196">[source]</a> <i>def</i> <b>process_measurement</b>(<i>measurement</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2196">[source]</a>
</p> </p>
The high level function to process a raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object The high level function to process a raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object
...@@ -1022,7 +1021,7 @@ processed_measurement = rtisdev.process_measurement(measurement) ...@@ -1022,7 +1021,7 @@ processed_measurement = rtisdev.process_measurement(measurement)
## **set_counter** ## **set_counter**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>set_counter</b>(<i>newCount=0</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2240">[source]</a> <i>def</i> <b>set_counter</b>(<i>newCount=0</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2240">[source]</a>
</p> </p>
High level function to set the internal measurement counter of the sonar hardware. High level function to set the internal measurement counter of the sonar hardware.
...@@ -1053,7 +1052,7 @@ High level function to set the internal measurement counter of the sonar hardwar ...@@ -1053,7 +1052,7 @@ High level function to set the internal measurement counter of the sonar hardwar
## **set_behaviour** ## **set_behaviour**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>set_behaviour</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2263">[source]</a> <i>def</i> <b>set_behaviour</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2263">[source]</a>
</p> </p>
Set the behaviour of the sonar hardware to passive or active. This is only necessary if using external Set the behaviour of the sonar hardware to passive or active. This is only necessary if using external
...@@ -1087,7 +1086,7 @@ argument to define the sonar behaviour. ...@@ -1087,7 +1086,7 @@ argument to define the sonar behaviour.
## **get_firmware_version** ## **get_firmware_version**
<p class="func-header"> <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/RTISDev2.py#L2288">[source]</a> <i>def</i> <b>get_firmware_version</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2288">[source]</a>
</p> </p>
Get the firmware version of the internal RTIS firmware used on the device. Get the firmware version of the internal RTIS firmware used on the device.
...@@ -1111,7 +1110,7 @@ Get the firmware version of the internal RTIS firmware used on the device. ...@@ -1111,7 +1110,7 @@ Get the firmware version of the internal RTIS firmware used on the device.
## **create_measure_external_trigger_queue** ## **create_measure_external_trigger_queue**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2302">[source]</a> <i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2302">[source]</a>
</p> </p>
This will create and return a Thread that will be waiting for an external trigger to measure from This will create and return a Thread that will be waiting for an external trigger to measure from
...@@ -1156,7 +1155,7 @@ measure_thread.join() ...@@ -1156,7 +1155,7 @@ measure_thread.join()
## **create_measure_external_trigger_callback** ## **create_measure_external_trigger_callback**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2340">[source]</a> <i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2340">[source]</a>
</p> </p>
This will create and return a Thread that will be waiting for an external trigger to measure from This will create and return a Thread that will be waiting for an external trigger to measure from
...@@ -1207,7 +1206,7 @@ measure_thread.join() ...@@ -1207,7 +1206,7 @@ measure_thread.join()
## **toggle_amplifier** ## **toggle_amplifier**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>toggle_amplifier</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2386">[source]</a> <i>def</i> <b>toggle_amplifier</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2386">[source]</a>
</p> </p>
Enable/disable the high voltage amplifier's step up controller. Enable/disable the high voltage amplifier's step up controller.
...@@ -1239,7 +1238,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav ...@@ -1239,7 +1238,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav
## **toggle_external_triggers** ## **toggle_external_triggers**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>toggle_external_triggers</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2409">[source]</a> <i>def</i> <b>toggle_external_triggers</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2409">[source]</a>
</p> </p>
Enable/disable external triggers being able to start a measurement on the RTIS device. Enable/disable external triggers being able to start a measurement on the RTIS device.
...@@ -1271,7 +1270,7 @@ They are enabled by default so have to be manually disabled. ...@@ -1271,7 +1270,7 @@ They are enabled by default so have to be manually disabled.
## **reset_device** ## **reset_device**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>reset_device</b>(<i>stm32pin=7</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2432">[source]</a> <i>def</i> <b>reset_device</b>(<i>stm32pin=7</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2432">[source]</a>
</p> </p>
The function to reset the RTIS device hardware. The function to reset the RTIS device hardware.
...@@ -1302,7 +1301,7 @@ The function to reset the RTIS device hardware. ...@@ -1302,7 +1301,7 @@ The function to reset the RTIS device hardware.
## **set_log_mode** ## **set_log_mode**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>set_log_mode</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2480">[source]</a> <i>def</i> <b>set_log_mode</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2480">[source]</a>
</p> </p>
The function to set the logging level of the RTIS Dev module. The function to set the logging level of the RTIS Dev module.
...@@ -1326,7 +1325,7 @@ The function to set the logging level of the RTIS Dev module. ...@@ -1326,7 +1325,7 @@ The function to set the logging level of the RTIS Dev module.
## **set_custom_logger** ## **set_custom_logger**
<p class="func-header"> <p class="func-header">
<i>def</i> <b>set_custom_logger</b>(<i>customLogger</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2510">[source]</a> <i>def</i> <b>set_custom_logger</b>(<i>customLogger</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2510">[source]</a>
</p> </p>
The function to set a custom logger to be used by RTIS Dev. The function to set a custom logger to be used by RTIS Dev.
......