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 @ 83041cd9
......@@ -194,34 +194,6 @@ Class storing all data and information on an RTIS device measurement.
</tbody>
</table>
#### Methods
<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#L420">[source]</a>
</p>
If only the attribute `processedData` needs to be updated, use this function.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>processedData : <i>Numpy ndarray (None by default)</i></b>
<p class="attr">
This stores the (partially) processed data that has gone through the processing pipeline as configured by the user.
</p></td>
</tr>
</tbody>
</table>
## **RTISSettings**
<p class="func-header">
......@@ -240,148 +212,6 @@ Can be converted to a dictionary.
</table>
#### Methods
<p class="func-header">
<i></i> <b>set_recording_settings</b>(<i>self, adcSignal, dacSignal, microphoneSampleFrequency, dacSampleFrequency, microphoneSamples, callDuration, callMinimumFrequency, callMaximumFrequency, callEmissions</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L453">[source]</a>
</p>
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
<p class="func-header">
<i></i> <b>set_processing_settings</b>(<i>self, pdmEnable, preFilterEnable, matchedFilterEnable, beamformingEnable, postFilterEnable, enveloppeEnable, cleanEnable, preloadToggle, delayMatrix, directions, ranges, microphoneLayout, disableList, postFilter, preFilter</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L472">[source]</a>
</p>
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
## **TimeStampRecorderProcess**
<p class="func-header">
<i>class</i> <b>TimeStampRecorderProcess</b>(<i>*args, **kwargs</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L591">[source]</a>
</p>
The class based on a Multiprocessing Process to start a process to store the latest timestamp of a recorded
measurement using RTIS Sync pulses. It will use the Jetson GPIO library to wait for the RTIS Sync pulse
and store the system time. This is to circumvent having to take the timestamp after a measurement instead of
before.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
#### Methods
<p class="func-header">
<i></i> <b>set_configuration</b>(<i>self, latestTimestamp, localLogger, debug</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L606">[source]</a>
</p>
Set the configuration parameters for this process after creating it.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>latestTimestamp : <i>multiprocessing.Manager.Value</i></b>
<p class="attr">
Memory storage shared between processes to store the latest timestamp value on.
</p>
<b>localLogger : <i>logging.Logger</i></b>
<p class="attr">
The custom logger to be used by RTIS Dev.
</p>
<b>debug : <i>int</i></b>
<p class="attr">
The toggle of the debug mode where a RTIS device is simulated using pre-recorded data.
</p></td>
</tr>
</tbody>
</table>
<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#L625">[source]</a>
</p>
Stop the process gracefully.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
<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#L631">[source]</a>
</p>
Get status of the process if it should be stopped or not.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
<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#L637">[source]</a>
</p>
Main process function to run continuously. Should not be used directly. Use `start()` instead.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
## **MeasureExternalTriggerQueueThread**
<p class="func-header">
......@@ -403,117 +233,6 @@ Use [`create_measure_external_trigger_queue(dataQueue)`](https://cosysgit.uantwe
</table>
#### Methods
<p class="func-header">
<i></i> <b>set_configuration</b>(<i>self, dataQueue, settings, debugCounter, behaviour, device_id, localLogger, debug, latestTimestamp, useTimestampRecorder</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L686">[source]</a>
</p>
Set the configuration parameters for this process after creating it.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>dataQueue : <i>multiprocessing.Manager.Queue</i></b>
<p class="attr">
This is the data queue that will be used to store the RTISMeasurement objects on.
</p>
<b>settings : <i>RTISSettings</i></b>
<p class="attr">
The complete class containing all RTIS settings for recording and processing that needs to be set.
</p>
<b>debugCounter : <i>int</i></b>
<p class="attr">
The internal counter to use for indexing measurements in debug mode.
</p>
<b>behaviour : <i>int</i></b>
<p class="attr">
The behaviour mode chosen. 0 = passive 1 = active
</p>
<b>device_id : <i>String</i></b>
<p class="attr">
The identifier to use for the measurements.
</p>
<b>localLogger : <i>logging.Logger</i></b>
<p class="attr">
The custom logger to be used by RTIS Dev.
</p>
<b>debug : <i>int</i></b>
<p class="attr">
The toggle of the debug mode where a RTIS device is simulated using pre-recorded data.
</p>
<b>latestTimestamp : <i>multiprocessing.Manager.Value</i></b>
<p class="attr">
Memory storage shared between processes to store the latest timestamp value on.
</p>
<b>useTimestampRecorder : <i>bool</i></b>
<p class="attr">
Indicate to use the separate timestamp recorder or take timestamp afterwards.
</p></td>
</tr>
</tbody>
</table>
<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#L732">[source]</a>
</p>
Stop the measurement process gracefully.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
<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#L739">[source]</a>
</p>
Get status of the process if it should be stopped or not.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
<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#L745">[source]</a>
</p>
Main process function to run continuously. Should not be used directly. Use `start()` instead.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
## **MeasureExternalTriggerCallbackThread**
<p class="func-header">
......@@ -535,117 +254,6 @@ Use [`create_measure_external_trigger_callback(save_callback)`](https://cosysgit
</table>
#### Methods
<p class="func-header">
<i></i> <b>set_configuration</b>(<i>self, callback, settings, debugCounter, behaviour, device_id, localLogger, debug, latestTimestamp, useTimestampRecorder</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtisdev/RTISDev.py#L849">[source]</a>
</p>
Set the configuration parameters for this process after creating it.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>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="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#rtismeasurement"><code>RTISMeasurement</code></a> object containing the measurement data.
</p>
<b>settings : <i>RTISSettings</i></b>
<p class="attr">
The complete class containing all RTIS settings for recording and processing that needs to be set.
</p>
<b>debugCounter : <i>int</i></b>
<p class="attr">
The internal counter to use for indexing measurements in debug mode.
</p>
<b>behaviour : <i>int</i></b>
<p class="attr">
The behaviour mode chosen. 0 = passive 1 = active
</p>
<b>device_id : <i>String</i></b>
<p class="attr">
The identifier to use for the measurements.
</p>
<b>localLogger : <i>logging.Logger</i></b>
<p class="attr">
The custom logger to be used by RTIS Dev.
</p>
<b>debug : <i>int</i></b>
<p class="attr">
The toggle of the debug mode where a RTIS device is simulated using pre-recorded data.
</p>
<b>latestTimestamp : <i>multiprocessing.Manager.Value</i></b>
<p class="attr">
Memory storage shared between processes to store the latest timestamp value on.
</p>
<b>useTimestampRecorder : <i>bool</i></b>
<p class="attr">
Indicate to use the separate timestamp recorder or take timestamp afterwards.
</p></td>
</tr>
</tbody>
</table>
<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#L897">[source]</a>
</p>
Stop the measurement process gracefully.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
<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#L904">[source]</a>
</p>
Get status of the process if it should be stopped or not.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
<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#L910">[source]</a>
</p>
Main process function to run continuously. Should not be used directly. Use `start()` instead.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
</table>
# **Methods**
## **open_connection**
......