DynamicsAndNeuralSystems / catch22

catch22: CAnonical Time-series CHaracteristics
https://time-series-features.gitbook.io/catch22
GNU General Public License v3.0
364 stars 69 forks source link

Missing `CO_f1ecac` in the overview table #37

Open jhossbach opened 1 month ago

jhossbach commented 1 month ago

Hey, I was looking for a description of the CO_f1ecac feature in the overview table but there doesn't seem to be any mention of that feature. I think it might have existed at some point in time, but I am not sure.

Cheers

benfulcher commented 1 month ago

This has been renamed as first1e_acf_tau or acf_timescale. Please see here for details: https://time-series-features.gitbook.io/catch22/information-about-catch22/feature-descriptions/feature-overview-table

benfulcher commented 1 month ago

Let me know if that deprecated name is still about in the code and we can fix to avoid confusion. Thanks for flagging!

jhossbach commented 1 month ago

Ah, I meant to post this issue on the pycatch22 repo.

There it seems like the normal name was not updated:

>>> features = pycatch22.catch22_all([1,2,3], short_names=True)
>>> "CO_f1ecac" in features["names"]
True
>>> "first1e_acf_tau" in features["names"]
False
>>> "acf_timescale" in features["short_names"]
True

Tested on pycatch22 v0.4.5

benfulcher commented 1 month ago

Ok thanks @jmoo2880 will fix