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 @ 53ab7124
......@@ -33,7 +33,7 @@
## **RTISMeasurement**
<p class="func-header">
<i>class</i> <b>RTISMeasurement</b>(<i>id, timestamp, behaviour, index, rawData, processedData=None </i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L100"></a>
<i>class</i> <b>RTISMeasurement</b>(<i>id, timestamp, behaviour, index, rawData, processedData=None </i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L100">[source]</a>
</p>
Class storing all data and information on an RTIS device measurement.
......@@ -79,7 +79,7 @@ Class storing all data and information on an RTIS device measurement.
<p class="func-header">
<i></i> <b>update_processed_data</b>(<i>self, processedData</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L162"></a>
<i></i> <b>update_processed_data</b>(<i>self, processedData</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L162">[source]</a>
</p>
If only the processData needs to be updated, use this function.
......@@ -103,7 +103,7 @@ If only the processData needs to be updated, use this function.
## **RTISSettings**
<p class="func-header">
<i>class</i> <b>RTISSettings</b>(<i>firmwareVersion</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L175"></a>
<i>class</i> <b>RTISSettings</b>(<i>firmwareVersion</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L175">[source]</a>
</p>
Class describing all the processing and recording settings related to RTIS devices.
......@@ -117,10 +117,11 @@ Can be converted to a dictionary.
</table>
## **MeasureExternalTriggerQueueThread**
<p class="func-header">
<i>class</i> <b>MeasureExternalTriggerQueueThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L327"></a>
<i>class</i> <b>MeasureExternalTriggerQueueThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L327">[source]</a>
</p>
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
......@@ -158,7 +159,7 @@ measure_thread.join()
<p class="func-header">
<i></i> <b>set_queue</b>(<i>self, dataQueue</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L358"></a>
<i></i> <b>set_queue</b>(<i>self, dataQueue</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L358">[source]</a>
</p>
Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) objects on.
......@@ -182,7 +183,7 @@ Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasureme
<p class="func-header">
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L369"></a>
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L369">[source]</a>
</p>
Stop the measurement thread gracefully.
......@@ -199,7 +200,7 @@ Stop the measurement thread gracefully.
<p class="func-header">
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L376"></a>
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L376">[source]</a>
</p>
Get status of the thread if it should be stopped or not.
......@@ -216,7 +217,7 @@ Get status of the thread if it should be stopped or not.
<p class="func-header">
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L382"></a>
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L382">[source]</a>
</p>
Main thread function to run continuously. Should not be used. Use `start()` instead.
......@@ -233,7 +234,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst
## **MeasureExternalTriggerCallbackThread**
<p class="func-header">
<i>class</i> <b>MeasureExternalTriggerCallbackThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L428"></a>
<i>class</i> <b>MeasureExternalTriggerCallbackThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L428">[source]</a>
</p>
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
......@@ -277,7 +278,7 @@ measure_thread.join()
<p class="func-header">
<i></i> <b>set_callback</b>(<i>self, callback</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L465"></a>
<i></i> <b>set_callback</b>(<i>self, callback</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L465">[source]</a>
</p>
......@@ -301,7 +302,7 @@ measure_thread.join()
<p class="func-header">
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L476"></a>
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L476">[source]</a>
</p>
Stop the measurement thread gracefully.
......@@ -318,7 +319,7 @@ Stop the measurement thread gracefully.
<p class="func-header">
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L483"></a>
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L483">[source]</a>
</p>
Get status of the thread if it should be stopped or not.
......@@ -335,7 +336,7 @@ Get status of the thread if it should be stopped or not.
<p class="func-header">
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L489"></a>
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L489">[source]</a>
</p>
Main thread function to run continuously. Should not be used. Use `start()` instead.
......@@ -353,7 +354,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst
## **open_connection**
<p class="func-header">
<i>def</i> <b>open_connection</b>(<i>port='/dev/ttyACM0'</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1529"></a>
<i>def</i> <b>open_connection</b>(<i>port='/dev/ttyACM0'</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1529">[source]</a>
</p>
The function to connect to the port of the RTIS Hardware.
......@@ -384,7 +385,7 @@ The function to connect to the port of the RTIS Hardware.
## **close_connection**
<p class="func-header">
<i>def</i> <b>close_connection</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1575"></a>
<i>def</i> <b>close_connection</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1575">[source]</a>
</p>
The public function to manually close the connection to the RTIS device.
......@@ -401,7 +402,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="rtisdev/RTISDev.py#L1591"></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="rtisdev/RTISDev.py#L1591">[source]</a>
</p>
The function to set the recording settings. All parameters are optional and most have default values.
......@@ -530,7 +531,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="rtisdev/RTISDev.py#L1751"></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="rtisdev/RTISDev.py#L1751">[source]</a>
</p>
The function to set the processing settings. All parameters are optional and most have default values.
......@@ -693,7 +694,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="rtisdev/RTISDev.py#L1948"></a>
<i>def</i> <b>get_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1948">[source]</a>
</p>
The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtissettings) object of the current DSP Settings.
......@@ -717,7 +718,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="rtisdev/RTISDev.py#L1962"></a>
<i>def</i> <b>set_settings_from_class</b>(<i>settings</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1962">[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
......@@ -749,7 +750,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="rtisdev/RTISDev.py#L1991"></a>
<i>def</i> <b>get_premade_processing_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L1991">[source]</a>
</p>
The function to get a list of names of all the available premade settings for processing.
......@@ -773,7 +774,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="rtisdev/RTISDev.py#L2006"></a>
<i>def</i> <b>get_premade_recording_settings_list</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2006">[source]</a>
</p>
The function to get a list of names of all the available premade settings for recording.
......@@ -797,7 +798,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="rtisdev/RTISDev.py#L2020"></a>
<i>def</i> <b>prepare_processing</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2020">[source]</a>
</p>
The high level function to start the CUDA workers for looped measurements. Not required for processing!
......@@ -822,7 +823,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="rtisdev/RTISDev.py#L2048"></a>
<i>def</i> <b>unload_processing</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2048">[source]</a>
</p>
The high level function to stop the CUDA workers. Only required if actually using preloading of workers.
......@@ -846,7 +847,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="rtisdev/RTISDev.py#L2061"></a>
<i>def</i> <b>get_raw_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2061">[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.
......@@ -885,7 +886,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="rtisdev/RTISDev.py#L2095"></a>
<i>def</i> <b>get_signal_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2095">[source]</a>
</p>
The high level function to start an RTIS sonar measurement and process it with only PDM filtering
......@@ -926,7 +927,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="rtisdev/RTISDev.py#L2138"></a>
<i>def</i> <b>get_processed_measurement</b>(<i>behaviour=False</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2138">[source]</a>
</p>
The high level function to start an RTIS sonar measurement and process it and return the raw and processed data
......@@ -967,7 +968,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="rtisdev/RTISDev.py#L2181"></a>
<i>def</i> <b>process_measurement</b>(<i>measurement</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2181">[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
......@@ -1010,7 +1011,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="rtisdev/RTISDev.py#L2225"></a>
<i>def</i> <b>set_counter</b>(<i>newCount=0</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2225">[source]</a>
</p>
High level function to set the internal measurement counter of the sonar hardware.
......@@ -1041,7 +1042,7 @@ 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="rtisdev/RTISDev.py#L2248"></a>
<i>def</i> <b>set_behaviour</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2248">[source]</a>
</p>
Set the behaviour of the sonar hardware to passive or active
......@@ -1072,7 +1073,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="rtisdev/RTISDev.py#L2270"></a>
<i>def</i> <b>get_firmware_version</b>(<i></i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2270">[source]</a>
</p>
Get the firmware version of the internal RTIS firmware used on the device.
......@@ -1096,7 +1097,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="rtisdev/RTISDev.py#L2284"></a>
<i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2284">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1141,7 +1142,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="rtisdev/RTISDev.py#L2322"></a>
<i>def</i> <b>create_measure_external_trigger_callback</b>(<i>callback</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2322">[source]</a>
</p>
This will create and return a Thread that will be waiting for an external trigger to measure from
......@@ -1192,7 +1193,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="rtisdev/RTISDev.py#L2368"></a>
<i>def</i> <b>toggle_amplifier</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2368">[source]</a>
</p>
Enable/disable the high voltage amplifier's step up controller.
......@@ -1224,7 +1225,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="rtisdev/RTISDev.py#L2391"></a>
<i>def</i> <b>toggle_external_triggers</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2391">[source]</a>
</p>
Enable/disable external triggers being able to start a measurement on the RTIS device.
......@@ -1256,7 +1257,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="rtisdev/RTISDev.py#L2414"></a>
<i>def</i> <b>reset_device</b>(<i>stm32pin=7</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2414">[source]</a>
</p>
The function to reset the RTIS device hardware.
......@@ -1287,7 +1288,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="rtisdev/RTISDev.py#L2462"></a>
<i>def</i> <b>set_log_mode</b>(<i>mode</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2462">[source]</a>
</p>
The function to set the logging level of the RTIS Dev module.
......@@ -1311,7 +1312,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="rtisdev/RTISDev.py#L2492"></a>
<i>def</i> <b>set_custom_logger</b>(<i>customLogger</i>) <a class="src-href" target="_blank" href="rtisdev/RTISDev.py#L2492">[source]</a>
</p>
The function to set a custom logger to be used by RTIS Dev.
......