... | @@ -117,7 +117,7 @@ fig.suptitle("RTIS Dev - Microphone Signals") |
... | @@ -117,7 +117,7 @@ fig.suptitle("RTIS Dev - Microphone Signals") |
|
## **RTISMeasurement**
|
|
## **RTISMeasurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>class</i> <b>RTISMeasurement</b>(<i>id: str='', timestamp: float=0, behaviour: bool=False, index: int=0, rawData: np.ndarray=None, processedData: np.ndarray=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L321">[source]</a>
|
|
<i>class</i> <b>RTISMeasurement</b>(<i>id: str='', timestamp: float=0, behaviour: bool=False, index: int=0, rawData: np.ndarray=None, processedData: np.ndarray=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L320">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Class storing all data and information on an RTIS device measurement.
|
|
Class storing all data and information on an RTIS device measurement.
|
... | @@ -163,7 +163,7 @@ Class storing all data and information on an RTIS device measurement. |
... | @@ -163,7 +163,7 @@ Class storing all data and information on an RTIS device measurement. |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>update_processed_data</b>(<i>self, processedData: np.ndarray</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L377">[source]</a>
|
|
<i></i> <b>update_processed_data</b>(<i>self, processedData: np.ndarray</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L376">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
If only the attribute `processedData` needs to be updated, use this function.
|
|
If only the attribute `processedData` needs to be updated, use this function.
|
... | @@ -187,7 +187,7 @@ If only the attribute `processedData` needs to be updated, use this function. |
... | @@ -187,7 +187,7 @@ If only the attribute `processedData` needs to be updated, use this function. |
|
## **RTISSettings**
|
|
## **RTISSettings**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>class</i> <b>RTISSettings</b>(<i>firmwareVersion, configName=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L390">[source]</a>
|
|
<i>class</i> <b>RTISSettings</b>(<i>firmwareVersion, configName=''</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L389">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Class describing all the processing and recording settings related to RTIS devices.
|
|
Class describing all the processing and recording settings related to RTIS devices.
|
... | @@ -204,13 +204,13 @@ Can be converted to a dictionary. |
... | @@ -204,13 +204,13 @@ Can be converted to a dictionary. |
|
## **MeasureExternalTriggerQueueThread**
|
|
## **MeasureExternalTriggerQueueThread**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>class</i> <b>MeasureExternalTriggerQueueThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L545">[source]</a>
|
|
<i>class</i> <b>MeasureExternalTriggerQueueThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L544">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
|
|
The class based on a Multiprocessing Process to start RTIS sonar measurements triggered by an external trigger.
|
|
To set the data queue correctly use `set_queue(dataQueue)` function.
|
|
To set the data queue correctly use `set_queue(dataQueue)` function.
|
|
the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) objects will then be put on this queue.
|
|
the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) objects will then be put on this queue.
|
|
To start the thread use the `start()` function. To stop use the `stop_thread()` function.
|
|
To start the process 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.
|
|
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)`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#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/-/wikis/home#create_measure_external_trigger_queue) to make an easy to use the class.
|
... | @@ -224,7 +224,7 @@ Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwe |
... | @@ -224,7 +224,7 @@ Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwe |
|
|
|
|
|
#### Examples
|
|
#### Examples
|
|
|
|
|
|
Create a queue to save the measurement to and assign it to the thread.
|
|
Create a queue to save the measurement to and assign it to the process.
|
|
|
|
|
|
```python
|
|
```python
|
|
from multiprocessing import Manager
|
|
from multiprocessing import Manager
|
... | @@ -247,10 +247,10 @@ measure_thread.join() |
... | @@ -247,10 +247,10 @@ measure_thread.join() |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<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/RTISDev.py#L581">[source]</a>
|
|
<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/RTISDev.py#L580">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) objects on.
|
|
Set the dataQueue to be used by the process to store the incoming [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) objects on.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-name" />
|
... | @@ -271,10 +271,10 @@ Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasureme |
... | @@ -271,10 +271,10 @@ Set the dataQueue to be used by the Thread to store the incoming [`RTISMeasureme |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L592">[source]</a>
|
|
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L591">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Stop the measurement thread gracefully.
|
|
Stop the measurement process gracefully.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-name" />
|
... | @@ -288,10 +288,10 @@ Stop the measurement thread gracefully. |
... | @@ -288,10 +288,10 @@ Stop the measurement thread gracefully. |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L599">[source]</a>
|
|
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L598">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Get status of the thread if it should be stopped or not.
|
|
Get status of the process if it should be stopped or not.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-name" />
|
... | @@ -305,10 +305,10 @@ Get status of the thread if it should be stopped or not. |
... | @@ -305,10 +305,10 @@ Get status of the thread if it should be stopped or not. |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L605">[source]</a>
|
|
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L604">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Main thread function to run continuously. Should not be used. Use `start()` instead.
|
|
Main process function to run continuously. Should not be used. Use `start()` instead.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-name" />
|
... | @@ -322,13 +322,13 @@ Main thread function to run continuously. Should not be used. Use `start()` inst |
... | @@ -322,13 +322,13 @@ Main thread function to run continuously. Should not be used. Use `start()` inst |
|
## **MeasureExternalTriggerCallbackThread**
|
|
## **MeasureExternalTriggerCallbackThread**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>class</i> <b>MeasureExternalTriggerCallbackThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L653">[source]</a>
|
|
<i>class</i> <b>MeasureExternalTriggerCallbackThread</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L652">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
The class based on a Thread to start RTIS sonar measurements triggered by an external trigger.
|
|
The class based on a Multiprocessing Process to start RTIS sonar measurements triggered by an external trigger.
|
|
To set the callback function correctly use `set_callback(callback)` function.
|
|
To set the callback function correctly use `set_callback(callback)` function.
|
|
Your callback function should only have one argument, the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) data package.
|
|
Your callback function should only have one argument, the [`RTISMeasurement`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement) data package.
|
|
To start the thread use the `start()` function. To stop use the `stop_thread()` function.
|
|
To start the process 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.
|
|
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(callback)` to make an easy to use the class.
|
|
Use `create_measure_external_trigger_callback(callback)` to make an easy to use the class.
|
... | @@ -372,7 +372,7 @@ measure_thread.join() |
... | @@ -372,7 +372,7 @@ measure_thread.join() |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>set_callback</b>(<i>self, callback</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L696">[source]</a>
|
|
<i></i> <b>set_callback</b>(<i>self, callback</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L695">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
|
|
|
... | @@ -396,10 +396,10 @@ measure_thread.join() |
... | @@ -396,10 +396,10 @@ measure_thread.join() |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L707">[source]</a>
|
|
<i></i> <b>stop_thread</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L706">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Stop the measurement thread gracefully.
|
|
Stop the measurement process gracefully.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-name" />
|
... | @@ -413,10 +413,10 @@ Stop the measurement thread gracefully. |
... | @@ -413,10 +413,10 @@ Stop the measurement thread gracefully. |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L714">[source]</a>
|
|
<i></i> <b>stopped</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L713">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Get status of the thread if it should be stopped or not.
|
|
Get status of the process if it should be stopped or not.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-name" />
|
... | @@ -430,10 +430,10 @@ Get status of the thread if it should be stopped or not. |
... | @@ -430,10 +430,10 @@ Get status of the thread if it should be stopped or not. |
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L720">[source]</a>
|
|
<i></i> <b>run</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L719">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Main thread function to run continuously. Should not be used. Use `start()` instead.
|
|
Main process function to run continuously. Should not be used. Use `start()` instead.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-name" />
|
... | @@ -449,7 +449,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst |
... | @@ -449,7 +449,7 @@ Main thread function to run continuously. Should not be used. Use `start()` inst |
|
## **open_connection**
|
|
## **open_connection**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>open_connection</b>(<i>port: string='/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#L2129">[source]</a>
|
|
<i>def</i> <b>open_connection</b>(<i>port: string='/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#L2128">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Connect to the port of the RTIS Hardware.
|
|
Connect to the port of the RTIS Hardware.
|
... | @@ -484,7 +484,7 @@ Connect to the port of the RTIS Hardware. |
... | @@ -484,7 +484,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#L2190">[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#L2189">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Manually close the connection to the RTIS device.
|
|
Manually close the connection to the RTIS device.
|
... | @@ -510,7 +510,7 @@ be closed gracefully. |
... | @@ -510,7 +510,7 @@ be closed gracefully. |
|
## **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#L2219">[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#L2218">[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.
|
... | @@ -647,7 +647,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv") |
... | @@ -647,7 +647,7 @@ rtisdev.set_processing_settings(callCustom="mycall.csv") |
|
## **set_processing_settings**
|
|
## **set_processing_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>set_processing_settings</b>(<i>premade: str=None, jsonPath: str=None, customPath: str=None, microphoneLayout: str='eRTIS_v3D1', mode: int=1, directions: int=181, minRange: float=0.5, maxRange: float=5, microphoneSampleFrequency: int=4500000, pdmEnable: bool=True, matchedFilterEnable: bool=True, beamformingEnable: bool=True, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2405">[source]</a>
|
|
<i>def</i> <b>set_processing_settings</b>(<i>premade: str=None, jsonPath: str=None, customPath: str=None, microphoneLayout: str='eRTIS_v3D1', mode: int=1, directions: int=181, minRange: float=0.5, maxRange: float=5, microphoneSampleFrequency: int=4500000, pdmEnable: bool=True, matchedFilterEnable: bool=True, beamformingEnable: bool=True, enveloppeEnable: bool=True, cleanEnable: bool=True, preloadToggle: bool =True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2404">[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.
|
... | @@ -810,7 +810,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder") |
... | @@ -810,7 +810,7 @@ rtisdev.set_processing_settings(customPath="mysettingsfolder") |
|
## **get_current_settings**
|
|
## **get_current_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<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/RTISDev.py#L2618">[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/RTISDev.py#L2617">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current settings for processing and recording.
|
|
Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) object of the current settings for processing and recording.
|
... | @@ -834,7 +834,7 @@ Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisde |
... | @@ -834,7 +834,7 @@ Returns the [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisde |
|
## **clear_current_settings**
|
|
## **clear_current_settings**
|
|
|
|
|
|
<p class="func-header">
|
|
<p class="func-header">
|
|
<i>def</i> <b>clear_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2635">[source]</a>
|
|
<i>def</i> <b>clear_current_settings</b>(<i></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2634">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) configuration.
|
|
Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtissettings) configuration.
|
... | @@ -851,7 +851,7 @@ Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-s |
... | @@ -851,7 +851,7 @@ Clear the current applied [`RTISSettings`](https://cosysgit.uantwerpen.be/rtis-s |
|
## **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, 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#L2644">[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, 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#L2643">[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
|
... | @@ -981,7 +981,7 @@ the [`set_recording_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rt |
... | @@ -981,7 +981,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#L2845">[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#L2844">[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
|
... | @@ -1017,7 +1017,7 @@ with the [`get_settings()`](https://cosysgit.uantwerpen.be/rtis-software/rtisdev |
... | @@ -1017,7 +1017,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#L2879">[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#L2878">[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.
|
... | @@ -1041,7 +1041,7 @@ Get a list of names of all the available premade settings for processing. |
... | @@ -1041,7 +1041,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#L2894">[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#L2893">[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.
|
... | @@ -1065,7 +1065,7 @@ Get a list of names of all the available premade settings for recording. |
... | @@ -1065,7 +1065,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#L2908">[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#L2907">[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.
|
... | @@ -1089,7 +1089,7 @@ Get a list of names of all the available microphone layouts that are available f |
... | @@ -1089,7 +1089,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></i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2922">[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#L2921">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
|
Start the CUDA workers for looped measurements with processing enabled.
|
... | @@ -1116,7 +1116,7 @@ Furthermore, if using the default settings for processing this is enabled alread |
... | @@ -1116,7 +1116,7 @@ Furthermore, if using the default settings for processing this is enabled alread |
|
## **unload_processing**
|
|
## **unload_processing**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L2949">[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#L2948">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Stop all CUDA workers.
|
|
Stop all CUDA workers.
|
... | @@ -1142,7 +1142,7 @@ stopped when your script ends. |
... | @@ -1142,7 +1142,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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L2964">[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#L2963">[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.
|
... | @@ -1186,7 +1186,7 @@ measurement = rtisdev.get_raw_measurement(True) |
... | @@ -1186,7 +1186,7 @@ measurement = rtisdev.get_raw_measurement(True) |
|
## **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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3001">[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#L3000">[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
|
... | @@ -1231,7 +1231,7 @@ signal_measurement = rtisdev.get_signal_measurement(True) |
... | @@ -1231,7 +1231,7 @@ signal_measurement = rtisdev.get_signal_measurement(True) |
|
## **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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3043">[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#L3042">[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
|
... | @@ -1274,7 +1274,7 @@ processed_measurement = rtisdev.get_processed_measurement(True) |
... | @@ -1274,7 +1274,7 @@ processed_measurement = rtisdev.get_processed_measurement(True) |
|
## **process_measurement**
|
|
## **process_measurement**
|
|
|
|
|
|
<p class="func-header">
|
|
<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#L3084">[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#L3083">[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
|
... | @@ -1319,7 +1319,7 @@ processed_measurement = rtisdev.process_measurement(measurement) |
... | @@ -1319,7 +1319,7 @@ processed_measurement = rtisdev.process_measurement(measurement) |
|
## **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#L3125">[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#L3124">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Set the internal measurement counter of the sonar hardware.
|
|
Set the internal measurement counter of the sonar hardware.
|
... | @@ -1350,7 +1350,7 @@ Set the internal measurement counter of the sonar hardware. |
... | @@ -1350,7 +1350,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#L3148">[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#L3147">[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
|
... | @@ -1384,7 +1384,7 @@ argument to define the sonar behaviour. |
... | @@ -1384,7 +1384,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#L3173">[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#L3172">[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.
|
... | @@ -1408,10 +1408,11 @@ Get the firmware version of the internal RTIS firmware used on the device. |
... | @@ -1408,10 +1408,11 @@ 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 </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3188">[source]</a>
|
|
<i>def</i> <b>create_measure_external_trigger_queue</b>(<i>dataQueue: Queue </i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3187">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Thread that will be waiting for an external trigger to measure from
|
|
This will create and return a Multiprocessing Process
|
|
|
|
that will be waiting for an external trigger to measure from
|
|
the RTIS Device and afterwards put this measurement on a data queue.
|
|
the RTIS Device and afterwards put this measurement on a data queue.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
... | @@ -1429,7 +1430,7 @@ the RTIS Device and afterwards put this measurement on a data queue. |
... | @@ -1429,7 +1430,7 @@ the RTIS Device and afterwards put this measurement on a data queue. |
|
<th class="field-name"><b>Returns:</b></td>
|
|
<th class="field-name"><b>Returns:</b></td>
|
|
<td class="field-body" width="100%"><b>th : <i>MeasureExternalTriggerQueueThread</i></b>
|
|
<td class="field-body" width="100%"><b>th : <i>MeasureExternalTriggerQueueThread</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
Class instance of the Thread super class that can then be started with '.start()' and waited for with <code>.join()</code> for example. It can be closed gracefully with the '.stop_thread()' function. This will also be done automatically when <code>signal.SIGINT</code> (ex. <kbd>CTRL</kbd>+<kbd>C</kbd>) is triggered.
|
|
Class instance of the Multiprocessing Process super class that can then be started with '.start()' and waited for with <code>.join()</code> for example. It can be closed gracefully with the '.stop_thread()' function. This will also be done automatically when <code>signal.SIGINT</code> (ex. <kbd>CTRL</kbd>+<kbd>C</kbd>) is triggered.
|
|
</p></td>
|
|
</p></td>
|
|
</tr>
|
|
</tr>
|
|
</tbody>
|
|
</tbody>
|
... | @@ -1437,7 +1438,7 @@ the RTIS Device and afterwards put this measurement on a data queue. |
... | @@ -1437,7 +1438,7 @@ the RTIS Device and afterwards put this measurement on a data queue. |
|
|
|
|
|
#### Examples
|
|
#### Examples
|
|
|
|
|
|
Create a queue to save the measurement to and assign it to the thread.
|
|
Create a queue to save the measurement to and assign it to the process.
|
|
|
|
|
|
```python
|
|
```python
|
|
from multiprocessing import Manager
|
|
from multiprocessing import Manager
|
... | @@ -1461,7 +1462,8 @@ measure_thread.join() |
... | @@ -1461,7 +1462,8 @@ measure_thread.join() |
|
<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#L3231">[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#L3231">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Thread that will be waiting for an external trigger to measure from
|
|
This will create and return a Multiprocessing Process
|
|
|
|
that will be waiting for an external trigger to measure from
|
|
the RTIS Device and afterwards put this measurement on a data queue.
|
|
the RTIS Device and afterwards put this measurement on a data queue.
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
... | @@ -1479,7 +1481,7 @@ the RTIS Device and afterwards put this measurement on a data queue. |
... | @@ -1479,7 +1481,7 @@ the RTIS Device and afterwards put this measurement on a data queue. |
|
<th class="field-name"><b>Returns:</b></td>
|
|
<th class="field-name"><b>Returns:</b></td>
|
|
<td class="field-body" width="100%"><b>th : <i>MeasureExternalTriggerCallbackThread</i></b>
|
|
<td class="field-body" width="100%"><b>th : <i>MeasureExternalTriggerCallbackThread</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
Class instance of the Thread super class that can then be started with <code>.start()</code> and waited for with <code>.join()</code> for example. It can be closed gracefully with the <code>.stop_thread()</code> function. This will also be done automatically when <em>signal.SIGINT</em> (ex. <kbd>CTRL</kbd>+<kbd>C</kbd>) is triggered.
|
|
Class instance of the Multiprocessing Process super class that can then be started with <code>.start()</code> and waited for with <code>.join()</code> for example. It can be closed gracefully with the <code>.stop_thread()</code> function. This will also be done automatically when <em>signal.SIGINT</em> (ex. <kbd>CTRL</kbd>+<kbd>C</kbd>) is triggered.
|
|
</p></td>
|
|
</p></td>
|
|
</tr>
|
|
</tr>
|
|
</tbody>
|
|
</tbody>
|
... | @@ -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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3284">[source]</a>
|
|
<i>def</i> <b>create_processing_workers</b>(<i>workerCount: int, inputQueue: Queue, outputQueue: Queue</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3285">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
This will create and return a Multiprocessing Pool that will generating a chosen amount of processing
|
|
This will create and return a Multiprocessing Pool that will generating a chosen amount of processing
|
... | @@ -1588,7 +1590,7 @@ workersPool.terminate() |
... | @@ -1588,7 +1590,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#L3357">[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#L3358">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
Enable/disable the high voltage amplifier's step up controller.
|
|
Enable/disable the high voltage amplifier's step up controller.
|
... | @@ -1620,7 +1622,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav |
... | @@ -1620,7 +1622,7 @@ It is enabled by default so has to be manually disabled if wanted. This will sav |
|
## **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</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L3380">[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#L3381">[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.
|
... | @@ -1652,7 +1654,7 @@ They are disabled by default so have to be manually enabled. |
... | @@ -1652,7 +1654,7 @@ They are disabled by default so have to be manually enabled. |
|
## **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#L3403">[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#L3404">[source]</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
The function to reset the RTIS device hardware.
|
|
The function to reset the RTIS device hardware.
|
... | @@ -1665,7 +1667,7 @@ The function to reset the RTIS device hardware. |
... | @@ -1665,7 +1667,7 @@ The function to reset the RTIS device hardware. |
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<th class="field-name"><b>Parameters:</b></td>
|
|
<td class="field-body" width="100%"><b>stm32pin : <i>Integer (default = 7)</i></b>
|
|
<td class="field-body" width="100%"><b>stm32pin : <i>Integer (default = 7)</i></b>
|
|
<p class="attr">
|
|
<p class="attr">
|
|
Change the GPIO pin used for the STM32 connection. Please ask a CoSys-Lab member for the correct pin number if not working as intended with the default value.
|
|
Change the GPIO pin used for the STM32 connection. Please ask a Cosys-Lab member for the correct pin number if not working as intended with the default value.
|
|
</p></td>
|
|
</p></td>
|
|
</tr>
|
|
</tr>
|
|
<tr class="field">
|
|
<tr class="field">
|
... | @@ -1683,7 +1685,7 @@ The function to reset the RTIS device hardware. |
... | @@ -1683,7 +1685,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#L3451">[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#L3452">[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.
|
... | @@ -1707,7 +1709,7 @@ The function to set the logging level of the RTIS Dev module. |
... | @@ -1707,7 +1709,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#L3482">[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#L3483">[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.
|
... | | ... | |