Skip to content

GitLab

Home · Changes

Page history
Update home authored by Wouter Jansen's avatar Wouter Jansen
Hide whitespace changes
Inline Side-by-side
home.md
View page @ 06f0a9c7
......@@ -179,6 +179,11 @@ Can be converted to a dictionary.
</table>
#### Methods
## **MeasureExternalTriggerQueueThread**
<p class="func-header">
......@@ -817,13 +822,126 @@ Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-s
<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#L2427">[source]</a>
</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
given arguments. It will not set these settings to the RTIS Device or activate processing. It only creates
the settings object. For examples of what some of these settings do and how to use them, please see
the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#set_recording_settings) and [`set_processing_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#set_processing_settings) examples.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>recordingPremade : <i>String (default = Not used)</i></b>
<p class="attr">
When using get_premade_recording_settings() you can get a set of premade configurations with a unique identifier as name. To use one of those use that identifier name with this argument.
</p>
<b>recordingJsonPath : <i>String (default = Not used)</i></b>
<p class="attr">
One can also store the recording settings in a json file. To load the recording settings from a json file, please use the absolute path to this json file with this argument.
</p>
<b>recordingCallCustom : <i>String (default = Not used)</i></b>
<p class="attr">
One can use a custom call pulse to emmit from the RTIS Device in active mode. To load the custom pulse, use the absolute path to the csv file with this argument.
</p>
<b>processingPremade : <i>String (default = Not used)</i></b>
<p class="attr">
When using get_premade_processing_settings() you can get a set of premade configurations with a unique identifier as name. To use one of those use that identifier name with this argument.
</p>
<b>processingJsonPath : <i>String (default = Not used)</i></b>
<p class="attr">
One can also store the processing settings in a json file. To load the processing settings from a json file, please use the absolute path to this json file with this argument.
</p>
<b>processingCustomPath : <i>String (default = Not used)</i></b>
<p class="attr">
One can use a custom set of processing files (delaymatrix.csv, directions.csv and ranges.csv). To load the custom files use the absolute path to the folder where these csvs are located.
</p>
<b>microphoneSamples : <i>int (default = 163840)</i></b>
<p class="attr">
The amount of microphone samples. Must be dividable by 32768.
</p>
<b>microphoneSampleFrequency : <i>int (default = 4500000)</i></b>
<p class="attr">
The microphone sample frequency (without subsampling of PDM). The frequency must be 4.5 MHz(ultrasound) or 1.125 MHz(audible) depending on the wanted mode.
</p>
<b>callSampleFrequency : <i>int (default = 450000)</i></b>
<p class="attr">
The chosen sample frequency of the call. Must by larger then 160 KHz and smaller then 2 MHz.
</p>
<b>callDuration : <i>float (default = 2.5)</i></b>
<p class="attr">
The duration in miliseconds of the call.
</p>
<b>callMinimumFrequency : <i>int (default = 25000)</i></b>
<p class="attr">
The minimum frequency in Hz of the call sweep used for generating the pulse.
</p>
<b>callMaximumFrequency : <i>int (default = 50000)</i></b>
<p class="attr">
The maximum frequency in Hz of the call sweep used for generating the pulse.
</p>
<b>callEmissions : <i>int (default = 1)</i></b>
<p class="attr">
The amount of times the pulse should be emitted during one measurement.
</p>
<b>microphoneLayout : <i>String (default = eRTIS_v3D1)</i></b>
<p class="attr">
Identifier of the microphone layout used for this configuration.
</p>
<b>mode : <i>int (default = 1)</i></b>
<p class="attr">
Defines if using 3D or 2D processing. If set to 1 a 2D horizontal plane layout will be generated. When set to 0 a 3D equal distance layout will be generated for the frontal hemisphere of the sensor.
</p>
<b>directions : <i>int (default = 181)</i></b>
<p class="attr">
Defines how many directions the layout should generate.
</p>
<b>minRange : <i>float (default = 0.5)</i></b>
<p class="attr">
The minimum distance in meters of the energyscape to generate.
</p>
<b>maxRange : <i>float (default = 5)</i></b>
<p class="attr">
The maximum distance in meters of the energyscape to generate.
</p>
<b>pdmEnable : <i>bool (default = True)</i></b>
<p class="attr">
Toggle for PDM filtering part of the RTIS processing pipeline using RTIS CUDA.
</p>
<b>matchedFilterEnable : <i>bool (default = True)</i></b>
<p class="attr">
Toggle for matched filter part of the RTIS processing pipeline using RTIS CUDA.
</p>
<b>beamformingEnable : <i>bool (default = True)</i></b>
<p class="attr">
Toggle for beamforming part of the RTIS processing pipeline using RTIS CUDA.
</p>
<b>enveloppeEnable : <i>bool (default = True)</i></b>
<p class="attr">
Toggle for enveloppe part of the RTIS processing pipeline using RTIS CUDA.
</p>
<b>cleanEnable : <i>bool (default = True)</i></b>
<p class="attr">
Toggle for cleaning part of the RTIS processing pipeline using RTIS CUDA.
</p>
<b>preloadToggle : <i>bool (default = True)</i></b>
<p class="attr">
Toggle for using RTIS CUDA preloading
</p>
<b>configName : <i>String (default = "")</i></b>
<p class="attr">
String to identify these settings with. If set to empty (as it is by default), it will become the name set for recordingPremade. If no premade recording settings are used it will default to <em>RTISSettings</em>.
</p></td>
</tr>
<tr class="field">
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>settings : <i>RTISSettings</i></b>
<p class="attr">
The complete class containing all RTIS settings for recording and processing. Returns 'None' or will raise an exception on failure.
</p></td>
</tr>
</tbody>
</table>
......@@ -831,7 +949,7 @@ Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-s
## **set_settings_from_class**
<p class="func-header">
<i>def</i> <b>set_settings_from_class</b>(<i>settings: RTISSettings</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2629">[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#L2628">[source]</a>
</p>
Set the wanted settings from an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object. These can be created
......@@ -863,7 +981,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev
## **get_premade_processing_settings_list**
<p class="func-header">
<i>def</i> <b>get_premade_processing_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2658">[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#L2657">[source]</a>
</p>
Get a list of names of all the available premade settings for processing.
......@@ -887,7 +1005,7 @@ Get a list of names of all the available premade settings for processing.
## **get_premade_recording_settings_list**
<p class="func-header">
<i>def</i> <b>get_premade_recording_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2673">[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#L2672">[source]</a>
</p>
Get a list of names of all the available premade settings for recording.
......@@ -911,7 +1029,7 @@ Get a list of names of all the available premade settings for recording.
## **prepare_processing**
<p class="func-header">
<i>def</i> <b>prepare_processing</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2687">[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#L2686">[source]</a>
</p>
Start the CUDA workers for looped measurements with processing enabled.
......@@ -938,7 +1056,7 @@ Furthermore, if using the default settings for processing this is enabled alread
## **unload_processing**
<p class="func-header">
<i>def</i> <b>unload_processing</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2714">[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#L2713">[source]</a>
</p>
Stop all CUDA workers.
......@@ -964,7 +1082,7 @@ stopped when your script ends.
## **get_raw_measurement**
<p class="func-header">
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2729">[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#L2728">[source]</a>
</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.
......@@ -1004,7 +1122,7 @@ measurement = rtisdev.get_raw_measurement(True)
## **get_signal_measurement**
<p class="func-header">
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2762">[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#L2761">[source]</a>
</p>
Start an RTIS sonar measurement and process it with only PDM filtering
......@@ -1047,7 +1165,7 @@ signal_measurement = rtisdev.get_signal_measurement(True)
## **get_processed_measurement**
<p class="func-header">
<i>def</i> <b>get_processed_measurement</b>(<i>behaviour: bool=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2802">[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#L2801">[source]</a>
</p>
Start an RTIS sonar measurement and process it and return the raw and processed data
......@@ -1088,7 +1206,7 @@ processed_measurement = rtisdev.get_processed_measurement(True)
## **process_measurement**
<p class="func-header">
<i>def</i> <b>process_measurement</b>(<i>measurement: RTISMeasurement</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2841">[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#L2840">[source]</a>
</p>
Process a previously recorded raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) object
......@@ -1131,7 +1249,7 @@ processed_measurement = rtisdev.process_measurement(measurement)
## **set_counter**
<p class="func-header">
<i>def</i> <b>set_counter</b>(<i>newCount: int=0</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2880">[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#L2879">[source]</a>
</p>
Set the internal measurement counter of the sonar hardware.
......@@ -1162,7 +1280,7 @@ Set the internal measurement counter of the sonar hardware.
## **set_behaviour**
<p class="func-header">
<i>def</i> <b>set_behaviour</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2903">[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#L2902">[source]</a>
</p>
Set the behaviour of the sonar hardware to passive or active. This is only necessary if using external
......@@ -1196,7 +1314,7 @@ argument to define the sonar behaviour.
## **get_firmware_version**
<p class="func-header">
<i>def</i> <b>get_firmware_version</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2928">[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#L2927">[source]</a>
</p>
Get the firmware version of the internal RTIS firmware used on the device.
......@@ -1220,7 +1338,7 @@ Get the firmware version of the internal RTIS firmware used on the device.
## **create_measure_external_trigger_queue**
<p class="func-header">
<i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2943">[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#L2942">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1265,7 +1383,7 @@ measure_thread.join()
## **create_measure_external_trigger_callback**
<p class="func-header">
<i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback: Callable[[ RTISMeasurement], any]</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2981">[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#L2980">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1316,7 +1434,7 @@ measure_thread.join()
## **toggle_amplifier**
<p class="func-header">
<i>def</i> <b>toggle_amplifier</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3028">[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#L3027">[source]</a>
</p>
Enable/disable the high voltage amplifier's step up controller.
......@@ -1348,7 +1466,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav
## **toggle_external_triggers**
<p class="func-header">
<i>def</i> <b>toggle_external_triggers</b>(<i>mode: bool</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3051">[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#L3050">[source]</a>
</p>
Enable/disable external triggers being able to start a measurement on the RTIS device.
......@@ -1380,7 +1498,7 @@ They are enabled by default so have to be manually disabled.
## **reset_device**
<p class="func-header">
<i>def</i> <b>reset_device</b>(<i>stm32pin: int=7</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3074">[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#L3073">[source]</a>
</p>
The function to reset the RTIS device hardware.
......@@ -1411,7 +1529,7 @@ The function to reset the RTIS device hardware.
## **set_log_mode**
<p class="func-header">
<i>def</i> <b>set_log_mode</b>(<i>mode: int</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3122">[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#L3121">[source]</a>
</p>
The function to set the logging level of the RTIS Dev module.
......@@ -1435,7 +1553,7 @@ The function to set the logging level of the RTIS Dev module.
## **set_custom_logger**
<p class="func-header">
<i>def</i> <b>set_custom_logger</b>(<i>customLogger: logging.Logger</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3152">[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#L3151">[source]</a>
</p>
The function to set a custom logger to be used by RTIS Dev.
......