Maintenance

[OverLordGoldDragon]

FEATURES

1. Optional nan_checks

BREAKING

1. ssq_freqs now correctly maps frequencies to corresponding rows of Tx for ssq_cwt, no longer requiring [::-1]
2. extract_ridges: ridge_f (formerly fridge) now returns scales rather than log(scales)
3. extract_ridges: renamed: fridge -> ridge_f, max_energy -> ridge_e

FIXES

1. False warning for t & fs
2. Extended scope of astensor to scales, ssq_freqs
3. visuals: improve xticks & yticks handling
4. Misc

MISC

1. Added How's it work? to README

[codecov-commenter]

Codecov Report

Merging #57 (b45d88b) into master (76e9cab) will decrease coverage by 0.03%. The diff coverage is 87.09%.

@@            Coverage Diff             @@
##           master      #57      +/-   ##
==========================================
- Coverage   92.39%   92.35%   -0.04%     
==========================================
  Files          17       17              
  Lines        3430     3440      +10     
==========================================
+ Hits         3169     3177       +8     
- Misses        261      263       +2     

Impacted Files	Coverage Δ
ssqueezepy/_ssq_stft.py	87.17% <0.00%> (ø)
ssqueezepy/_ssq_cwt.py	92.50% <66.66%> (ø)
ssqueezepy/visuals.py	92.00% <87.50%> (-0.25%)	:arrow_down:
ssqueezepy/_cwt.py	93.68% <100.00%> (ø)
ssqueezepy/ridge_extraction.py	100.00% <100.00%> (ø)
ssqueezepy/ssqueezing.py	93.42% <100.00%> (+0.17%)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 76e9cab...b45d88b. Read the comment docs.

[OverLordGoldDragon]

@DavidBondesson I've renamed vars and changed docs, also made fridge index scales rather than log(scales) for transform='cwt'. I think these are more intuitive to work with. (for some time I thought max_energies was a columnwise argmax)

In interest of time, I'll proceed with the release - let me know if you disagree with any change, will consider for next release.