-
Notifications
You must be signed in to change notification settings - Fork 145
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fits event lists #834
Fits event lists #834
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #834 +/- ##
===========================================
- Coverage 96.11% 79.52% -16.59%
===========================================
Files 48 48
Lines 9371 9667 +296
===========================================
- Hits 9007 7688 -1319
- Misses 364 1979 +1615 ☔ View full report in Codecov by Sentry. |
680db3f
to
0b197e8
Compare
196405f
to
d6c8782
Compare
f8fe13b
to
888aee1
Compare
Accept file names instead of hdulist Allow for shorter exposure cuts than GTIs
Additional Inference of format for fits formats
888aee1
to
8fb4213
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than the obvious requiring docstrings, I think this kind of class in general desperately needs better documentation/notebooks because without it, it is hard for me to look more carefully into what the code is doing/supposed to do.
It would also help users in understanding how to handle event files more easily, I worry that most users (my past self included) will just look at the notebooks and think "I can throw in an event file when I need my timing data and it'll be fine".
@matteolucchini1 thanks for the review! I will work on the API docs, I do realize now that I could have done much better 😅 . I'm just not sure about notebooks or user-facing documentation: this is a function that is more for internal use in the library, something to speed up the loading of small parts of big files. |
@matteobachetti Ah fair enough. I do still think it would be nice to show different ways of loading event files (e.g. here's what happens when you load an heasoft-compatible file, or a generic fits file like in this PR, or whatever other source is supported), but maybe a bunch of that is beyond the scope of the PR. I'll try to dig into the code between today and early next week! |
@matteolucchini1 I wrote a small motivation tutorial here: StingraySoftware/notebooks#107 |
I really like that tutorial! I left a couple more minor comments otherwise it's getting close :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No more comments! Just conflicts that need resolving now
…nto fits_event_lists
28f2479
Introduces a new FITS reader class, that lazy loads the data until a slice is required (in which case, the wanted StingrayTimeseries object is created).