Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow Waveform Mode FM in Calibrate API #1363

Merged
merged 3 commits into from
Jul 19, 2024

Conversation

ctuguinay
Copy link
Collaborator

Addresses #1334

This was the easiest way I could envision allowing FM. Otherwise, I would've reviewed all the calibrate code and added FM there. What are your thoughts @leewujung?

@ctuguinay ctuguinay self-assigned this Jul 18, 2024
@ctuguinay ctuguinay added this to the v0.9.0 milestone Jul 18, 2024
@ctuguinay ctuguinay linked an issue Jul 18, 2024 that may be closed by this pull request
@ctuguinay ctuguinay marked this pull request as ready for review July 18, 2024 01:04
@ctuguinay ctuguinay requested a review from leewujung July 18, 2024 01:07
@codecov-commenter
Copy link

codecov-commenter commented Jul 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.52%. Comparing base (9f56124) to head (1b55517).
Report is 129 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1363      +/-   ##
==========================================
+ Coverage   83.52%   89.52%   +6.00%     
==========================================
  Files          64       11      -53     
  Lines        5686     1002    -4684     
==========================================
- Hits         4749      897    -3852     
+ Misses        937      105     -832     
Flag Coverage Δ
unittests 89.52% <100.00%> (+6.00%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leewujung
Copy link
Member

Yeah I agree with this approach. Just much easier to implement.

The only suggestion I have is to do the following right at the top of _compute_cal, then we don't need to change the arguments. This also makes our intension clear:

# Make waveform_mode "FM" equivalent to "BB"
waveform_mode = "BB" if waveform_mode == "FM" else waveform_mode

@ctuguinay
Copy link
Collaborator Author

@leewujung Thanks! I added your suggestion. This should be ready for another quick review.

Copy link
Member

@leewujung leewujung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ctuguinay ctuguinay merged commit be5398b into OSOceanAcoustics:main Jul 19, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add "FM" to an allowable option for waveform_mode
3 participants