Rename `framerate` attribute to `sample_frequency`

EIT-ALIVE / eitprocessing

Software for electrical impedance tomography data loading, visualization and processing

https://eit-alive.github.io/eitprocessing/

Apache License 2.0

5 stars 0 forks source link

Rename `framerate` attribute to `sample_frequency` #216

Open psomhorst opened 1 month ago

psomhorst commented 1 month ago

Framerate is a logical name for the sample frequency for EIT data, but not for other types of data. Currently, framerate and sample_frequency are both used. I propose replacing framerate with sample_frequency.

We can provide a temporary DeprecationWarning by creating a framerate property, and remove it in a later version.

DaniBodor commented 1 month ago

I think that seeing as we don't have external users yet and we don't have a release yet, a DeprecationWarning isn't required. Just make sure that when you make this change to tag @wbaccinelli, so that the dashboard can be updated as well.