... | @@ -195,7 +195,6 @@ Class storing all data and information on an RTIS device measurement. |
... | @@ -195,7 +195,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">
|
... | @@ -235,7 +234,6 @@ Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwe |
... | @@ -235,7 +234,6 @@ Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwe |
|
</table>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## **MeasureExternalTriggerCallbackThread**
|
|
## **MeasureExternalTriggerCallbackThread**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
... | @@ -257,12 +255,14 @@ Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit |
... | @@ -257,12 +255,14 @@ Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit |
|
|
|
|
|
</table>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# **Methods**
|
|
# **Methods**
|
|
|
|
|
|
## **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#L2538">[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#L2537">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Connect to the port of the RTIS Hardware.
|
|
Connect to the port of the RTIS Hardware.
|
... | @@ -297,7 +297,7 @@ Connect to the port of the RTIS Hardware. |
... | @@ -297,7 +297,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#L2642">[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#L2641">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Manually close the connection to the RTIS device.
|
|
Manually close the connection to the RTIS device.
|
... | @@ -323,7 +323,7 @@ be closed gracefully. This will also unload all RTIS CUDA workers. |
... | @@ -323,7 +323,7 @@ be closed gracefully. This will also unload all RTIS CUDA workers. |
|
## **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#L2675">[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#L2673">[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.
|
... | @@ -460,7 +460,7 @@ config_uuid = rtisdev.set_recording_settings(callCustom="mycall.csv") |
... | @@ -460,7 +460,7 @@ config_uuid = rtisdev.set_recording_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>configName: str, 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, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True, postFilter=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2849">[source]</a>
|
|
<i>def</i> <b>set_processing_settings</b>(<i>configName: str, 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, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True, postFilter: np.ndarray=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2847">[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.
|
... | @@ -637,7 +637,7 @@ rtisdev.set_processing_settings(postFilter=pf, postFilterEnable=True, configName |
... | @@ -637,7 +637,7 @@ rtisdev.set_processing_settings(postFilter=pf, postFilterEnable=True, configName |
|
## **get_current_settings_config_name_list**
|
|
## **get_current_settings_config_name_list**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>get_current_settings_config_name_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3085">[source]</a>
|
|
<i>def</i> <b>get_current_settings_config_name_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3083">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Get a list of names of all the currently loaded configurations.
|
|
Get a list of names of all the currently loaded configurations.
|
... | @@ -661,7 +661,7 @@ Get a list of names of all the currently loaded configurations. |
... | @@ -661,7 +661,7 @@ Get a list of names of all the currently loaded configurations. |
|
## **get_current_settings**
|
|
## **get_current_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>get_current_settings</b>(<i>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3097">[source]</a>
|
|
<i>def</i> <b>get_current_settings</b>(<i>configName: str=''</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>
|
|
|
|
|
|
Returns all(dict) or a single [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current settings for processing and recording.
|
|
Returns all(dict) or a single [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current settings for processing and recording.
|
... | @@ -716,7 +716,7 @@ Clear all or the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be |
... | @@ -716,7 +716,7 @@ Clear all or the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be |
|
## **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, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool=True, postFilter=None, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3149">[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, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool=True, postFilter: np.ndarray=None, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3152">[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
|
... | @@ -854,7 +854,7 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
... | @@ -854,7 +854,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#L3359">[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#L3362">[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
|
... | @@ -890,7 +890,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev |
... | @@ -890,7 +890,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#L3395">[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#L3398">[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.
|
... | @@ -914,7 +914,7 @@ Get a list of names of all the available premade settings for processing. |
... | @@ -914,7 +914,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#L3410">[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#L3413">[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.
|
... | @@ -938,7 +938,7 @@ Get a list of names of all the available premade settings for recording. |
... | @@ -938,7 +938,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#L3425">[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#L3428">[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.
|
... | @@ -962,7 +962,7 @@ Get a list of names of all the available microphone layouts that are available f |
... | @@ -962,7 +962,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>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3439">[source]</a>
|
|
<i>def</i> <b>prepare_processing</b>(<i>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3442">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
... | @@ -998,7 +998,7 @@ will prepare that one. |
... | @@ -998,7 +998,7 @@ will prepare that one. |
|
## **unload_processing**
|
|
## **unload_processing**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>unload_processing</b>(<i>configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3482">[source]</a>
|
|
<i>def</i> <b>unload_processing</b>(<i>configName: str=''</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>
|
|
|
|
|
|
Stop all CUDA workers of all workers or of one specified if the configuration name is provided.
|
|
Stop all CUDA workers of all workers or of one specified if the configuration name is provided.
|
... | @@ -1031,7 +1031,7 @@ stopped when your script ends. |
... | @@ -1031,7 +1031,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, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3506">[source]</a>
|
|
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3509">[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.
|
... | @@ -1043,7 +1043,7 @@ This means that it will only record and not perform any processing. |
... | @@ -1043,7 +1043,7 @@ This means that it will only record and not perform any processing. |
|
<tbody valign="top">
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<tr class="field">
|
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<td class="field-body" width="100%"><b>behaviour : <i>bool</i></b>
|
|
<td class="field-body" width="100%"><b>behaviour : <i>bool (default = False)</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
A configuration toggle to set the required sonar behaviour (active or passive).
|
|
A configuration toggle to set the required sonar behaviour (active or passive).
|
|
</p>
|
|
</p>
|
... | @@ -1076,7 +1076,7 @@ measurement = rtisdev.get_raw_measurement(True) |
... | @@ -1076,7 +1076,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, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3546">[source]</a>
|
|
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3549">[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
|
... | @@ -1090,7 +1090,7 @@ have set. But will still use the other chosen recording and processing settings. |
... | @@ -1090,7 +1090,7 @@ have set. But will still use the other chosen recording and processing settings. |
|
<tbody valign="top">
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<tr class="field">
|
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<td class="field-body" width="100%"><b>behaviour : <i>bool</i></b>
|
|
<td class="field-body" width="100%"><b>behaviour : <i>bool (default = False)</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
A configuration toggle to set the required sonar behaviour (active or passive).
|
|
A configuration toggle to set the required sonar behaviour (active or passive).
|
|
</p>
|
|
</p>
|
... | @@ -1124,7 +1124,7 @@ signal_measurement = rtisdev.get_signal_measurement(True) |
... | @@ -1124,7 +1124,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, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3592">[source]</a>
|
|
<i>def</i> <b>get_processed_measurement</b>(<i>behaviour: bool=False, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3595">[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
|
... | @@ -1136,7 +1136,7 @@ in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/- |
... | @@ -1136,7 +1136,7 @@ in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/- |
|
<tbody valign="top">
|
|
<tbody valign="top">
|
|
<tr class="field">
|
|
<tr class="field">
|
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<td class="field-body" width="100%"><b>behaviour : <i>bool</i></b>
|
|
<td class="field-body" width="100%"><b>behaviour : <i>bool (default = False)</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
A configuration toggle to set the required sonar behaviour (active or passive).
|
|
A configuration toggle to set the required sonar behaviour (active or passive).
|
|
</p>
|
|
</p>
|
... | @@ -1171,7 +1171,7 @@ processed_measurement = rtisdev.get_processed_measurement(True) |
... | @@ -1171,7 +1171,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, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3638">[source]</a>
|
|
<i>def</i> <b>process_measurement</b>(<i>measurement: RTISMeasurement, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3643">[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
|
... | @@ -1219,7 +1219,7 @@ processed_measurement = rtisdev.process_measurement(measurement) |
... | @@ -1219,7 +1219,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#L3684">[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#L3689">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the internal measurement counter of the sonar hardware.
|
|
Set the internal measurement counter of the sonar hardware.
|
... | @@ -1250,7 +1250,7 @@ Set the internal measurement counter of the sonar hardware. |
... | @@ -1250,7 +1250,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#L3707">[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#L3712">[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
|
... | @@ -1284,7 +1284,7 @@ argument to define the sonar behaviour. |
... | @@ -1284,7 +1284,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#L3732">[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#L3737">[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.
|
... | @@ -1308,7 +1308,7 @@ Get the firmware version of the internal RTIS firmware used on the device. |
... | @@ -1308,7 +1308,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, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3747">[source]</a>
|
|
<i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue: Queue, configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3752">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Process
|
|
This will create and return a Multiprocessing Process
|
... | @@ -1361,7 +1361,7 @@ measure_thread.join() |
... | @@ -1361,7 +1361,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], configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3822">[source]</a>
|
|
<i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback: Callable[[ RTISMeasurement], any], configName: str='' </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3827">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Process
|
|
This will create and return a Multiprocessing Process
|
... | @@ -1420,7 +1420,7 @@ measure_thread.join() |
... | @@ -1420,7 +1420,7 @@ measure_thread.join() |
|
## **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, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3906">[source]</a>
|
|
<i>def</i> <b>create_processing_workers</b>(<i>workerCount: int, inputQueue: Queue, outputQueue: Queue, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3911">[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
|
... | @@ -1491,7 +1491,7 @@ workersPool.terminate() |
... | @@ -1491,7 +1491,7 @@ workersPool.terminate() |
|
## **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#L3980">[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#L3985">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Enable/disable the high voltage amplifier's step up controller.
|
|
Enable/disable the high voltage amplifier's step up controller.
|
... | @@ -1524,7 +1524,7 @@ This will save on power usage and heat production. |
... | @@ -1524,7 +1524,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#L4002">[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#L4007">[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.
|
... | @@ -1556,7 +1556,7 @@ They are disabled by default so have to be manually enabled. |
... | @@ -1556,7 +1556,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#L4023">[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#L4028">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
The function to reset the RTIS device hardware.
|
|
The function to reset the RTIS device hardware.
|
... | @@ -1587,7 +1587,7 @@ The function to reset the RTIS device hardware. |
... | @@ -1587,7 +1587,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#L4069">[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#L4074">[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.
|
... | @@ -1611,7 +1611,7 @@ The function to set the logging level of the RTIS Dev module. |
... | @@ -1611,7 +1611,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#L4097">[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#L4102">[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.
|
... | @@ -1628,4 +1628,5 @@ The function to set a custom logger to be used by RTIS Dev. |
... | @@ -1628,4 +1628,5 @@ The function to set a custom logger to be used by RTIS Dev. |
|
</p></td>
|
|
</p></td>
|
|
</tr>
|
|
</tr>
|
|
</tbody>
|
|
</tbody>
|
|
</table> |
|
</table>
|
|
\ No newline at end of file |
|
|