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 @ cdde954e
......@@ -11,6 +11,7 @@
- [set_recording_settings](#set_recording_settings)
- [set_processing_settings](#set_processing_settings)
- [get_current_settings](#get_current_settings)
- [clear_current_settings](#clear_current_settings)
- [get_settings](#get_settings)
- [set_settings_from_class](#set_settings_from_class)
- [get_premade_processing_settings_list](#get_premade_processing_settings_list)
......@@ -37,7 +38,7 @@
## **RTISMeasurement**
<p class="func-header">
<i>class</i> <b>RTISMeasurement</b>(<i>id: str='', timestamp: float=0, behaviour: bool=False, index: int=0, rawData: np.ndarray=None, processedData: np.ndarray=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L101">[source]</a>
<i>class</i> <b>RTISMeasurement</b>(<i>id: str='', timestamp: float=0, behaviour: bool=False, index: int=0, rawData: np.ndarray=None, processedData: np.ndarray=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L216">[source]</a>
</p>
Class storing all data and information on an RTIS device measurement.
......@@ -83,7 +84,7 @@ Class storing all data and information on an RTIS device measurement.
<p class="func-header">
<i></i> <b>update_processed_data</b>(<i>self, processedData: np.ndarray</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L157">[source]</a>
<i></i> <b>update_processed_data</b>(<i>self, processedData: np.ndarray</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L272">[source]</a>
</p>
If only the processData needs to be updated, use this function.
......@@ -107,7 +108,7 @@ If only the processData needs to be updated, use this function.
## **RTISSettings**
<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/RTISDev.py#L170">[source]</a>
<i>class</i> <b>RTISSettings</b>(<i>firmwareVersion, configName=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L285">[source]</a>
</p>
Class describing all the processing and recording settings related to RTIS devices.
......@@ -121,11 +122,10 @@ Can be converted to a dictionary.
</table>
## **MeasureExternalTriggerQueueThread**
<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/RTISDev.py#L320">[source]</a>
<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/RTISDev.py#L438">[source]</a>
</p>
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
......@@ -163,7 +163,7 @@ measure_thread.join()
<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/RTISDev.py#L351">[source]</a>
<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/RTISDev.py#L469">[source]</a>
</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.
......@@ -187,7 +187,7 @@ Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasureme
<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/RTISDev.py#L362">[source]</a>
<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/RTISDev.py#L480">[source]</a>
</p>
Stop the measurement thread gracefully.
......@@ -204,7 +204,7 @@ Stop the measurement thread gracefully.
<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/RTISDev.py#L369">[source]</a>
<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/RTISDev.py#L487">[source]</a>
</p>
Get status of the thread if it should be stopped or not.
......@@ -221,7 +221,7 @@ Get status of the thread if it should be stopped or not.
<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/RTISDev.py#L375">[source]</a>
<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/RTISDev.py#L493">[source]</a>
</p>
Main thread function to run continuously. Should not be used. Use `start()` instead.
......@@ -238,7 +238,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst
## **MeasureExternalTriggerCallbackThread**
<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/RTISDev.py#L421">[source]</a>
<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/RTISDev.py#L541">[source]</a>
</p>
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
......@@ -264,13 +264,13 @@ Create a callback to save the measurement to disk.
index = 0
def save_callback(measurement=None):
if measurement != None:
if measurement.rawData is not None:
data_sonar = measurement.rawData.tobytes()
file_handle_data = open(str(index) + ".bin","wb")
file_handle_data.write(data_sonar)
file_handle_data.close()
index = index + 1
if measurement != None:
if measurement.rawData is not None:
data_sonar = measurement.rawData.tobytes()
file_handle_data = open(str(index) + ".bin","wb")
file_handle_data.write(data_sonar)
file_handle_data.close()
index = index + 1
measure_thread = rtisdev.create_measure_external_trigger_callback(save_callback)
measure_thread.start()
......@@ -282,7 +282,7 @@ measure_thread.join()
<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/RTISDev.py#L458">[source]</a>
<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/RTISDev.py#L578">[source]</a>
</p>
......@@ -306,7 +306,7 @@ measure_thread.join()
<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/RTISDev.py#L469">[source]</a>
<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/RTISDev.py#L589">[source]</a>
</p>
Stop the measurement thread gracefully.
......@@ -323,7 +323,7 @@ Stop the measurement thread gracefully.
<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/RTISDev.py#L476">[source]</a>
<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/RTISDev.py#L596">[source]</a>
</p>
Get status of the thread if it should be stopped or not.
......@@ -340,7 +340,7 @@ Get status of the thread if it should be stopped or not.
<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/RTISDev.py#L482">[source]</a>
<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/RTISDev.py#L602">[source]</a>
</p>
Main thread function to run continuously. Should not be used. Use `start()` instead.
......@@ -359,7 +359,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst
## **open_connection**
<p class="func-header">
<i>def</i> <b>open_connection</b>(<i>port: string='/dev/ttyACM0'</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L1695">[source]</a>
<i>def</i> <b>open_connection</b>(<i>port: string='/dev/ttyACM0'</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L1838">[source]</a>
</p>
The function to connect to the port of the RTIS Hardware.
......@@ -379,7 +379,7 @@ The function to connect to the port of the RTIS Hardware.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -390,7 +390,7 @@ The function to connect to the port of the RTIS Hardware.
## **close_connection**
<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/RTISDev.py#L1741">[source]</a>
<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/RTISDev.py#L1883">[source]</a>
</p>
The public function to manually close the connection to the RTIS device.
......@@ -403,7 +403,7 @@ The public function to manually close the connection to the RTIS device.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -414,7 +414,7 @@ The public function to manually close the connection to the RTIS device.
## **set_recording_settings**
<p class="func-header">
<i>def</i> <b>set_recording_settings</b>(<i>premade: str=None, jsonPath: str=None, callCustom: str=None, microphoneSamples: int=163840, microphoneSampleFrequency: int=4500000, callSampleFrequency: int=450000, callDuration: float=2.5, callMinimumFrequency: int=25000, callMaximumFrequency: int=50000, callEmissions: int=1</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L1767">[source]</a>
<i>def</i> <b>set_recording_settings</b>(<i>premade: str=None, jsonPath: str=None, callCustom: str=None, microphoneSamples: int=163840, microphoneSampleFrequency: int=4500000, callSampleFrequency: int=450000, callDuration: float=2.5, callMinimumFrequency: int=25000, callMaximumFrequency: int=50000, callEmissions: int=1, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L1910">[source]</a>
</p>
The function to set the recording settings. All parameters are optional and most have default values.
......@@ -465,13 +465,17 @@ Please read their decription carefully.
<b>callEmissions : <i>int (default = 1)</i></b>
<p class="attr">
The amount of times the pulse should be emitted during one measurement.
</p>
<b>configName : <i>String (default = "")</i></b>
<p class="attr">
String to identify these settings with. If set to empty (as it is by default), it will become the name set for premade. If no premade settings are used it will default to <em>RTISSettings</em>.
</p></td>
</tr>
<tr class="field">
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -509,7 +513,7 @@ rtisdev.set_recording_settings(jsonPath="./myrecordingsettings.json")
Create settings from a json file.
This expects a json to be available with a format such as seen below.
Here we use manually generated call.
It has to be available on the given path and have the right format!
It has to be available on the given path and have the right format.
An example of such a custom call can be found [here](config/premadeSettings/recording/flutter.csv).
```json
......@@ -533,7 +537,7 @@ rtisdev.set_processing_settings(microphoneSamples=294912, callDuration=3, callMi
callMaximumFrequency=80000)
```
Load in manually generated call. This requires the file to exist on the path and have the right format!
Load in manually generated call. This requires the file to exist on the path and have the right format.
An example of such a custom call can be found [here](config/premadeSettings/recording/flutter.csv).
```python
......@@ -543,7 +547,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv")
## **set_processing_settings**
<p class="func-header">
<i>def</i> <b>set_processing_settings</b>(<i>premade: str=None, jsonPath: str=None, customPath: str=None, microphoneLayout: str='eRTIS_v3D1', mode: int=1, directions: int=181, minRange: float=0.5, maxRange: float=5, microphoneSampleFrequency: int=4500000, pdmEnable: bool=True, matchedFilterEnable: bool=True, beamformingEnable: bool=True, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L1940">[source]</a>
<i>def</i> <b>set_processing_settings</b>(<i>premade: str=None, jsonPath: str=None, customPath: str=None, microphoneLayout: str='eRTIS_v3D1', mode: int=1, directions: int=181, minRange: float=0.5, maxRange: float=5, microphoneSampleFrequency: int=4500000, pdmEnable: bool=True, matchedFilterEnable: bool=True, beamformingEnable: bool=True, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2091">[source]</a>
</p>
The function to set the processing settings. All parameters are optional and most have default values.
......@@ -620,7 +624,7 @@ Please read their decription carefully.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -672,7 +676,7 @@ rtisdev.set_processing_settings(jsonPath="./myprocessingsettings.json")
Create settings from a json file with full processing settings on.
This expects a json to be available with a format such as seen below.
Here we use manually generated processing files.
They have to be available on these paths and have the right format!
They have to be available on these paths and have the right format.
An example of such custom processing files can be found [here](config/premadeSettings/processing/).
```json
......@@ -706,10 +710,10 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder")
## **get_current_settings**
<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/RTISDev.py#L2149">[source]</a>
<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/RTISDev.py#L2297">[source]</a>
</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 settings for processing and recording.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -719,7 +723,7 @@ The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-so
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>settings : <i>RTISSettings</i></b>
<p class="attr">
The complete class containing all RTIS settings for measuring and processing. Returns 'None' on failure.
The complete class containing all RTIS settings for recording and processing. Returns 'None' or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -727,10 +731,27 @@ The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-so
## **clear_current_settings**
<p class="func-header">
<i>def</i> <b>clear_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2314">[source]</a>
</p>
The function to clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) configuration.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
## **get_settings**
<p class="func-header">
<i>def</i> <b>get_settings</b>(<i>recordingPremade: str=None, recordingJsonPath: str=None, recordingCallCustom: str=None, processingPremade: str=None, processingJsonPath: str=None, processingCustomPath: str=None, microphoneSamples: int=163840, microphoneSampleFrequency: int=4500000, callSampleFrequency: int=450000, callDuration: float=2.5, callMinimumFrequency: int=25000, callMaximumFrequency: int=50000, callEmissions: int=1, microphoneLayout: str='eRTIS_v3D1', mode: int=1, directions: int=181, minRange: float=0.5, maxRange: float=5, pdmEnable: bool=True, matchedFilterEnable: bool=True, beamformingEnable: bool=True, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2166">[source]</a>
<i>def</i> <b>get_settings</b>(<i>recordingPremade: str=None, recordingJsonPath: str=None, recordingCallCustom: str=None, processingPremade: str=None, processingJsonPath: str=None, processingCustomPath: str=None, microphoneSamples: int=163840, microphoneSampleFrequency: int=4500000, callSampleFrequency: int=450000, callDuration: float=2.5, callMinimumFrequency: int=25000, callMaximumFrequency: int=50000, callEmissions: int=1, microphoneLayout: str='eRTIS_v3D1', mode: int=1, directions: int=181, minRange: float=0.5, maxRange: float=5, pdmEnable: bool=True, matchedFilterEnable: bool=True, beamformingEnable: bool=True, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2323">[source]</a>
</p>
The function returns a [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object with all chosen recording and processing settings based on the
......@@ -838,13 +859,17 @@ the settings object.
<b>preloadToggle : <i>bool (default = True)</i></b>
<p class="attr">
Toggle for using RTIS CUDA preloading
</p>
<b>configName : <i>String (default = "")</i></b>
<p class="attr">
String to identify these settings with. If set to empty (as it is by default), it will become the name set for recordingPremade. If no premade recording settings are used it will default to <em>RTISSettings</em>.
</p></td>
</tr>
<tr class="field">
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>settings : <i>RTISSettings</i></b>
<p class="attr">
The complete class containing all RTIS settings for measuring and processing. Returns 'None' on failure.
The complete class containing all RTIS settings for recording and processing. Returns 'None' or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -855,10 +880,10 @@ the settings object.
## **set_settings_from_class**
<p class="func-header">
<i>def</i> <b>set_settings_from_class</b>(<i>settings: RTISSettings</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2362">[source]</a>
<i>def</i> <b>set_settings_from_class</b>(<i>settings: RTISSettings</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2522">[source]</a>
</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 settings from an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object. These can be created
with the get_custom_settings() or get_settings() functions.
<table class="docutils field-list field-table" frame="void" rules="none">
......@@ -876,7 +901,7 @@ with the get_custom_settings() or get_settings() functions.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -887,7 +912,7 @@ with the get_custom_settings() or get_settings() functions.
## **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#L2391">[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#L2551">[source]</a>
</p>
The function to get a list of names of all the available premade settings for processing.
......@@ -911,7 +936,7 @@ The function to get a list of names of all the available premade settings for pr
## **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#L2406">[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#L2566">[source]</a>
</p>
The function to get a list of names of all the available premade settings for recording.
......@@ -935,10 +960,10 @@ The function to get a list of names of all the available premade settings for re
## **prepare_processing**
<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/RTISDev.py#L2420">[source]</a>
<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/RTISDev.py#L2580">[source]</a>
</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.
But speeds up the workflow significantly if doing many measurements.
<table class="docutils field-list field-table" frame="void" rules="none">
......@@ -949,7 +974,7 @@ But speeds up the workflow significantly if doing many measurements.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -960,7 +985,7 @@ But speeds up the workflow significantly if doing many measurements.
## **unload_processing**
<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/RTISDev.py#L2450">[source]</a>
<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/RTISDev.py#L2605">[source]</a>
</p>
The high level function to stop the CUDA workers. Only required if actually using preloading of workers.
......@@ -973,7 +998,7 @@ The high level function to stop the CUDA workers. Only required if actually usin
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -984,7 +1009,7 @@ The high level function to stop the CUDA workers. Only required if actually usin
## **get_raw_measurement**
<p class="func-header">
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2463">[source]</a>
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2618">[source]</a>
</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.
......@@ -1023,7 +1048,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2497">[source]</a>
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2650">[source]</a>
</p>
The high level function to start an RTIS sonar measurement and process it with only PDM filtering
......@@ -1064,7 +1089,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2540">[source]</a>
<i>def</i> <b>get_processed_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2688">[source]</a>
</p>
The high level function to start an RTIS sonar measurement and process it and return the raw and processed data
......@@ -1105,7 +1130,7 @@ processed_measurement = rtisdev.get_processed_measurement(True)
## **process_measurement**
<p class="func-header">
<i>def</i> <b>process_measurement</b>(<i>measurement: RTISMeasurement</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2583">[source]</a>
<i>def</i> <b>process_measurement</b>(<i>measurement: RTISMeasurement</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2726">[source]</a>
</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
......@@ -1148,7 +1173,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#L2627">[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#L2765">[source]</a>
</p>
High level function to set the internal measurement counter of the sonar hardware.
......@@ -1168,7 +1193,7 @@ High level function to set the internal measurement counter of the sonar hardwar
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -1179,7 +1204,7 @@ High level function to set the internal measurement counter of the sonar hardwar
## **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#L2650">[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#L2788">[source]</a>
</p>
Set the behaviour of the sonar hardware to passive or active. This is only necessary if using external
......@@ -1202,7 +1227,7 @@ argument to define the sonar behaviour.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -1213,7 +1238,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#L2675">[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#L2813">[source]</a>
</p>
Get the firmware version of the internal RTIS firmware used on the device.
......@@ -1226,7 +1251,7 @@ Get the firmware version of the internal RTIS firmware used on the device.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>firmwareVersion : <i>string</i></b>
<p class="attr">
returns the firmware version as a string in 'vMajor.Minor.Bugfix' format. Returns 'undefined' on failure.
returns the firmware version as a string in 'vMajor.Minor.Bugfix' format. Returns 'undefined' or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -1237,7 +1262,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 </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2689">[source]</a>
<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/RTISDev.py#L2828">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1282,7 +1307,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]</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2727">[source]</a>
<i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback: Callable[[ RTISMeasurement], any]</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2866">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1317,13 +1342,13 @@ Create a callback to save the measurement to disk.
index = 0
def save_callback(measurement=None):
if measurement != None:
if measurement.rawData is not None:
data_sonar = measurement.rawData.tobytes()
file_handle_data = open(str(index) + ".bin","wb")
file_handle_data.write(data_sonar)
file_handle_data.close()
index = index + 1
if measurement != None:
if measurement.rawData is not None:
data_sonar = measurement.rawData.tobytes()
file_handle_data = open(str(index) + ".bin","wb")
file_handle_data.write(data_sonar)
file_handle_data.close()
index = index + 1
measure_thread = rtisdev.create_measure_external_trigger_callback(save_callback)
measure_thread.start()
......@@ -1333,7 +1358,7 @@ measure_thread.join()
## **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#L2774">[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#L2913">[source]</a>
</p>
Enable/disable the high voltage amplifier's step up controller.
......@@ -1354,7 +1379,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -1365,7 +1390,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav
## **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#L2797">[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#L2936">[source]</a>
</p>
Enable/disable external triggers being able to start a measurement on the RTIS device.
......@@ -1386,7 +1411,7 @@ They are enabled by default so have to be manually disabled.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -1397,7 +1422,7 @@ They are enabled by default so have to be manually disabled.
## **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#L2820">[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#L2959">[source]</a>
</p>
The function to reset the RTIS device hardware.
......@@ -1417,7 +1442,7 @@ The function to reset the RTIS device hardware.
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
returns <code>True</code> on successful completion, returns <code>False</code> or will raise an exception on failure.
</p></td>
</tr>
</tbody>
......@@ -1428,7 +1453,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#L2868">[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#L3007">[source]</a>
</p>
The function to set the logging level of the RTIS Dev module.
......@@ -1452,7 +1477,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#L2898">[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#L3037">[source]</a>
</p>
The function to set a custom logger to be used by RTIS Dev.
......@@ -1465,7 +1490,7 @@ The function to set a custom logger to be used by RTIS Dev.
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>customLogger : <i>logging.Logger</i></b>
<p class="attr">
The custom logger to use.
</p></td>
</tr>
</tbody>
......