pyruct

Python Package for Reflection Ultrasound Computed Tomography (RUCT) Delay And Sum (DAS) Algorithm

https://github.com/berkanlafci/pyruct

Science Score: 67.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
    Found 13 DOI reference(s) in README
  • Academic publication links
    Links to: ieee.org, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

beamforming computed-tomography delay-and-sum ultrasound
Last synced: 6 months ago · JSON representation ·

Repository

Python Package for Reflection Ultrasound Computed Tomography (RUCT) Delay And Sum (DAS) Algorithm

Basic Info
Statistics
  • Stars: 46
  • Watchers: 2
  • Forks: 5
  • Open Issues: 0
  • Releases: 4
Topics
beamforming computed-tomography delay-and-sum ultrasound
Created over 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

pyruct

Paper Documentation Data License: MIT

Python Package for Reflection Ultrasound Computed Tomography (RUCT) Delay And Sum (DAS) Beamforming

Paper : IEEE TUFFC Link
Documentation: Website Link
Data : Zenodo Link

example_figure

Latest package release:
DOI

Public dataset:
DOI

The imaging setup is explained in the following paper Lafci, B. et al. Synthetic Transmit Aperture (STA) method for pulse-echo ultrasound was used in data acquisition. All images were reconstructed using Delay And Sum (DAS) algorithm and compounded to create final high contrast images.

Installation

This project uses pip package manager. Please run the following command in your terminal to install the package. bash pip install git+https://github.com/berkanlafci/pyruct.git

Usage

After installing package, the functions can be called using python scripts.

Example scripts to use pyruct package can be found in _examples folder.

For example, delay and sum example on cpu is called with following commands in terminal. bash python exampleCpuDAS.py The example scripts can be written by users.

pyruct package can be imported in python scripts using following line. python import pyruct as pt After importing the package, the functions can be called with following lines in python script. python usData = pt.usReader(filePath=filePath) # read data das = pt.cpuDAS() # create reconstruction object imageRecon = das.recon(usData.sigMat) # reconstruct image

Data

Data used in the paper is available here.
Test data is publicly available here.

After the download, place the data in "data/rawData/" folder that shares the same root directory with "exampleCpuDAS.py" script that can be run for testing "pyruct".

Citation

If you use this package and/or data in your research, please cite the following paper.

@article{lafci2022expediting, author = {Lafci, Berkan and Robin, Justine and Deán-Ben, Xosé Luís and Razansky, Daniel}, title = {Expediting Image Acquisition in Reflection Ultrasound Computed Tomography}, journal = {IEEE Transactions on Ultrasonics, Ferroelectrics, and Frequency Control}, year = {2022}, volume = {69}, number = {10}, pages = {2837-2848}, doi = {10.1109/TUFFC.2022.3172713} }

Acknowledgements

This project is supported by Swiss Data Science Center (SDSC) grant C19-04.

License

This project is licensed under MIT License.

Owner

  • Name: Berkan Lafci
  • Login: berkanlafci
  • Kind: user
  • Location: Zurich, Switzerland
  • Company: University of Zurich

🔬 Postdoctoral Researcher at UZH 🔬 🎓 Boğaziçi University ‘15, TU München ‘18, ETH Zurich '23 🎓 (he/him/his)

Citation (CITATION.cff)

cff-version: 1.0.4
message: "If you use this package, please cite it as below."
authors:
- family-names: "Lafci"
  given-names: "Berkan"
  orcid: "https://orcid.org/0000-0001-5387-1748"
- family-names: "Robin"
  given-names: "Justine"
  orcid: "https://orcid.org/0000-0002-4642-1375"
- family-names: "Dean-Ben"
  given-names: "Xose Luis"
  orcid: "https://orcid.org/0000-0002-8557-7778"
- family-names: "Razansky"
  given-names: "Daniel"
  orcid: "https://orcid.org/0000-0001-8676-0964"
title: "pyruct"
version: 1.0.3
doi: 10.5281/zenodo.5599811
date-released: 2021-11-23
url: "https://github.com/berkanlafci/pyruct"
preferred-citation:
  type: article
  authors:
  - family-names: "Lafci"
    given-names: "Berkan"
    orcid: "https://orcid.org/0000-0001-5387-1748"
  - family-names: "Robin"
    given-names: "Justine"
    orcid: "https://orcid.org/0000-0002-4642-1375"
  - family-names: "Dean-Ben"
    given-names: "Xose Luis"
    orcid: "https://orcid.org/0000-0002-8557-7778"
  - family-names: "Razansky"
    given-names: "Daniel"
    orcid: "https://orcid.org/0000-0001-8676-0964"
  doi: "10.1109/TUFFC.2022.3172713"
  journal: "IEEE Transactions on Ultrasonics, Ferroelectrics, and Frequency Control"
  month: 
  start: 
  end: 
  title: "Expediting Image Acquisition in Reflection Ultrasound Computed Tomography"
  issue: 
  volume: 
  year: 2022

GitHub Events

Total
  • Watch event: 5
  • Fork event: 1
Last Year
  • Watch event: 5
  • Fork event: 1

Dependencies

setup.py pypi
  • Pillow *
  • h5py *
  • matplotlib *
  • numpy *
  • scipy *