k-wave-python icon indicating copy to clipboard operation
k-wave-python copied to clipboard

Extend HDF5 compression options

Open djps opened this issue 1 year ago • 3 comments

Closes #236 by expanding the hdf5 compression options to include lzf and also szip in addition to the standard gzip default options (which are integers for the compression level). As such the variable is renamed from compression_level to compression_option.

  • The default compression option in get_h5_literals is changed to 4 to match that of the h5py library.
  • As the matlab function h5create can not write with lzf compression a test is created in h5io_test
  • szip is not tested as it must be installed separately.

djps avatar Feb 27 '24 10:02 djps

Codecov Report

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

Project coverage is 67.50%. Comparing base (d8f56f3) to head (4b1a563).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #332      +/-   ##
==========================================
+ Coverage   67.42%   67.50%   +0.08%     
==========================================
  Files          48       48              
  Lines        7024     7036      +12     
  Branches     1596     1595       -1     
==========================================
+ Hits         4736     4750      +14     
+ Misses       1700     1699       -1     
+ Partials      588      587       -1     
Flag Coverage Δ
3.10 67.66% <100.00%> (+0.08%) :arrow_up:
3.11 67.66% <100.00%> (+0.08%) :arrow_up:
3.12 67.66% <100.00%> (+0.08%) :arrow_up:
3.9 67.48% <100.00%> (+0.08%) :arrow_up:
ubuntu-latest 67.45% <100.00%> (+0.08%) :arrow_up:
windows-latest 67.45% <100.00%> (+0.08%) :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.

codecov[bot] avatar Feb 27 '24 10:02 codecov[bot]

I think this is a great start, but still needs some work before being merged in.

waltsims avatar Feb 27 '24 18:02 waltsims

May investigate additional options such as

  • shuffle details for speed-up in available compression options.
  • checksums details
  • scaleoffset for saving large datasets of indices such as p_source_index: details

djps avatar Mar 06 '24 10:03 djps