#441 Add us beams example

[gordon-n-stevenson]

This PR addresses adding the us_beams example to kwave-python. Just the ipython notebook for now and probably needs some small changes

[waltsims]

Hey Gordon,

Thanks for the PR!

[waltsims]

@gordon-n-stevenson you can convert your notebook to a python file with nbconvert. Please do this and add a readme for your example before further review.

[waltsims]

closes #441

[gordon-n-stevenson]

Latest iteration of this PR is ready for review - the READMEs and python files should be in the right format. One outstanding issue is the last few blocks of us_beam_patterns.py and checking @waltsims @djps you are happy with my approach to get the amplitude spectrum out of the data.

Ideally being able to use the in-built kwave spect would be a better approach but I was struggling to get it working with the 3D data

[waltsims]

Hey Gordon, thanks for your changes. I'll have a look. If you had an issue with the kwave spect function, it would be helpful if you could open an Issue so we can try to address it! At a minimum improved documentation!

[gordon-n-stevenson]

Sure thing, I'll raise a MWE of the issue I had and try to explain - I didn't spend too much time on it and was more looking to get things to mirror the OG k-wave example.

On Wed, 11 Sept 2024 at 09:00, Walter Simson @.***> wrote:

Hey Gordon, thanks for your changes. I'll have a look. If you had an issue with the kwave spect function, it would be helpful if you could open an Issue so we can try to address it! At a minimum improved documentation!

— Reply to this email directly, view it on GitHub https://github.com/waltsims/k-wave-python/pull/445#issuecomment-2342306987, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAOVQKSL7QRWHI4BVOZOQ7DZV52Y5AVCNFSM6AAAAABMTQDUR6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNBSGMYDMOJYG4 . You are receiving this because you were mentioned.Message ID: @.***>

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 81.25000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 72.10%. Comparing base (a99fd2a) to head (3d8a6ba). Report is 38 commits behind head on master.

Files with missing lines	Patch %	Lines
kwave/utils/filters.py	81.25%	2 Missing and 1 partial :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #445      +/-   ##
==========================================
+ Coverage   72.03%   72.10%   +0.06%     
==========================================
  Files          46       46              
  Lines        6752     6747       -5     
  Branches     1307     1302       -5     
==========================================
+ Hits         4864     4865       +1     
+ Misses       1332     1328       -4     
+ Partials      556      554       -2     

Flag	Coverage Δ
3.10	72.31% <81.25%> (+0.06%)	:arrow_up:
3.11	72.31% <81.25%> (+0.06%)	:arrow_up:
3.12	72.31% <81.25%> (+0.06%)	:arrow_up:
3.9	72.08% <81.25%> (+0.06%)	:arrow_up:
macos-latest	72.04% <81.25%> (+0.06%)	:arrow_up:
ubuntu-latest	72.07% <81.25%> (+0.06%)	:arrow_up:
windows-latest	72.09% <81.25%> (+0.06%)	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[gordon-n-stevenson]

Just a nudge on this PR, checks are passed just needs review

[waltsims]

Hey Gordon thanks for the nudge. I was looking at your PR this morning and will finish soon. Do you mind me making direct changes?

[waltsims]

Hey Gordon,

Thanks again for the PR. I made a decent amount of progress reviewing your PR. I found some issues locally when running it, specifically when evaluating the output of USE_STATISTICS=false and running the Python file directly. I've gotten through most of the edits and can push them directly to your branch if that's ok with you.

Best, Walter

[gordon-n-stevenson]

Great! Please do!

On Mon, 14 Oct 2024, 12:12 pm Walter Simson, @.***> wrote:

Hey Gordon,

I made a decent amount of progress reviewing your PR. I found some issues locally when running it, specifically when evaluating the output of USE_STATISTICS=false and running the Python file directly. I've gotten through most of the edits and can push them directly to your branch if that's ok with you.

Best, Walter

— Reply to this email directly, view it on GitHub https://github.com/waltsims/k-wave-python/pull/445#issuecomment-2409571579, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAOVQKXN6GSZ7HPGQ5TIPQDZ3MLAFAVCNFSM6AAAAABMTQDUR6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBZGU3TCNJXHE . You are receiving this because you were mentioned.Message ID: @.***>

[waltsims]

@gordon-n-stevenson please test my changes

[gordon-n-stevenson]

Hi @waltsims - only got around to testing now, my delightful children made me sick over the last few days.

Running the us_beams_pattern notebook seems to be all working well!!

[waltsims]

Thanks for the PR @gordon-n-stevenson !