... | @@ -61,7 +61,7 @@ config_uuid = rtisdev.set_recording_settings(microphoneSamples=163840, callMinim |
... | @@ -61,7 +61,7 @@ config_uuid = rtisdev.set_recording_settings(microphoneSamples=163840, callMinim |
|
```
|
|
```
|
|
|
|
|
|
Enable all processing steps and preload them with RTIS CUDA. This will produce a 2D energyscape with 91 directions
|
|
Enable all processing steps and preload them with RTIS CUDA. This will produce a 2D energyscape with 91 directions
|
|
with a maximum distance of 5m:
|
|
with a maximum distance of 6m:
|
|
|
|
|
|
```python
|
|
```python
|
|
success_settings_processing = rtisdev.set_processing_settings(directions=91, maxRange=5, configName=config_uuid)
|
|
success_settings_processing = rtisdev.set_processing_settings(directions=91, maxRange=5, configName=config_uuid)
|
... | @@ -195,8 +195,6 @@ Class storing all data and information on an RTIS device measurement. |
... | @@ -195,8 +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">
|
... | @@ -214,7 +212,6 @@ Can be converted to a dictionary. |
... | @@ -214,7 +212,6 @@ Can be converted to a dictionary. |
|
|
|
|
|
</table>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
## **MeasureExternalTriggerQueueThread**
|
|
## **MeasureExternalTriggerQueueThread**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
... | @@ -237,7 +234,6 @@ Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwe |
... | @@ -237,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">
|
... | @@ -259,14 +255,12 @@ Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit |
... | @@ -259,14 +255,12 @@ 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: str='/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#L2907">[source]</a>
|
|
<i>def</i> <b>open_connection</b>(<i>port: str='/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#L2921">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Connect to the port of the RTIS Hardware.
|
|
Connect to the port of the RTIS Hardware.
|
... | @@ -301,7 +295,7 @@ Connect to the port of the RTIS Hardware. |
... | @@ -301,7 +295,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#L3011">[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#L3025">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Manually close the connection to the RTIS device.
|
|
Manually close the connection to the RTIS device.
|
... | @@ -327,7 +321,7 @@ be closed gracefully. This will also unload all RTIS CUDA workers. |
... | @@ -327,7 +321,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#L3046">[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#L3060">[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.
|
... | @@ -467,7 +461,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
... | @@ -467,7 +461,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
|
## **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, azimuthLowLimit: float=-90, azimuthHighLimit: float=90, elevationLowLimit: float=-90, elevationHighLimit: float=90, minRange: float=0.5, maxRange: float=5, pdmEnable: bool=True, preFilterEnable: bool=False, matchedFilterEnable: bool=True, beamformingEnable: bool=True, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True, preFilter: np.ndarray=None, postFilter: np.ndarray=None, meanEnergyRangeMultiplier: float=2, maxEnergyRangeThresholdMultiplier: float=0.5</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3225">[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, azimuthLowLimit: float=-90, azimuthHighLimit: float=90, elevationLowLimit: float=-90, elevationHighLimit: float=90, elevation2DAngle: float=0, minRange: float=0.5, maxRange: float=5, pdmEnable: bool=True, preFilterEnable: bool=False, matchedFilterEnable: bool=True, beamformingEnable: bool= True, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool=True, preFilter: np.ndarray =None, postFilter: np.ndarray=None, meanEnergyRangeMultiplier: float=2, maxEnergyRangeThresholdMultiplier: float=0.5</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3239">[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.
|
... | @@ -523,6 +517,10 @@ Please read their decription carefully. |
... | @@ -523,6 +517,10 @@ Please read their decription carefully. |
|
<p class="attr">
|
|
<p class="attr">
|
|
The higher limit of the elevation in degrees of the directions to generate. Has to be between -90 and 90.
|
|
The higher limit of the elevation in degrees of the directions to generate. Has to be between -90 and 90.
|
|
</p>
|
|
</p>
|
|
|
|
<b>elevation2DAngle : <i>float (default = 0)</i></b>
|
|
|
|
<p class="attr">
|
|
|
|
The angle in degrees of the elevation in the 2D mode generation. Has to be between -90 and 90.
|
|
|
|
</p>
|
|
<b>minRange : <i>float (default = 0.5)</i></b>
|
|
<b>minRange : <i>float (default = 0.5)</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
The minimum distance in meters of the energyscape to generate.
|
|
The minimum distance in meters of the energyscape to generate.
|
... | @@ -692,7 +690,7 @@ rtisdev.set_processing_settings(postFilter=postf, postFilterEnable=True, configN |
... | @@ -692,7 +690,7 @@ rtisdev.set_processing_settings(postFilter=postf, postFilterEnable=True, configN |
|
## **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#L3516">[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#L3534">[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.
|
... | @@ -716,7 +714,7 @@ Get a list of names of all the currently loaded configurations. |
... | @@ -716,7 +714,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#L3528">[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#L3546">[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.
|
... | @@ -747,7 +745,7 @@ Returns all(dict) or a single [`RTISSettings`](https://cosysgit.uantwerpen.be/rt |
... | @@ -747,7 +745,7 @@ Returns all(dict) or a single [`RTISSettings`](https://cosysgit.uantwerpen.be/rt |
|
## **clear_current_settings**
|
|
## **clear_current_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>clear_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#L3563">[source]</a>
|
|
<i>def</i> <b>clear_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#L3581">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Clear all or the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) configuration depending on setting the configName parameter.
|
|
Clear all or the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) configuration depending on setting the configName parameter.
|
... | @@ -771,7 +769,7 @@ Clear all or the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be |
... | @@ -771,7 +769,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, azimuthLowLimit: float=-90, azimuthHighLimit: float=90, elevationLowLimit: float=-90, elevationHighLimit: float=90, minRange: float=0.5, maxRange: float=5, pdmEnable: bool=True, preFilterEnable: bool=False, matchedFilterEnable: bool=True, beamformingEnable: bool=True, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True, preFilter: np.ndarray=None, postFilter: np.ndarray=None, meanEnergyRangeMultiplier: float=2, maxEnergyRangeThresholdMultiplier: float=0.5, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3591">[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, azimuthLowLimit: float=-90, azimuthHighLimit: float=90, elevationLowLimit: float=-90, elevationHighLimit: float=90, elevation2DAngle: float=0, minRange: float=0.5, maxRange: float=5, pdmEnable: bool=True, preFilterEnable: bool=False, matchedFilterEnable: bool=True, beamformingEnable: bool=True, postFilterEnable: bool=False, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True, preFilter: np.ndarray=None, postFilter: np.ndarray=None, meanEnergyRangeMultiplier: float=2, maxEnergyRangeThresholdMultiplier: float=0.5, configName: str=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3609">[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
|
... | @@ -865,6 +863,10 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
... | @@ -865,6 +863,10 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
|
<p class="attr">
|
|
<p class="attr">
|
|
The higher limit of the elevation in degrees of the directions to generate. Has to be between -90 and 90.
|
|
The higher limit of the elevation in degrees of the directions to generate. Has to be between -90 and 90.
|
|
</p>
|
|
</p>
|
|
|
|
<b>elevation2DAngle : <i>float (default = 0)</i></b>
|
|
|
|
<p class="attr">
|
|
|
|
The angle in degrees of the elevation in the 2D mode generation. Has to be between -90 and 90.
|
|
|
|
</p>
|
|
<b>minRange : <i>float (default = 0.5)</i></b>
|
|
<b>minRange : <i>float (default = 0.5)</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
The minimum distance in meters of the energyscape to generate.
|
|
The minimum distance in meters of the energyscape to generate.
|
... | @@ -941,7 +943,7 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
... | @@ -941,7 +943,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#L3837">[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#L3859">[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
|
... | @@ -977,7 +979,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev |
... | @@ -977,7 +979,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#L3877">[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#L3899">[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.
|
... | @@ -1001,7 +1003,7 @@ Get a list of names of all the available premade settings for processing. |
... | @@ -1001,7 +1003,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#L3892">[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#L3914">[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.
|
... | @@ -1025,7 +1027,7 @@ Get a list of names of all the available premade settings for recording. |
... | @@ -1025,7 +1027,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#L3907">[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#L3929">[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.
|
... | @@ -1049,7 +1051,7 @@ Get a list of names of all the available microphone layouts that are available f |
... | @@ -1049,7 +1051,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#L3921">[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#L3943">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
... | @@ -1085,7 +1087,7 @@ will prepare that one. |
... | @@ -1085,7 +1087,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#L3964">[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#L3986">[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.
|
... | @@ -1118,7 +1120,7 @@ stopped when your script ends. |
... | @@ -1118,7 +1120,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#L3988">[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#L4010">[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.
|
... | @@ -1166,7 +1168,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
... | @@ -1166,7 +1168,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
|
## **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#L4031">[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#L4053">[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
|
... | @@ -1216,7 +1218,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
... | @@ -1216,7 +1218,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
|
## **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#L4076">[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#L4098">[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
|
... | @@ -1266,7 +1268,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
... | @@ -1266,7 +1268,7 @@ load the settings as asked for by the configName argument to the RTIS device bef |
|
## **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#L4127">[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#L4149">[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
|
... | @@ -1314,7 +1316,7 @@ processed_measurement = rtisdev.process_measurement(measurement, configName=conf |
... | @@ -1314,7 +1316,7 @@ processed_measurement = rtisdev.process_measurement(measurement, configName=conf |
|
## **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#L4173">[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#L4195">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the internal measurement counter of the sonar hardware.
|
|
Set the internal measurement counter of the sonar hardware.
|
... | @@ -1345,7 +1347,7 @@ Set the internal measurement counter of the sonar hardware. |
... | @@ -1345,7 +1347,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#L4196">[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#L4218">[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
|
... | @@ -1379,7 +1381,7 @@ argument to define the sonar behaviour. |
... | @@ -1379,7 +1381,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#L4221">[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#L4243">[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.
|
... | @@ -1403,7 +1405,7 @@ Get the firmware version of the internal RTIS firmware used on the device. |
... | @@ -1403,7 +1405,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#L4236">[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#L4258">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Process
|
|
This will create and return a Multiprocessing Process
|
... | @@ -1456,7 +1458,7 @@ measure_thread.join() |
... | @@ -1456,7 +1458,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#L4311">[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#L4333">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Process
|
|
This will create and return a Multiprocessing Process
|
... | @@ -1515,7 +1517,7 @@ measure_thread.join() |
... | @@ -1515,7 +1517,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#L4395">[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#L4417">[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
|
... | @@ -1586,7 +1588,7 @@ workersPool.terminate() |
... | @@ -1586,7 +1588,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#L4470">[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#L4492">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Enable/disable the high voltage amplifier's step up controller.
|
|
Enable/disable the high voltage amplifier's step up controller.
|
... | @@ -1619,7 +1621,7 @@ This will save on power usage and heat production. |
... | @@ -1619,7 +1621,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, pin: int=1</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4492">[source]</a>
|
|
<i>def</i> <b>toggle_external_triggers</b>(<i>mode: bool, pin: int=1</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4514">[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.
|
... | @@ -1651,7 +1653,7 @@ They are disabled by default so have to be manually enabled. You can also set th |
... | @@ -1651,7 +1653,7 @@ They are disabled by default so have to be manually enabled. You can also set th |
|
## **custom_command**
|
|
## **custom_command**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>custom_command</b>(<i>command: str</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4515">[source]</a>
|
|
<i>def</i> <b>custom_command</b>(<i>command: str</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L4537">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Send a custom command to the RTIS device to execute over serial.
|
|
Send a custom command to the RTIS device to execute over serial.
|
... | @@ -1684,7 +1686,7 @@ comma-seperated command values. |
... | @@ -1684,7 +1686,7 @@ comma-seperated command values. |
|
## **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#L4536">[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#L4558">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
The function to reset the RTIS device hardware.
|
|
The function to reset the RTIS device hardware.
|
... | @@ -1715,7 +1717,7 @@ The function to reset the RTIS device hardware. |
... | @@ -1715,7 +1717,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#L4582">[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#L4604">[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.
|
... | @@ -1739,7 +1741,7 @@ The function to set the logging level of the RTIS Dev module. |
... | @@ -1739,7 +1741,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#L4610">[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#L4632">[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.
|
... | | ... | |