-
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
Accounting for energy overlap in cross spectral products #865
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #865 +/- ##
=======================================
Coverage 96.06% 96.07%
=======================================
Files 48 48
Lines 9714 9723 +9
=======================================
+ Hits 9332 9341 +9
Misses 382 382 ☔ View full report in Codecov by Sentry. |
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.
I think it would be better to specify the formulas used to calculate the errors to guide the user. Regarding the reference or add a link, I leave the choice to you.
stingray/crossspectrum.py
Outdated
def _calculate_errors(self): | ||
"""Calculate the errors on cross powers and lags. | ||
|
||
Uses the formulas from Ingram 2019, MNRAS 489, 392. The attribute ``channels_overlap`` |
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.
Could it be better to indicate the formulas (the ones Matteo Lucchini wrote in the PR) or is it too specific? Also, I remember that in one of the first implementation of Ingram's approach in Stingray, a link to the paper was provided, although here you already put the reference. I leave you the choice to put the link or leave the reference as it is.
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.
The formulas are a little complicated, but I did expand the description and add a link to the paper in the original function and referred to that function here, hope it is more clear now
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.
Yes indeed it is clearer now, better this way. Thank you Matteo
Solving a bug, and taking it as a starting point to resolve #864