CleanTiPy is a python package allowing users to realise acoustic images of moving sources. It implements the CLEAN-T algorithm, with some additional features such as:
- Angular selection of the trajectory (to realise the analysis on portions of the trajectory)
- Frequency band filtering (on third-octave or octave band) to do the analysis for specific frequency band (can speed up the computation in low frequency by decimating the signal)
- Implementation of (an homogeneous) wind effect on propagation and back-propagation.
As implementing CLEAN-T, this package can thus be used for computing classical Beamforming computation and propagation simulations (being constitutive blocks of iterative CLEAN-T algorithm).
It is based on the work published in Cousson et al. and in Leiba et al.
This code has been developed in Python 3.11 and therefore back-compatibility is not guaranteed.
Install the required packages with pip:
pip install cleantipy
Examples can be found in the examples directory on github
An exemple (CLEAN-T over trajectory, for multiple frequency bands) can be run this way:
cd ./examples/
python computeCleanT_multiFreq.py
An exemple of CLEAN-T over trajectory, for multiple frequency bands, and for multiple angular windows can be run this way:
cd ./examples/
python computeCleanT_multiFreq_multiAngles.py
Same example can be found as notebook here
The full documentation of the project is available on ReadTheDocs
Contact Raphaël LEIBA : raphael.leiba@univ-eiffel.fr
Not open for contribution yet
Raphaël Leiba1,2, with the help of Quentin Leclère2
1Joint Research Unit in Environmental Acoustics UMRAE, Gustave Eiffel University
2Laboratory of Vibration and Acoustics LVA, INSA Lyon
CleanTiPy is licensed under the EUPL-1.2. See LICENSE
Ready for production release but still in active development