... | @@ -189,7 +189,6 @@ Class storing all data and information on an RTIS device measurement. |
... | @@ -189,7 +189,6 @@ Class storing all data and information on an RTIS device measurement. |
|
</tbody>
|
|
</tbody>
|
|
</table>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
## **RTISSettings**
|
|
## **RTISSettings**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
... | @@ -257,7 +256,7 @@ Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit |
... | @@ -257,7 +256,7 @@ Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit |
|
## **open_connection**
|
|
## **open_connection**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>open_connection</b>(<i>port: string='/dev/ttyACM0', allowDebugMode: bool=False </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2431">[source]</a>
|
|
<i>def</i> <b>open_connection</b>(<i>port: string='/dev/ttyACM0', allowDebugMode: bool=False </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2408">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Connect to the port of the RTIS Hardware.
|
|
Connect to the port of the RTIS Hardware.
|
... | @@ -292,7 +291,7 @@ Connect to the port of the RTIS Hardware. |
... | @@ -292,7 +291,7 @@ 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/RTISDev.py#L2535">[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#L2512">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Manually close the connection to the RTIS device.
|
|
Manually close the connection to the RTIS device.
|
... | @@ -318,7 +317,7 @@ be closed gracefully. |
... | @@ -318,7 +317,7 @@ be closed gracefully. |
|
## **set_recording_settings**
|
|
## **set_recording_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<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, configName: str= '', applyToDevice: bool=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2568">[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= '', applyToDevice: bool=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2545">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the recording settings. All parameters are optional and most have default values.
|
|
Set the recording settings. All parameters are optional and most have default values.
|
... | @@ -451,7 +450,7 @@ An example of such a custom call can be found [here](https://cosysgit.uantwerpen |
... | @@ -451,7 +450,7 @@ An example of such a custom call can be found [here](https://cosysgit.uantwerpen |
|
## **set_processing_settings**
|
|
## **set_processing_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L2742">[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, 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#L2719">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the processing settings. All parameters are optional and most have default values.
|
|
Set the processing settings. All parameters are optional and most have default values.
|
... | @@ -495,10 +494,6 @@ Please read their decription carefully. |
... | @@ -495,10 +494,6 @@ Please read their decription carefully. |
|
<p class="attr">
|
|
<p class="attr">
|
|
The maximum distance in meters of the energyscape to generate.
|
|
The maximum distance in meters of the energyscape to generate.
|
|
</p>
|
|
</p>
|
|
<b>microphoneSampleFrequency : <i>int (default = 4500000)</i></b>
|
|
|
|
<p class="attr">
|
|
|
|
The microphone sample frequency (without subsampling of PDM). The frequency must be 4.5 MHz(ultrasound) or 1.125 MHz(audible) depending on the wanted mode.
|
|
|
|
</p>
|
|
|
|
<b>pdmEnable : <i>bool (default = True)</i></b>
|
|
<b>pdmEnable : <i>bool (default = True)</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
Toggle for PDM filtering part of the RTIS processing pipeline using RTIS CUDA.
|
|
Toggle for PDM filtering part of the RTIS processing pipeline using RTIS CUDA.
|
... | @@ -553,17 +548,16 @@ Create settings from a premade setup with only part of the processing steps enab |
... | @@ -553,17 +548,16 @@ Create settings from a premade setup with only part of the processing steps enab |
|
You can get the available premade settings with [`get_premade_recording_settings_list()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#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/-/wikis/home#get_premade_processing_settings_list):
|
|
|
|
|
|
```python
|
|
```python
|
|
>>> rtisdev.set_processing_settings(premade="2D_5m_181", pdmEnable=True, matchedFilterEnable=True, beamformingEnable=False, enveloppeEnable=False, cleanEnable=False)
|
|
>>> rtisdev.set_processing_settingsde="2D_5m_181", pdmEnable=True, matchedFilterEnable=True, beamformingEnable=False, enveloppeEnable=False, cleanEnable=False)
|
|
```
|
|
```
|
|
|
|
|
|
Create settings from a json file with full processing settings on.
|
|
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.
|
|
This expects a json to be available wit(premah a format such as seen below.
|
|
An example of such json files can be found [here](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/config/premadeSettings/processing/).
|
|
An example of such json files can be found [here](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/config/premadeSettings/processing/).
|
|
Here we use auto-generated processing files:
|
|
Here we use auto-generated processing files:
|
|
|
|
|
|
{
|
|
{
|
|
"microphoneLayout" : "eRTIS_v3D1",
|
|
"microphoneLayout" : "eRTIS_v3D1",
|
|
"microphoneSampleFrequency" : 4500000,
|
|
|
|
"minRange" : 0.5,
|
|
"minRange" : 0.5,
|
|
"maxRange" : 5,
|
|
"maxRange" : 5,
|
|
"directions": 181,
|
|
"directions": 181,
|
... | @@ -582,7 +576,6 @@ An example of such custom processing files can be found [here](https://cosysgit. |
... | @@ -582,7 +576,6 @@ An example of such custom processing files can be found [here](https://cosysgit. |
|
|
|
|
|
{
|
|
{
|
|
"microphoneLayout" : "eRTIS_v3D1",
|
|
"microphoneLayout" : "eRTIS_v3D1",
|
|
"microphoneSampleFrequency" : 4500000,
|
|
|
|
"directionsCustom": "./directions.csv",
|
|
"directionsCustom": "./directions.csv",
|
|
"delayMatrixCustom": ".premade/delaymatrix.csv",
|
|
"delayMatrixCustom": ".premade/delaymatrix.csv",
|
|
"rangesCustom": ".premade/ranges.csv"
|
|
"rangesCustom": ".premade/ranges.csv"
|
... | @@ -610,7 +603,7 @@ An example of such custom processing files can be found [here](https://cosysgit. |
... | @@ -610,7 +603,7 @@ An example of such custom processing files can be found [here](https://cosysgit. |
|
## **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/RTISDev.py#L2940">[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#L2925">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current settings for processing and recording.
|
|
Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current settings for processing and recording.
|
... | @@ -634,7 +627,7 @@ Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisde |
... | @@ -634,7 +627,7 @@ Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisde |
|
## **clear_current_settings**
|
|
## **clear_current_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L2957">[source]</a>
|
|
<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#L2942">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) configuration.
|
|
Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) configuration.
|
... | @@ -651,7 +644,7 @@ Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-s |
... | @@ -651,7 +644,7 @@ Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-s |
|
## **get_settings**
|
|
## **get_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<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, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2966">[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#L2951">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Returns an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object with all chosen recording and processing settings based on the
|
|
Returns an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object with all chosen recording and processing settings based on the
|
... | @@ -781,7 +774,7 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
... | @@ -781,7 +774,7 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
|
## **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: RTISSettings, applyToDevice: bool=True </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3169">[source]</a>
|
|
<i>def</i> <b>set_settings_from_class</b>(<i>settings: RTISSettings, applyToDevice: bool=True </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3154">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the wanted settings from an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object. These can be created
|
|
Set the wanted settings from an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object. These can be created
|
... | @@ -817,7 +810,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev |
... | @@ -817,7 +810,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev |
|
## **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/RTISDev.py#L3203">[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#L3188">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Get a list of names of all the available premade settings for processing.
|
|
Get a list of names of all the available premade settings for processing.
|
... | @@ -841,7 +834,7 @@ Get a list of names of all the available premade settings for processing. |
... | @@ -841,7 +834,7 @@ Get a list of names of all the available premade settings for processing. |
|
## **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/RTISDev.py#L3218">[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#L3203">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Get a list of names of all the available premade settings for recording.
|
|
Get a list of names of all the available premade settings for recording.
|
... | @@ -865,7 +858,7 @@ Get a list of names of all the available premade settings for recording. |
... | @@ -865,7 +858,7 @@ Get a list of names of all the available premade settings for recording. |
|
## **get_microphone_layout_list**
|
|
## **get_microphone_layout_list**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>get_microphone_layout_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3233">[source]</a>
|
|
<i>def</i> <b>get_microphone_layout_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3218">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Get a list of names of all the available microphone layouts that are available for recording.
|
|
Get a list of names of all the available microphone layouts that are available for recording.
|
... | @@ -889,7 +882,7 @@ Get a list of names of all the available microphone layouts that are available f |
... | @@ -889,7 +882,7 @@ Get a list of names of all the available microphone layouts that are available f |
|
## **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/RTISDev.py#L3247">[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#L3232">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
... | @@ -916,7 +909,7 @@ Furthermore, if using the default settings for processing this is enabled alread |
... | @@ -916,7 +909,7 @@ Furthermore, if using the default settings for processing this is enabled alread |
|
## **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/RTISDev.py#L3274">[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#L3259">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Stop all CUDA workers.
|
|
Stop all CUDA workers.
|
... | @@ -942,7 +935,7 @@ stopped when your script ends. |
... | @@ -942,7 +935,7 @@ stopped when your script ends. |
|
## **get_raw_measurement**
|
|
## **get_raw_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3289">[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#L3274">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object.
|
|
Start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object.
|
... | @@ -983,7 +976,7 @@ Create a connection, set recording settings and make a raw measurement with pass |
... | @@ -983,7 +976,7 @@ Create a connection, set recording settings and make a raw measurement with pass |
|
## **get_signal_measurement**
|
|
## **get_signal_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3321">[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#L3306">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start an RTIS sonar measurement and process it with only PDM filtering
|
|
Start an RTIS sonar measurement and process it with only PDM filtering
|
... | @@ -1027,7 +1020,7 @@ Create a connection, set recording and processing settings and make a signal mea |
... | @@ -1027,7 +1020,7 @@ Create a connection, set recording and processing settings and make a signal mea |
|
## **get_processed_measurement**
|
|
## **get_processed_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3360">[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#L3345">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start an RTIS sonar measurement and process it and return the raw and processed data
|
|
Start an RTIS sonar measurement and process it and return the raw and processed data
|
... | @@ -1070,7 +1063,7 @@ a processed measurement with active behaviour: |
... | @@ -1070,7 +1063,7 @@ a processed measurement with active behaviour: |
|
## **process_measurement**
|
|
## **process_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3399">[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#L3384">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Process a previously recorded raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object
|
|
Process a previously recorded raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object
|
... | @@ -1114,7 +1107,7 @@ Then afterwards process it: |
... | @@ -1114,7 +1107,7 @@ Then afterwards process it: |
|
## **set_counter**
|
|
## **set_counter**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3437">[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#L3422">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the internal measurement counter of the sonar hardware.
|
|
Set the internal measurement counter of the sonar hardware.
|
... | @@ -1145,7 +1138,7 @@ Set the internal measurement counter of the sonar hardware. |
... | @@ -1145,7 +1138,7 @@ Set the internal measurement counter of the sonar hardware. |
|
## **set_behaviour**
|
|
## **set_behaviour**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3460">[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#L3445">[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
|
... | @@ -1179,7 +1172,7 @@ argument to define the sonar behaviour. |
... | @@ -1179,7 +1172,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/RTISDev.py#L3485">[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#L3470">[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.
|
... | @@ -1203,7 +1196,7 @@ Get the firmware version of the internal RTIS firmware used on the device. |
... | @@ -1203,7 +1196,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: Queue </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3500">[source]</a>
|
|
<i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue: Queue </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3485">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Process
|
|
This will create and return a Multiprocessing Process
|
... | @@ -1251,7 +1244,7 @@ Create a queue to save the measurement to and assign it to the process: |
... | @@ -1251,7 +1244,7 @@ Create a queue to save the measurement to and assign it to the process: |
|
## **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: Callable[[ RTISMeasurement], any]</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3562">[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#L3547">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Process
|
|
This will create and return a Multiprocessing Process
|
... | @@ -1305,7 +1298,7 @@ Create a callback to save the measurement to disk: |
... | @@ -1305,7 +1298,7 @@ Create a callback to save the measurement to disk: |
|
## **create_processing_workers**
|
|
## **create_processing_workers**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>create_processing_workers</b>(<i>workerCount: int, inputQueue: Queue, outputQueue: Queue</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3633">[source]</a>
|
|
<i>def</i> <b>create_processing_workers</b>(<i>workerCount: int, inputQueue: Queue, outputQueue: Queue</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3618">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Pool that will generate a chosen amount of processing
|
|
This will create and return a Multiprocessing Pool that will generate a chosen amount of processing
|
... | @@ -1372,7 +1365,7 @@ Once the work is done, terminate the workers gracefully: |
... | @@ -1372,7 +1365,7 @@ Once the work is done, terminate the workers gracefully: |
|
## **toggle_amplifier**
|
|
## **toggle_amplifier**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3697">[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#L3682">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Enable/disable the high voltage amplifier's step up controller.
|
|
Enable/disable the high voltage amplifier's step up controller.
|
... | @@ -1405,7 +1398,7 @@ This will save on power usage and heat production. |
... | @@ -1405,7 +1398,7 @@ This will save on power usage and heat production. |
|
## **toggle_external_triggers**
|
|
## **toggle_external_triggers**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3719">[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#L3704">[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.
|
... | @@ -1437,7 +1430,7 @@ They are disabled by default so have to be manually enabled. |
... | @@ -1437,7 +1430,7 @@ They are disabled by default so have to be manually enabled. |
|
## **reset_device**
|
|
## **reset_device**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3740">[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#L3725">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
The function to reset the RTIS device hardware.
|
|
The function to reset the RTIS device hardware.
|
... | @@ -1468,7 +1461,7 @@ The function to reset the RTIS device hardware. |
... | @@ -1468,7 +1461,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: int</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3786">[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#L3771">[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.
|
... | @@ -1492,7 +1485,7 @@ The function to set the logging level of the RTIS Dev module. |
... | @@ -1492,7 +1485,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: logging.Logger</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3814">[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#L3799">[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.
|
... | | ... | |