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 @ f77efc2f
......@@ -163,11 +163,11 @@ Can be converted to a dictionary.
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
To set the data queue correctly use `set_queue(dataQueue)` function.
the [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) objects will then be put on this queue.
the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) objects will then be put on this queue.
To start the thread use the `start()` function. To stop use the `stop_thread()` function.
By default using a `signal.SIGINT` exit (ex. using <kbd>CTRL</kbd>+<kbd>C</kbd>) will gracefully end the script.
Use [`create_measure_external_trigger_queue(dataQueue)`](rtisdev/RTISDev.py#create_measure_external_trigger_queue) to make an easy to use the class.
Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#create_measure_external_trigger_queue) to make an easy to use the class.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -199,7 +199,7 @@ measure_thread.join()
<i></i> <b>set_queue</b>(<i>self, dataQueue</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev2.py#L358">[source]</a>
</p>
Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) objects on.
Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) objects on.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -276,11 +276,11 @@ Main thread function to run continuously. Should not be used. Use `start()` inst
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
To set the callback function correctly use `set_callback(callback)` function.
Your callback function should only have one argument, the [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) data package.
Your callback function should only have one argument, the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) data package.
To start the thread use the `start()` function. To stop use the `stop_thread()` function.
By default using a `signal.SIGINT` exit (ex. using <kbd>CTRL</kbd>+<kbd>C</kbd>) will gracefully end the script.
Use [`create_measure_external_trigger_callback(save_callback)`](rtisdev/RTISDev.py#create_measure_external_trigger_callback) to make an easy to use the class.
Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#create_measure_external_trigger_callback) to make an easy to use the class.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -328,7 +328,7 @@ measure_thread.join()
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>callback : <i>method with one argument (RTISMeasurement)</i></b>
<p class="attr">
This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="rtisdev/RTISDev.py#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data.
This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data.
</p></td>
</tr>
</tbody>
......@@ -505,7 +505,7 @@ Please read their decription carefully.
#### Examples
Create settings from a premade setup.
You can get the available premade settings with [`get_premade_recording_settings_list()`](rtisdev/RTISDev.py#get_premade_processing_settings_list).
You can get the available premade settings with [`get_premade_recording_settings_list()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_premade_processing_settings_list).
```python
rtisdev.set_recording_settings(premade="short_20_80")
......@@ -654,7 +654,7 @@ Please read their decription carefully.
#### Examples
Create settings from a premade setup with all processing steps on.
You can get the available premade settings with [`get_premade_recording_settings_list()`](rtisdev/RTISDev.py#get_premade_processing_settings_list).
You can get the available premade settings with [`get_premade_recording_settings_list()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_premade_processing_settings_list).
```python
rtisdev.set_processing_settings(premade="3D_5m_3000", pdmEnable=True, matchedFilterEnable=True,
......@@ -668,7 +668,7 @@ rtisdev.set_processing_settings(premade="3D_5m_3000")
```
Create settings from a premade setup with only part of the processing steps enabled and no preloading.
You can get the available premade settings with [`get_premade_recording_settings_list()`](rtisdev/RTISDev.py#get_premade_processing_settings_list).
You can get the available premade settings with [`get_premade_recording_settings_list()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#get_premade_processing_settings_list).
```python
rtisdev.set_processing_settings(premade="2D_5m_181", pdmEnable=True, matchedFilterEnable=True,
......@@ -734,7 +734,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder")
<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>
</p>
The function returns the [`RTISSettings`](rtisdev/RTISDev.py#rtissettings) object of the current DSP Settings.
The function returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtissettings) object of the current DSP Settings.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -758,7 +758,7 @@ The function returns the [`RTISSettings`](rtisdev/RTISDev.py#rtissettings) objec
<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>
</p>
The high level function to set the wanted DSP settings from an [`RTISSettings`](rtisdev/RTISDev.py#rtissettings) object. These can be created
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
with the get_custom_settings() or get_settings() functions.
<table class="docutils field-list field-table" frame="void" rules="none">
......@@ -887,7 +887,7 @@ The high level function to stop the CUDA workers. Only required if actually usin
<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>
</p>
The high level function to start an RTIS sonar measurement and return the raw data in an [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) object.
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.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -927,7 +927,7 @@ measurement = rtisdev.get_raw_measurement(True)
</p>
The high level function to start an RTIS sonar measurement and process it with only PDM filtering
and subsampling to get the (microphone) signals return them in an [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) object.
and subsampling to get the (microphone) signals return them in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -968,7 +968,7 @@ signal_measurement = rtisdev.get_signal_measurement(True)
</p>
The high level function to start an RTIS sonar measurement and process it and return the raw and processed data
in an [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) object.
in an [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -1008,8 +1008,8 @@ processed_measurement = rtisdev.get_processed_measurement(True)
<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>
</p>
The high level function to process a raw RTIS sonar measurement from a [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) object
and return the raw and processed data in a new [`RTISMeasurement`](rtisdev/RTISDev.py#rtismeasurement) object.
The high level function to process a raw RTIS sonar measurement from a [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object
and return the raw and processed data in a new [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement) object.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
......@@ -1148,7 +1148,7 @@ the RTIS Device and afterwards put this measurement on a data queue.
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>dataQueue : <i>multiprocessing.Manager.Queue</i></b>
<p class="attr">
On this queue the <a href="rtisdev/RTISDev.py#rtismeasurement"><code>RTISMeasurement</code></a> objects will be put after an external trigger starts a new measurement.
On this queue the <a href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement"><code>RTISMeasurement</code></a> objects will be put after an external trigger starts a new measurement.
</p></td>
</tr>
<tr class="field">
......@@ -1193,7 +1193,7 @@ the RTIS Device and afterwards put this measurement on a data queue.
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>callback : <i>method with one argument of type RTISMeasurement</i></b>
<p class="attr">
This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="rtisdev/RTISDev.py#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data.
This is the method that will be used as a callback when a new measurement is triggered by the external trigger. This function should only require one argument, the <a href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data.
</p></td>
</tr>
<tr class="field">
......