Add focal pressure, focal volume, and FWHM to results metrics - Githubissues

agencyenterprise / neurotechdevkit

Neurotech Development Kit (NDK)

https://agencyenterprise.github.io/neurotechdevkit/

Apache License 2.0

115 stars 10 forks source link

Add focal pressure, focal volume, and FWHM to results metrics #152

Closed charlesbmi closed 11 months ago

charlesbmi commented 1 year ago

Related to: https://github.com/agencyenterprise/neurotechdevkit/issues/88

Introduction

To summarize a focused ultrasound configuration, users often use metrics like focal pressure, focal volume, and FWHM (e.g., Aubry et al. (2022)). We add those to NDK here.

Changes

focal_pressure calculation in _metrics.py
focal_volume (units: pixels/voxels) in _metrics.py
FWHM (full-width at half-maximum) along each dimension (units: grid points) in _metrics.py

I left the volume/FWHM units as pixels/voxels to keep the code simple.

Behavior

calculate_all_metrics now includes
Testing: see added unit tests in test_metrics.py

codecov-commenter commented 1 year ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Files	Coverage Δ
src/neurotechdevkit/results/_metrics.py	`100.00% <100.00%> (ø)`

... and 13 files with indirect coverage changes

:loudspeaker: Thoughts on this report? Let us know!.

charlesbmi commented 11 months ago

Per discussion with Diogo, will look into the metrics tables from Aubry et al. 2022 as a implementation validation