search

OSOceanAcoustics / echopype

Enabling interoperability and scalability in ocean sonar data analysis
https://echopype.readthedocs.io/
Apache License 2.0
96 stars 72 forks source link

Overhaul AZFP `Environment` group #1226

Closed emiliom closed 10 months ago

emiliom commented 10 months ago

Fully addresses #1225.

I'm not aware of a source of data to populate the absorption_indicative & sound_speed_indicative variables, so I'm simply filling them with np.nan. @leewujung do you know if there's something in the AZFP raw data & XML that could be used? If there isn't, or it's not straightforward, I suggest leaving the variables in with np.nan; after all, the variables were not present before this PR :sweat_smile:

codecov-commenter commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (71f0250) 83.44% compared to head (14155b1) 77.96%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #1226 +/- ## ========================================== - Coverage 83.44% 77.96% -5.49% ========================================== Files 64 16 -48 Lines 5672 2632 -3040 ========================================== - Hits 4733 2052 -2681 + Misses 939 580 -359 ``` | [Flag](https://app.codecov.io/gh/OSOceanAcoustics/echopype/pull/1226/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OSOceanAcoustics) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/OSOceanAcoustics/echopype/pull/1226/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OSOceanAcoustics) | `77.96% <100.00%> (-5.49%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OSOceanAcoustics#carryforward-flags-in-the-pull-request-comment) to find out more.

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

emiliom commented 10 months ago

And yeah, absorption_indicative and sound_speed_indicative need to be calculated for AZFP for calibrating the data.

Ah. Maybe in the next release, the calculation of those parameters can be moved to open_raw, if appropriate.

I'll merge the PR now. Thanks!