sonosk 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. sonosk-0.1.0/CHANGELOG.md +34 -0
  2. sonosk-0.1.0/CITATION.cff +34 -0
  3. sonosk-0.1.0/LICENSE +674 -0
  4. sonosk-0.1.0/PKG-INFO +141 -0
  5. sonosk-0.1.0/README.md +99 -0
  6. sonosk-0.1.0/examples/array_beams.py +46 -0
  7. sonosk-0.1.0/examples/bmode_phantom.py +100 -0
  8. sonosk-0.1.0/examples/bowl_field.py +49 -0
  9. sonosk-0.1.0/examples/hifu_ablation.py +106 -0
  10. sonosk-0.1.0/examples/line_focus.py +46 -0
  11. sonosk-0.1.0/examples/mechanical_index.py +50 -0
  12. sonosk-0.1.0/examples/transducer_stack.py +57 -0
  13. sonosk-0.1.0/examples/water_properties.py +30 -0
  14. sonosk-0.1.0/pyproject.toml +80 -0
  15. sonosk-0.1.0/src/sonosk/__init__.py +32 -0
  16. sonosk-0.1.0/src/sonosk/analytic.py +66 -0
  17. sonosk-0.1.0/src/sonosk/field.py +140 -0
  18. sonosk-0.1.0/src/sonosk/grid.py +82 -0
  19. sonosk-0.1.0/src/sonosk/imaging.py +279 -0
  20. sonosk-0.1.0/src/sonosk/medium.py +115 -0
  21. sonosk-0.1.0/src/sonosk/phantom.py +140 -0
  22. sonosk-0.1.0/src/sonosk/plot.py +106 -0
  23. sonosk-0.1.0/src/sonosk/quality.py +80 -0
  24. sonosk-0.1.0/src/sonosk/safety.py +152 -0
  25. sonosk-0.1.0/src/sonosk/stack.py +193 -0
  26. sonosk-0.1.0/src/sonosk/thermal.py +206 -0
  27. sonosk-0.1.0/src/sonosk/transducer.py +302 -0
  28. sonosk-0.1.0/src/sonosk/water.py +43 -0
  29. sonosk-0.1.0/tests/test_analytic.py +38 -0
  30. sonosk-0.1.0/tests/test_field.py +64 -0
  31. sonosk-0.1.0/tests/test_grid.py +39 -0
  32. sonosk-0.1.0/tests/test_imaging.py +73 -0
  33. sonosk-0.1.0/tests/test_medium_phantom.py +53 -0
  34. sonosk-0.1.0/tests/test_quality.py +40 -0
  35. sonosk-0.1.0/tests/test_safety.py +69 -0
  36. sonosk-0.1.0/tests/test_stack.py +41 -0
  37. sonosk-0.1.0/tests/test_thermal.py +60 -0
  38. sonosk-0.1.0/tests/test_transducer.py +71 -0
  39. sonosk-0.1.0/tests/test_water.py +30 -0
sonosk-0.1.0/CHANGELOG.md ADDED
@@ -0,0 +1,34 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 (2026-10-20)
4
+
5
+ First release.
6
+
7
+ - `Grid`: regular grids in 1, 2 and 3 dimensions, depth on the last axis.
8
+ - `transducer`: piston, focused bowl, annular array, linear and phased
9
+ arrays with optional elevation lens, convex and endocavity arrays, matrix
10
+ arrays and cylindrical line-focus sources; focusing, steering and
11
+ apodization.
12
+ - `field`: CW pressure from the Rayleigh integral in an attenuating
13
+ medium, angular spectrum propagation, intensity and pressure scaling.
14
+ - `medium`: materials with acoustic and thermal properties and power-law
15
+ attenuation; property maps from label maps.
16
+ - `phantom`: layers, spheres, ellipsoids, cylinders, boxes, point
17
+ scatterers with echo levels and wire targets.
18
+ - `imaging`: Gaussian pulse, plane, diverging and focused transmits,
19
+ pulse-echo simulation, delay-and-sum beamforming, coherent compounding
20
+ and log compression.
21
+ - `thermal`: heat source from the pressure field, Pennes bioheat solver in
22
+ 1, 2 and 3 dimensions with pulsed schedules, CEM43 dose, lesion maps and
23
+ a treatment report (ablated and residual target, damaged healthy tissue).
24
+ - `stack`: Mason model of a thickness-mode piezoelectric element with
25
+ backing, matching layers and load; impedance, transmit and pulse-echo
26
+ responses, Desilets matching layer impedances.
27
+ - `safety`: derating, pulse intensity integral, pulse duration, ISPPA,
28
+ ISPTA, mechanical index and the FDA Track 3 limits.
29
+ - `quality`: -6 dB width, contrast, CNR, gCNR, speckle SNR and SNR.
30
+ - `analytic`: on-axis pressure of a flat piston and of a focused bowl.
31
+ - `water`: sound speed, density and impedance of water.
32
+ - `plot`: B-mode images, field maps, temperature maps with lesion outlines,
33
+ label maps and orthogonal slices.
34
+ - User guide, validation page and example gallery.
sonosk-0.1.0/CITATION.cff ADDED
@@ -0,0 +1,34 @@
1
+ cff-version: 1.2.0
2
+ message: "If you use this software, please cite it as below."
3
+ title: "SonoSK: medical ultrasound simulation in Python"
4
+ type: software
5
+ authors:
6
+ - family-names: Kooklan
7
+ given-names: Soheil
8
+ email: soheilkooklan@gmail.com
9
+ orcid: "https://orcid.org/0009-0003-5035-7833"
10
+ version: 0.1.0
11
+ date-released: 2026-10-20
12
+ license: GPL-3.0-or-later
13
+ repository-code: "https://github.com/sonosk/sonosk"
14
+ url: "https://sonosk.github.io/sonosk/"
15
+ abstract: >-
16
+ SonoSK is a Python library for simulating medical ultrasound. It models
17
+ transducers from single elements to linear, phased, convex, matrix and
18
+ focused arrays, computes continuous-wave pressure fields with the
19
+ Rayleigh integral and the angular spectrum method, simulates pulse-echo
20
+ signals and B-mode images of numerical phantoms, solves the Pennes
21
+ bioheat equation for focused ultrasound exposures with thermal dose and
22
+ lesion maps, models piezoelectric stacks with the Mason circuit, and
23
+ reports acoustic output indices and image quality measures.
24
+ keywords:
25
+ - ultrasound
26
+ - simulation
27
+ - medical imaging
28
+ - transducer
29
+ - beamforming
30
+ - HIFU
31
+ - focused ultrasound
32
+ - bioheat
33
+ - thermal dose
34
+ - acoustic output