search

TCDSolar / stixpy

STIX data analysis in python
https://stixpy.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
17 stars 20 forks source link

Distinguish between `counts` and `count_rate` in codebase #68

Open hayesla opened 1 year ago

hayesla commented 1 year ago

at the moment throughout the codebase the term counts is used for both counts and count rate (i.e. counts/s/keV). just for simplicity and for future development this should be clarified in codebase and docs

samaloney commented 5 months ago

Borrowing from sunkit-spex https://github.com/sunpy/sunkit-spex/issues/126#issue-1958218931

Moreover, a naming convention is defined for different rate-like values that may exist in the instrument class, and throughout the package, as

"something Rate" refers to something s^-1 "Differential something Rate" refers to something s^-1 keV^-1 "Differential something Flux" refers to something s^-1 keV^-1 cm^-2

So initially I'd suggest to return a dictionary with the relevant name count rate differential count rate, and differential count flux or something or possibly the set some attribute which controls what is returned.