Fix issue 235 #236

kkappler · 2024-12-23T20:07:42Z

Factored a TimeSeriesDecimation metadata class out of both FCDecimation and AuroraDecimationLevel. This will help future updates disambiguate the term decimation and is a general step towards adding Spectrogram capabilities into MTH5.

minor updates to nomenclateure and doc (Channel renamed to FCChannel to disambiguate from time series Channel)

- this will help disambiguate from time series Channel objects - minor updates to doc strings - remove an unneeded return None

- Add some typehinting for DecimationLevel - working on finding if we can delete Decimation class

- once correctly dtyped, circular imports were encountered. - this was fixed by creating frequency_bands.py - also add FrequencyBands to __init__.py - alphabetize imports in __init__.py

codecov-commenter · 2024-12-24T00:18:54Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 90.84967% with 14 lines in your changes missing coverage. Please review.

Project coverage is 84.94%. Comparing base (ba2323e) to head (083e2aa).
Report is 35 commits behind head on patches.

Files with missing lines	Patch %	Lines
...fer_functions/processing/aurora/frequency_bands.py	82.85%	6 Missing ⚠️
...ions/processing/fourier_coefficients/decimation.py	92.00%	4 Missing ⚠️
...er_functions/processing/aurora/decimation_level.py	85.00%	3 Missing ⚠️
tests/tf/processing/test_time_series_decimation.py	90.90%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##           patches     #236      +/-   ##
===========================================
- Coverage    84.98%   84.94%   -0.04%     
===========================================
  Files          270      273       +3     
  Lines        20515    20378     -137     
===========================================
- Hits         17435    17311     -124     
+ Misses        3080     3067      -13

Flag	Coverage Δ
tests	`84.94% <90.84%> (-0.04%)`	⬇️

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.

- move get_fft_harmonics into window.py from decimation_level.py - add fft_harmonics method to Window and replace other imports and usages

- try to group the decimation-related attributes together at the top, and the STFT related attrs at the bottom

- this may not be needed and this json is slated for deletion, but until ready to delete this keeps the dual decimation classes close

- this is one of two main replacements that needs to be done on #235 - the next main replacement will be in FCDecimation

- towards #235

- add pass-through getters and setters for decimation_level and decimation_factor, - allowing FCDecimation to assing/access via self.time_series_decimation - remove attrs decimation_level and decimation_factor from fc decimation.json - update attrs in time_series_decimation.json

- also alphabetize imports

…hod (get/set)

…c.method (get/set)

…method

- replace with a property in DecimationLevel that accesses TimeSeriesDecimation attribute.

…e in test

kkappler · 2024-12-28T00:38:16Z

@kujaku11 This is ready for review. I cannot test aurora on github by changing the mt_metadata branch, but tests are passing locally for this. Also not sure how to test mth5 against this branch, but the integrated tests pass locally.

- remove some cruft - add TODO and some doc

kkappler added 6 commits December 23, 2024 12:04

add doc

6da352a

rename Channel to FCChannel

7293673

- this will help disambiguate from time series Channel objects - minor updates to doc strings - remove an unneeded return None

Clarify dtypes and add doc

9046ba1

- Add some typehinting for DecimationLevel - working on finding if we can delete Decimation class

change relative import to full path

e2e87ea

Factoring FrequencyBands out of bands.py

e476a9d

- once correctly dtyped, circular imports were encountered. - this was fixed by creating frequency_bands.py - also add FrequencyBands to __init__.py - alphabetize imports in __init__.py

add new module

5b5ad0e

kkappler mentioned this pull request Dec 23, 2024

MTH5 Spectrogram Housekeeping simpeg/aurora#364

Open

10 tasks

kkappler added 5 commits December 23, 2024 15:43

update typehints and doc

666e294

use class method instead of redefine

d7cf995

correction to function name

823d28c

fix circular imports

8ed6e89

add typehint

fffef24

kkappler added 17 commits December 23, 2024 16:36

workaround circular import FCDecimation

b4db984

workaround circular import FCDecimation

4c78703

doc

8f84256

partial circular import fix

6086b4e

Factoring / circular import fix

10d453e

- move get_fft_harmonics into window.py from decimation_level.py - add fft_harmonics method to Window and replace other imports and usages

Reorder the decimation.json

7662790

- try to group the decimation-related attributes together at the top, and the STFT related attrs at the bottom

Add a "decimation_method" attr to decimation.json

40857af

Add strawman TimeSeriesDecimation

3627e01

add init to standards

452a156

update new standards file in MANIFEST.in

cbcfc26

comment out temporary workaround attrs for now

76ecf27

import TSDecimation in __init__

dfa4495

Add placeholder AAF to decimation

ab2aa63

- this may not be needed and this json is slated for deletion, but until ready to delete this keeps the dual decimation classes close

Replace Decimation with TSDecimation in DecimationLevel

b46cae3

- this is one of two main replacements that needs to be done on #235 - the next main replacement will be in FCDecimation

Add doc and placeholders for TSDecimation

05a568a

Remove old aurora/decimation.Decimation (to replace with TSDecimation)

cadda69

- towards #235

Add TimeSeriesDecimation attribute to FCDecimation

9050064

kkappler added 12 commits December 26, 2024 15:51

add doc and TODOs

49fff56

add TODO

a5d80ff

Add deprecation logger warning to FCDecimation.factor

ce68ab2

- also alphabetize imports

replace decimation_method in FCdec json with passthrough to TSDec.met…

75b172a

…hod (get/set)

replace aaf in FCdec json with passthrough to TSDec.method (get/set)

083e2aa

replace sample_rate_decimation in FCdec json with passthrough to TSDe…

1ae7c04

…c.method (get/set)

fix bug (add note to differentiate between FFT method and decimation …

c3cb461

…method

minor changes to doc

eda5394

remove anti_alias_filter from decimation_level.json

24ef32c

- replace with a property in DecimationLevel that accesses TimeSeriesDecimation attribute.

replace sample_rate_decimation with time_series_decimation.sample_rat…

45c75a3

…e in test

replace sample_rate_decimation with time_series_decimation.sample_rat…

b700f84

…e in test

kkappler marked this pull request as ready for review December 28, 2024 00:36

kkappler requested a review from kujaku11 December 28, 2024 00:36

housekeeping

b595379

- remove some cruft - add TODO and some doc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix issue 235 #236

Fix issue 235 #236

kkappler commented Dec 23, 2024 •

edited

Loading

codecov-commenter commented Dec 24, 2024 •

edited

Loading

kkappler commented Dec 28, 2024

Fix issue 235 #236

Are you sure you want to change the base?

Fix issue 235 #236

Conversation

kkappler commented Dec 23, 2024 • edited Loading

codecov-commenter commented Dec 24, 2024 • edited Loading

Codecov Report

kkappler commented Dec 28, 2024

kkappler commented Dec 23, 2024 •

edited

Loading

codecov-commenter commented Dec 24, 2024 •

edited

Loading