... | @@ -172,6 +172,12 @@ Class describing all the processing and recording settings related to RTIS devic |
... | @@ -172,6 +172,12 @@ Class describing all the processing and recording settings related to RTIS devic |
|
Too many variables to describe here. Check the source-code for more information on which variables are available.
|
|
Too many variables to describe here. Check the source-code for more information on which variables are available.
|
|
Can be converted to a dictionary.
|
|
Can be converted to a dictionary.
|
|
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
|
|
<col class="field-name" />
|
|
|
|
<col class="field-body" />
|
|
|
|
<tbody valign="top">
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
## **MeasureExternalTriggerQueueThread**
|
|
## **MeasureExternalTriggerQueueThread**
|
|
|
|
|
... | @@ -410,7 +416,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst |
... | @@ -410,7 +416,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: 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#L1933">[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#L1984">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Connect to the port of the RTIS Hardware.
|
|
Connect to the port of the RTIS Hardware.
|
... | @@ -445,7 +451,7 @@ Connect to the port of the RTIS Hardware. |
... | @@ -445,7 +451,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#L1994">[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#L2045">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Manually close the connection to the RTIS device.
|
|
Manually close the connection to the RTIS device.
|
... | @@ -471,7 +477,7 @@ be closed gracefully. |
... | @@ -471,7 +477,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='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2023">[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#L2074">[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.
|
... | @@ -604,7 +610,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv") |
... | @@ -604,7 +610,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: 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#L2205">[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#L2256">[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.
|
... | @@ -767,7 +773,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder") |
... | @@ -767,7 +773,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder") |
|
## **get_current_settings**
|
|
## **get_current_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>get_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2418">[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#L2469">[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.
|
... | @@ -791,7 +797,7 @@ Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisde |
... | @@ -791,7 +797,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#L2435">[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#L2486">[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.
|
... | @@ -808,7 +814,7 @@ Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-s |
... | @@ -808,7 +814,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#L2444">[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#L2495">[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
|
... | @@ -938,7 +944,7 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
... | @@ -938,7 +944,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2645">[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#L2696">[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
|
... | @@ -970,7 +976,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev |
... | @@ -970,7 +976,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#L2674">[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#L2725">[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.
|
... | @@ -994,7 +1000,7 @@ Get a list of names of all the available premade settings for processing. |
... | @@ -994,7 +1000,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#L2689">[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#L2740">[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.
|
... | @@ -1018,7 +1024,7 @@ Get a list of names of all the available premade settings for recording. |
... | @@ -1018,7 +1024,7 @@ Get a list of names of all the available premade settings for recording. |
|
## **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#L2703">[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#L2754">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
... | @@ -1045,7 +1051,7 @@ Furthermore, if using the default settings for processing this is enabled alread |
... | @@ -1045,7 +1051,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#L2730">[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#L2781">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Stop all CUDA workers.
|
|
Stop all CUDA workers.
|
... | @@ -1071,7 +1077,7 @@ stopped when your script ends. |
... | @@ -1071,7 +1077,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#L2745">[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#L2796">[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.
|
... | @@ -1111,7 +1117,7 @@ measurement = rtisdev.get_raw_measurement(True) |
... | @@ -1111,7 +1117,7 @@ measurement = rtisdev.get_raw_measurement(True) |
|
## **get_signal_measurement**
|
|
## **get_signal_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2778">[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#L2829">[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
|
... | @@ -1154,7 +1160,7 @@ signal_measurement = rtisdev.get_signal_measurement(True) |
... | @@ -1154,7 +1160,7 @@ signal_measurement = rtisdev.get_signal_measurement(True) |
|
## **get_processed_measurement**
|
|
## **get_processed_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>get_processed_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2818">[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#L2869">[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
|
... | @@ -1195,7 +1201,7 @@ processed_measurement = rtisdev.get_processed_measurement(True) |
... | @@ -1195,7 +1201,7 @@ processed_measurement = rtisdev.get_processed_measurement(True) |
|
## **process_measurement**
|
|
## **process_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>process_measurement</b>(<i>measurement: RTISMeasurement</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2857">[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#L2908">[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
|
... | @@ -1238,7 +1244,7 @@ processed_measurement = rtisdev.process_measurement(measurement) |
... | @@ -1238,7 +1244,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: int=0</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2896">[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#L2947">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the internal measurement counter of the sonar hardware.
|
|
Set the internal measurement counter of the sonar hardware.
|
... | @@ -1269,7 +1275,7 @@ Set the internal measurement counter of the sonar hardware. |
... | @@ -1269,7 +1275,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#L2919">[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#L2970">[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
|
... | @@ -1303,7 +1309,7 @@ argument to define the sonar behaviour. |
... | @@ -1303,7 +1309,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#L2944">[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#L2995">[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.
|
... | @@ -1327,7 +1333,7 @@ Get the firmware version of the internal RTIS firmware used on the device. |
... | @@ -1327,7 +1333,7 @@ Get the firmware version of the internal RTIS firmware used on the device. |
|
## **create_measure_external_trigger_queue**
|
|
## **create_measure_external_trigger_queue**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2959">[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#L3010">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Thread that will be waiting for an external trigger to measure from
|
|
This will create and return a Thread that will be waiting for an external trigger to measure from
|
... | @@ -1372,7 +1378,7 @@ measure_thread.join() |
... | @@ -1372,7 +1378,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: Callable[[ RTISMeasurement], any]</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2997">[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#L3048">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Thread that will be waiting for an external trigger to measure from
|
|
This will create and return a Thread that will be waiting for an external trigger to measure from
|
... | @@ -1423,7 +1429,7 @@ measure_thread.join() |
... | @@ -1423,7 +1429,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: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3044">[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#L3095">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Enable/disable the high voltage amplifier's step up controller.
|
|
Enable/disable the high voltage amplifier's step up controller.
|
... | @@ -1455,7 +1461,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav |
... | @@ -1455,7 +1461,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: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3067">[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#L3118">[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.
|
... | @@ -1487,7 +1493,7 @@ They are disabled by default so have to be manually enabled. |
... | @@ -1487,7 +1493,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#L3090">[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#L3141">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
The function to reset the RTIS device hardware.
|
|
The function to reset the RTIS device hardware.
|
... | @@ -1518,7 +1524,7 @@ The function to reset the RTIS device hardware. |
... | @@ -1518,7 +1524,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#L3138">[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#L3189">[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.
|
... | @@ -1542,7 +1548,7 @@ The function to set the logging level of the RTIS Dev module. |
... | @@ -1542,7 +1548,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#L3168">[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#L3219">[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.
|
... | | ... | |