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 @ 56f1a477
......@@ -117,7 +117,6 @@ Can be converted to a dictionary.
</table>
## **MeasureExternalTriggerQueueThread**
<p class="func-header">
......@@ -394,7 +393,14 @@ The public function to manually close the connection to the RTIS device.
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>success : <i>bool</i></b>
<p class="attr">
returns <code>True</code> on successful completion, <code>False</code> on failure.
</p></td>
</tr>
</tbody>
</table>
......@@ -402,7 +408,7 @@ The public function to manually close the connection to the RTIS device.
## **set_recording_settings**
<p class="func-header">
<i>def</i> <b>set_recording_settings</b>(<i>premade=None, jsonPath=None, callCustom=None, microphoneSamples=163840, microphoneSampleFrequency=4500000, callSampleFrequency=450000, callDuration=2.5, callMinimumFrequency= 25000, callMaximumFrequency=50000, callEmissions=1</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1591">[source]</a>
<i>def</i> <b>set_recording_settings</b>(<i>premade=None, jsonPath=None, callCustom=None, microphoneSamples=163840, microphoneSampleFrequency=4500000, callSampleFrequency=450000, callDuration=2.5, callMinimumFrequency= 25000, callMaximumFrequency=50000, callEmissions=1</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1601">[source]</a>
</p>
The function to set the recording settings. All parameters are optional and most have default values.
......@@ -531,7 +537,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv")
## **set_processing_settings**
<p class="func-header">
<i>def</i> <b>set_processing_settings</b>(<i>premade=None, jsonPath=None, customPath=None, microphoneLayout='eRTIS_V3.14159265', mode=1, directions=181, minRange= 0.5, maxRange=5, microphoneSampleFrequency=4500000, pdmEnable=True, matchedFilterEnable=True, beamformingEnable=True, enveloppeEnable=True, cleanEnable=True, preloadToggle=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1751">[source]</a>
<i>def</i> <b>set_processing_settings</b>(<i>premade=None, jsonPath=None, customPath=None, microphoneLayout='eRTIS_V3.14159265', mode=1, directions=181, minRange= 0.5, maxRange=5, microphoneSampleFrequency=4500000, pdmEnable=True, matchedFilterEnable=True, beamformingEnable=True, enveloppeEnable=True, cleanEnable=True, preloadToggle=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1761">[source]</a>
</p>
The function to set the processing settings. All parameters are optional and most have default values.
......@@ -694,7 +700,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder")
## **get_current_settings**
<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/RTISDev2.py#L1948">[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/RTISDev2.py#L1958">[source]</a>
</p>
The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtissettings) object of the current DSP Settings.
......@@ -718,7 +724,7 @@ The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-so
## **set_settings_from_class**
<p class="func-header">
<i>def</i> <b>set_settings_from_class</b>(<i>settings</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1962">[source]</a>
<i>def</i> <b>set_settings_from_class</b>(<i>settings</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L1975">[source]</a>
</p>
The high level function to set the wanted DSP settings from an [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtissettings) object. These can be created
......@@ -750,7 +756,7 @@ with the get_custom_settings() or get_settings() functions.
## **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/RTISDev2.py#L1991">[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/RTISDev2.py#L2004">[source]</a>
</p>
The function to get a list of names of all the available premade settings for processing.
......@@ -774,7 +780,7 @@ The function to get a list of names of all the available premade settings for pr
## **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/RTISDev2.py#L2006">[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/RTISDev2.py#L2019">[source]</a>
</p>
The function to get a list of names of all the available premade settings for recording.
......@@ -798,7 +804,7 @@ The function to get a list of names of all the available premade settings for re
## **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/RTISDev2.py#L2020">[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/RTISDev2.py#L2033">[source]</a>
</p>
The high level function to start the CUDA workers for looped measurements. Not required for processing!
......@@ -823,7 +829,7 @@ But speeds up the workflow significantly if doing many measurements.
## **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/RTISDev2.py#L2048">[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/RTISDev2.py#L2063">[source]</a>
</p>
The high level function to stop the CUDA workers. Only required if actually using preloading of workers.
......@@ -847,7 +853,7 @@ The high level function to stop the CUDA workers. Only required if actually usin
## **get_raw_measurement**
<p class="func-header">
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2061">[source]</a>
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2076">[source]</a>
</p>
The high level function to start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object.
......@@ -886,7 +892,7 @@ measurement = rtisdev.get_raw_measurement(True)
## **get_signal_measurement**
<p class="func-header">
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2095">[source]</a>
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2110">[source]</a>
</p>
The high level function to start an RTIS sonar measurement and process it with only PDM filtering
......@@ -927,7 +933,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=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2138">[source]</a>
<i>def</i> <b>get_processed_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2153">[source]</a>
</p>
The high level function to start an RTIS sonar measurement and process it and return the raw and processed data
......@@ -968,7 +974,7 @@ processed_measurement = rtisdev.get_processed_measurement(True)
## **process_measurement**
<p class="func-header">
<i>def</i> <b>process_measurement</b>(<i>measurement</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2181">[source]</a>
<i>def</i> <b>process_measurement</b>(<i>measurement</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2196">[source]</a>
</p>
The high level function to process a raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object
......@@ -1011,7 +1017,7 @@ processed_measurement = rtisdev.process_measurement(measurement)
## **set_counter**
<p class="func-header">
<i>def</i> <b>set_counter</b>(<i>newCount=0</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2225">[source]</a>
<i>def</i> <b>set_counter</b>(<i>newCount=0</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2240">[source]</a>
</p>
High level function to set the internal measurement counter of the sonar hardware.
......@@ -1042,10 +1048,13 @@ High level function to set the internal measurement counter of the sonar hardwar
## **set_behaviour**
<p class="func-header">
<i>def</i> <b>set_behaviour</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2248">[source]</a>
<i>def</i> <b>set_behaviour</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2263">[source]</a>
</p>
Set the behaviour of the sonar hardware to passive or active
Set the behaviour of the sonar hardware to passive or active. This is only necessary if using external
measurement triggers. As using the normal RTIS Dev functions of [`get_raw_measurement(behaviour)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_raw_measurement),
[`get_signal_measurement(behaviour)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_signal_measurement) and [`get_processed_measurement(behaviour)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_processed_measurement) will use the given function
argument to define the sonar behaviour.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -1073,7 +1082,7 @@ Set the behaviour of the sonar hardware to passive or active
## **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/RTISDev2.py#L2270">[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/RTISDev2.py#L2288">[source]</a>
</p>
Get the firmware version of the internal RTIS firmware used on the device.
......@@ -1097,7 +1106,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/RTISDev2.py#L2284">[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/RTISDev2.py#L2302">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1142,7 +1151,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2322">[source]</a>
<i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2340">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1193,7 +1202,7 @@ measure_thread.join()
## **toggle_amplifier**
<p class="func-header">
<i>def</i> <b>toggle_amplifier</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2368">[source]</a>
<i>def</i> <b>toggle_amplifier</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2386">[source]</a>
</p>
Enable/disable the high voltage amplifier's step up controller.
......@@ -1225,7 +1234,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2391">[source]</a>
<i>def</i> <b>toggle_external_triggers</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2409">[source]</a>
</p>
Enable/disable external triggers being able to start a measurement on the RTIS device.
......@@ -1257,7 +1266,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=7</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2414">[source]</a>
<i>def</i> <b>reset_device</b>(<i>stm32pin=7</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2432">[source]</a>
</p>
The function to reset the RTIS device hardware.
......@@ -1288,7 +1297,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2462">[source]</a>
<i>def</i> <b>set_log_mode</b>(<i>mode</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2480">[source]</a>
</p>
The function to set the logging level of the RTIS Dev module.
......@@ -1312,7 +1321,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2492">[source]</a>
<i>def</i> <b>set_custom_logger</b>(<i>customLogger</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L2510">[source]</a>
</p>
The function to set a custom logger to be used by RTIS Dev.
......