Skip to content

GitLab

Home · Changes

Page history
Update home authored by Wouter Jansen's avatar Wouter Jansen
Show whitespace changes
Inline Side-by-side
home.md
View page @ a6916891
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,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="rtisdev/RTISDev.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"></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.
...@@ -48,7 +48,7 @@ Class storing all data and information on an RTIS device measurement. ...@@ -48,7 +48,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="rtisdev/RTISDev.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"></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.
...@@ -72,7 +72,7 @@ If only the processData needs to be updated, use this function. ...@@ -72,7 +72,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="rtisdev/RTISDev.py#L175">[source]</a> <i>class</i> <b>RTISSettings</b>(<i>firmwareVersion</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L175"></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.
...@@ -86,19 +86,21 @@ Can be converted to a dictionary. ...@@ -86,19 +86,21 @@ 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="rtisdev/RTISDev.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"></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.
To set the data queue correctly use `set_queue(dataQueue)` function. To set the data queue correctly use `set_queue(dataQueue)` function.
the [`RTISMeasurement`](DOCUMENTATION.md#rtismeasurement) objects will then be put on this queue. the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) objects will then be put on this queue.
To start the thread use the `start()` function. To stop use the `stop_thread()` function. To start the thread use the `start()` function. To stop use the `stop_thread()` function.
By default using a `signal.SIGINT` exit (ex. using <kbd>CTRL</kbd>+<kbd>C</kbd>) will gracefully end the script. By default using a `signal.SIGINT` exit (ex. using <kbd>CTRL</kbd>+<kbd>C</kbd>) will gracefully end the script.
Use [`create_measure_external_trigger_queue(dataQueue)`](DOCUMENTATION.md#create_measure_external_trigger_queue) to make an easy to use the class. Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#create_measure_external_trigger_queue) to make an easy to use the class.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -127,10 +129,10 @@ measure_thread.join() ...@@ -127,10 +129,10 @@ 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="rtisdev/RTISDev.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"></a>
</p> </p>
Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](DOCUMENTATION.md#rtismeasurement) objects on. Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) objects on.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -151,7 +153,7 @@ Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasureme ...@@ -151,7 +153,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="rtisdev/RTISDev.py#L369">[source]</a> <i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L369"></a>
</p> </p>
Stop the measurement thread gracefully. Stop the measurement thread gracefully.
...@@ -168,7 +170,7 @@ Stop the measurement thread gracefully. ...@@ -168,7 +170,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="rtisdev/RTISDev.py#L376">[source]</a> <i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L376"></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.
...@@ -185,7 +187,7 @@ Get status of the thread if it should be stopped or not. ...@@ -185,7 +187,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="rtisdev/RTISDev.py#L382">[source]</a> <i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L382"></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.
...@@ -202,16 +204,16 @@ Main thread function to run continuously. Should not be used. Use `start()` inst ...@@ -202,16 +204,16 @@ 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="rtisdev/RTISDev.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"></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.
To set the callback function correctly use `set_callback(callback)` function. To set the callback function correctly use `set_callback(callback)` function.
Your callback function should only have one argument, the [`RTISMeasurement`](DOCUMENTATION.md#rtismeasurement) data package. Your callback function should only have one argument, the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) data package.
To start the thread use the `start()` function. To stop use the `stop_thread()` function. To start the thread use the `start()` function. To stop use the `stop_thread()` function.
By default using a `signal.SIGINT` exit (ex. using <kbd>CTRL</kbd>+<kbd>C</kbd>) will gracefully end the script. By default using a `signal.SIGINT` exit (ex. using <kbd>CTRL</kbd>+<kbd>C</kbd>) will gracefully end the script.
Use [`create_measure_external_trigger_callback(save_callback)`](DOCUMENTATION.md#create_measure_external_trigger_callback) to make an easy to use the class. Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#create_measure_external_trigger_callback) to make an easy to use the class.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -246,7 +248,7 @@ measure_thread.join() ...@@ -246,7 +248,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="rtisdev/RTISDev.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"></a>
</p> </p>
...@@ -259,7 +261,7 @@ measure_thread.join() ...@@ -259,7 +261,7 @@ measure_thread.join()
<th class="field-name"><b>Parameters:</b></td> <th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>callback : <i>method with one argument (RTISMeasurement)</i></b> <td class="field-body" width="100%"><b>callback : <i>method with one argument (RTISMeasurement)</i></b>
<p class="attr"> <p class="attr">
This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="DOCUMENTATION.md#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data. This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data.
</p></td> </p></td>
</tr> </tr>
</tbody> </tbody>
...@@ -270,7 +272,7 @@ measure_thread.join() ...@@ -270,7 +272,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="rtisdev/RTISDev.py#L476">[source]</a> <i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L476"></a>
</p> </p>
Stop the measurement thread gracefully. Stop the measurement thread gracefully.
...@@ -287,7 +289,7 @@ Stop the measurement thread gracefully. ...@@ -287,7 +289,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="rtisdev/RTISDev.py#L483">[source]</a> <i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L483"></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.
...@@ -304,7 +306,7 @@ Get status of the thread if it should be stopped or not. ...@@ -304,7 +306,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="rtisdev/RTISDev.py#L489">[source]</a> <i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L489"></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.
...@@ -322,7 +324,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst ...@@ -322,7 +324,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="rtisdev/RTISDev.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"></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.
...@@ -353,7 +355,7 @@ The function to connect to the port of the RTIS Hardware. ...@@ -353,7 +355,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="rtisdev/RTISDev.py#L1575">[source]</a> <i>def</i> <b>close_connection</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1575"></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.
...@@ -370,7 +372,7 @@ The public function to manually close the connection to the RTIS device. ...@@ -370,7 +372,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="rtisdev/RTISDev.py#L1591">[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#L1591"></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.
...@@ -436,7 +438,7 @@ Please read their decription carefully. ...@@ -436,7 +438,7 @@ Please read their decription carefully.
#### Examples #### Examples
Create settings from a premade setup. Create settings from a premade setup.
You can get the available premade settings with [`get_premade_recording_settings_list()`](DOCUMENTATION.md#get_premade_processing_settings_list). You can get the available premade settings with [`get_premade_recording_settings_list()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_premade_processing_settings_list).
```python ```python
rtisdev.set_recording_settings(premade="short_20_80") rtisdev.set_recording_settings(premade="short_20_80")
...@@ -499,7 +501,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv") ...@@ -499,7 +501,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="rtisdev/RTISDev.py#L1751">[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#L1751"></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.
...@@ -585,7 +587,7 @@ Please read their decription carefully. ...@@ -585,7 +587,7 @@ Please read their decription carefully.
#### Examples #### Examples
Create settings from a premade setup with all processing steps on. Create settings from a premade setup with all processing steps on.
You can get the available premade settings with [`get_premade_recording_settings_list()`](DOCUMENTATION.md#get_premade_processing_settings_list). You can get the available premade settings with [`get_premade_recording_settings_list()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_premade_processing_settings_list).
```python ```python
rtisdev.set_processing_settings(premade="3D_5m_3000", pdmEnable=True, matchedFilterEnable=True, rtisdev.set_processing_settings(premade="3D_5m_3000", pdmEnable=True, matchedFilterEnable=True,
...@@ -599,7 +601,7 @@ rtisdev.set_processing_settings(premade="3D_5m_3000") ...@@ -599,7 +601,7 @@ rtisdev.set_processing_settings(premade="3D_5m_3000")
``` ```
Create settings from a premade setup with only part of the processing steps enabled and no preloading. Create settings from a premade setup with only part of the processing steps enabled and no preloading.
You can get the available premade settings with [`get_premade_recording_settings_list()`](DOCUMENTATION.md#get_premade_processing_settings_list). You can get the available premade settings with [`get_premade_recording_settings_list()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_premade_processing_settings_list).
```python ```python
rtisdev.set_processing_settings(premade="2D_5m_181", pdmEnable=True, matchedFilterEnable=True, rtisdev.set_processing_settings(premade="2D_5m_181", pdmEnable=True, matchedFilterEnable=True,
...@@ -662,10 +664,10 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder") ...@@ -662,10 +664,10 @@ 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="rtisdev/RTISDev.py#L1948">[source]</a> <i>def</i> <b>get_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1948"></a>
</p> </p>
The function returns the [`RTISSettings`](DOCUMENTATION.md#rtissettings) object of the current DSP Settings. The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtissettings) object of the current DSP Settings.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -686,10 +688,10 @@ The function returns the [`RTISSettings`](DOCUMENTATION.md#rtissettings) object ...@@ -686,10 +688,10 @@ The function returns the [`RTISSettings`](DOCUMENTATION.md#rtissettings) object
## **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="rtisdev/RTISDev.py#L1962">[source]</a> <i>def</i> <b>set_settings_from_class</b>(<i>settings</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1962"></a>
</p> </p>
The high level function to set the wanted DSP settings from an [`RTISSettings`](DOCUMENTATION.md#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#rtissettings) object. These can be created
with the get_custom_settings() or get_settings() functions. with the get_custom_settings() or get_settings() functions.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
...@@ -718,7 +720,7 @@ with the get_custom_settings() or get_settings() functions. ...@@ -718,7 +720,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="rtisdev/RTISDev.py#L1991">[source]</a> <i>def</i> <b>get_premade_processing_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1991"></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.
...@@ -742,7 +744,7 @@ The function to get a list of names of all the available premade settings for pr ...@@ -742,7 +744,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="rtisdev/RTISDev.py#L2006">[source]</a> <i>def</i> <b>get_premade_recording_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2006"></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.
...@@ -766,7 +768,7 @@ The function to get a list of names of all the available premade settings for re ...@@ -766,7 +768,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="rtisdev/RTISDev.py#L2020">[source]</a> <i>def</i> <b>prepare_processing</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2020"></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!
...@@ -791,7 +793,7 @@ But speeds up the workflow significantly if doing many measurements. ...@@ -791,7 +793,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="rtisdev/RTISDev.py#L2048">[source]</a> <i>def</i> <b>unload_processing</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2048"></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.
...@@ -815,10 +817,10 @@ The high level function to stop the CUDA workers. Only required if actually usin ...@@ -815,10 +817,10 @@ 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="rtisdev/RTISDev.py#L2061">[source]</a> <i>def</i> <b>get_raw_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2061"></a>
</p> </p>
The high level function to start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](DOCUMENTATION.md#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#rtismeasurement) object.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -854,11 +856,11 @@ measurement = rtisdev.get_raw_measurement(True) ...@@ -854,11 +856,11 @@ 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="rtisdev/RTISDev.py#L2095">[source]</a> <i>def</i> <b>get_signal_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2095"></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
and subsampling to get the (microphone) signals return them in an [`RTISMeasurement`](DOCUMENTATION.md#rtismeasurement) object. and subsampling to get the (microphone) signals return them in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -895,11 +897,11 @@ signal_measurement = rtisdev.get_signal_measurement(True) ...@@ -895,11 +897,11 @@ 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="rtisdev/RTISDev.py#L2138">[source]</a> <i>def</i> <b>get_processed_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2138"></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
in an [`RTISMeasurement`](DOCUMENTATION.md#rtismeasurement) object. in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -936,11 +938,11 @@ processed_measurement = rtisdev.get_processed_measurement(True) ...@@ -936,11 +938,11 @@ 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="rtisdev/RTISDev.py#L2181">[source]</a> <i>def</i> <b>process_measurement</b>(<i>measurement</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2181"></a>
</p> </p>
The high level function to process a raw RTIS sonar measurement from a [`RTISMeasurement`](DOCUMENTATION.md#rtismeasurement) object The high level function to process a raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object
and return the raw and processed data in a new [`RTISMeasurement`](DOCUMENTATION.md#rtismeasurement) object. and return the raw and processed data in a new [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object.
<table class="docutils field-list field-table" frame="void" rules="none"> <table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
...@@ -979,7 +981,7 @@ processed_measurement = rtisdev.process_measurement(measurement) ...@@ -979,7 +981,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="rtisdev/RTISDev.py#L2225">[source]</a> <i>def</i> <b>set_counter</b>(<i>newCount=0</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2225"></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.
...@@ -1010,7 +1012,7 @@ High level function to set the internal measurement counter of the sonar hardwar ...@@ -1010,7 +1012,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="rtisdev/RTISDev.py#L2248">[source]</a> <i>def</i> <b>set_behaviour</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2248"></a>
</p> </p>
Set the behaviour of the sonar hardware to passive or active Set the behaviour of the sonar hardware to passive or active
...@@ -1041,7 +1043,7 @@ Set the behaviour of the sonar hardware to passive or active ...@@ -1041,7 +1043,7 @@ Set the behaviour of the sonar hardware to passive or active
## **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="rtisdev/RTISDev.py#L2270">[source]</a> <i>def</i> <b>get_firmware_version</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2270"></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.
...@@ -1065,7 +1067,7 @@ Get the firmware version of the internal RTIS firmware used on the device. ...@@ -1065,7 +1067,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="rtisdev/RTISDev.py#L2284">[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#L2284"></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
...@@ -1079,7 +1081,7 @@ the RTIS Device and afterwards put this measurement on a data queue. ...@@ -1079,7 +1081,7 @@ the RTIS Device and afterwards put this measurement on a data queue.
<th class="field-name"><b>Parameters:</b></td> <th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>dataQueue : <i>multiprocessing.Manager.Queue</i></b> <td class="field-body" width="100%"><b>dataQueue : <i>multiprocessing.Manager.Queue</i></b>
<p class="attr"> <p class="attr">
On this queue the <a href="DOCUMENTATION.md#rtismeasurement"><code>RTISMeasurement</code></a> objects will be put after an external trigger starts a new measurement. On this queue the <a href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement"><code>RTISMeasurement</code></a> objects will be put after an external trigger starts a new measurement.
</p></td> </p></td>
</tr> </tr>
<tr class="field"> <tr class="field">
...@@ -1110,7 +1112,7 @@ measure_thread.join() ...@@ -1110,7 +1112,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="rtisdev/RTISDev.py#L2322">[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#L2322"></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
...@@ -1124,7 +1126,7 @@ the RTIS Device and afterwards put this measurement on a data queue. ...@@ -1124,7 +1126,7 @@ the RTIS Device and afterwards put this measurement on a data queue.
<th class="field-name"><b>Parameters:</b></td> <th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>callback : <i>method with one argument of type RTISMeasurement</i></b> <td class="field-body" width="100%"><b>callback : <i>method with one argument of type RTISMeasurement</i></b>
<p class="attr"> <p class="attr">
This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="DOCUMENTATION.md#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data. This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data.
</p></td> </p></td>
</tr> </tr>
<tr class="field"> <tr class="field">
...@@ -1161,7 +1163,7 @@ measure_thread.join() ...@@ -1161,7 +1163,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="rtisdev/RTISDev.py#L2368">[source]</a> <i>def</i> <b>toggle_amplifier</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2368"></a>
</p> </p>
Enable/disable the high voltage amplifier's step up controller. Enable/disable the high voltage amplifier's step up controller.
...@@ -1193,7 +1195,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav ...@@ -1193,7 +1195,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="rtisdev/RTISDev.py#L2391">[source]</a> <i>def</i> <b>toggle_external_triggers</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2391"></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.
...@@ -1225,7 +1227,7 @@ They are enabled by default so have to be manually disabled. ...@@ -1225,7 +1227,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="rtisdev/RTISDev.py#L2414">[source]</a> <i>def</i> <b>reset_device</b>(<i>stm32pin=7</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2414"></a>
</p> </p>
The function to reset the RTIS device hardware. The function to reset the RTIS device hardware.
...@@ -1256,7 +1258,7 @@ The function to reset the RTIS device hardware. ...@@ -1256,7 +1258,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="rtisdev/RTISDev.py#L2462">[source]</a> <i>def</i> <b>set_log_mode</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2462"></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.
...@@ -1280,7 +1282,7 @@ The function to set the logging level of the RTIS Dev module. ...@@ -1280,7 +1282,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="rtisdev/RTISDev.py#L2492">[source]</a> <i>def</i> <b>set_custom_logger</b>(<i>customLogger</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2492"></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.
...@@ -1298,3 +1300,4 @@ The function to set a custom logger to be used by RTIS Dev. ...@@ -1298,3 +1300,4 @@ The function to set a custom logger to be used by RTIS Dev.
</tr> </tr>
</tbody> </tbody>
</table> </table>