Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: USonixGroup
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 3.34 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

WPT-Cavitation

A python library for processing 1D time-seriers data using discrete wavelet transforms and machine learning.

The main features are:

  • a 1D implementation of the discrete wavelet transform (DWT) and discrete wavelet packet transform (DWPT)
  • inverse transforms which can reconstructed based on selected nodes individually
  • minimum entropy decomposition to automatically identify the maximum level of(depth) of decomposition
  • decomposition for nodes under a selected frequency threshold
  • characterising nodes by their statistical features
  • bubble dynamics simulations with the Gilmmore-Akulichev model
  • visualisation with tree diagrams for DWT/DWPT, spectrograms and Heisenberg plots
  • classification of nodes with clustering algorithms

The wavelet transform has been tested against results from the PyWavelets library and MATLAB. The implementation of the DWT/DWPT only relies on filter coefficients of the wavelet functions which can be imported manually (for any customised wavelet function) or use a family of wavelet functions available in PyWavelets.

This library was developed as part of an ongoing project associated with an upcoming paper: Quantitative Detection and Classification of Acoustic Cavitation Using Wavelet Packet Transform and k-Means Clustering

Examples

The notebooks folder includes example codes illustrating the use of the library for simulating acoustic emissions by solving the bubble dynamics. Th emissions are then processed using the algorithm explained in the above mentioned paper. The figure below depicts acoustic emissions from a bubble undergoing transient cavitation:

bdsimulation

The emissions are processed using a Daubechies wavelet. The decomposition is asymmetric. Tree plot of the discrete wavelet packet transform is shown below. The node size is corresponding to the energy of the DWPT coefficients of the node.

treeplot

Heisenberg plot of the wavelet packet coefficients show time-frequency distribution of nodes (which are multi-resolution):

heisenberg

Finally, after classifying the DWPT nodes into periodic (Cluster 0) and transient (Cluster 1) components, the clustered nodes are reconstructed to obtain decomposed time-series:

reconstruction

Installation

This library can be used by cloning and pulling from main. WPT-Cavitation is dependent on NumPy, SciPy, PyWavelets, and scikit-learn for the k-means algorithm. Plotting requires matplotlib, plotly, and pygraphviz.

Get help

Contact on GitHub or at max.au-yeung20@ucl.ac.uk.

Acknowledgement

This work was partially supported by the Focused Ultrasound Foundation, and the UCL Mechanical Engineering department.

Licence

WPT-Cavitation is licensed under an MIT licence. Full text of the licence can be found here.

Citation

If you use WPT-Cavitation in your work, please cite it as follows:

APA Au-Yeung, M., & Haqshenas, R. (2024). WPT-Cavitation Analysis. https://github.com/USonixGroup/wpt-cavitation/

BibTeX @software{WPT-Cavitation_Analysis_2024, author = {Au-Yeung, Max and Haqshenas, Reza}, title = {{WPT-Cavitation Analysis}}, url = {https://github.com/USonixGroup/wpt-cavitation/}, version = {0.1.0}, year = {2024} }

Owner

  • Name: Ultrasonics Group
  • Login: USonixGroup
  • Kind: organization
  • Location: United Kingdom

This is the GitHub page of the Ultrasonics Group, UCL Mechanical Engineering.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this library, please cite it as below."
authors:
- family-names: "Au-Yeung"
  given-names: "Max"
- family-names: "Haqshenas"
  given-names: "Reza"
  orcid: "https://orcid.org/0000-0002-3082-0232"
title: "WPT-Cavitation Analysis"
version: 0.1.0
doi: 
url: "https://github.com/USonixGroup/wpt-cavitation/"
identifiers:
  - type: doi
    value: 
date-released: 2024-01-10

GitHub Events

Total
  • Member event: 1
  • Public event: 1
Last Year
  • Member event: 1
  • Public event: 1