Skip to content

Enhance docs and warnings with distribution compatibility info #916

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

Open
ankitkhushwaha opened this issue Apr 9, 2025 · 2 comments · May be fixed by #917
Open

Enhance docs and warnings with distribution compatibility info #916

ankitkhushwaha opened this issue Apr 9, 2025 · 2 comments · May be fixed by #917

Comments

@ankitkhushwaha
Copy link
Contributor

ankitkhushwaha commented Apr 9, 2025

Description of the Issue

As mentioned by @dhuppenkothen in comment,

it would be nice addition to add explanation in the docs which methods support which statistical distributions (e.g., Poisson, Gaussian).
This would help users quickly understand which methods are appropriate for their data and reduce confusion.

@Sauravroy34
Copy link
Contributor

I guess it be nice if we add methods to calculate gaussian error as well currently we only calculate for Poisson errors only
https://github.com/StingraySoftware/stingray/blob/main/stingray%2Flightcurve.py#L404-L421

@dhuppenkothen
Copy link
Member

You cannot calculate the Gaussian error, that isn't something you can derive directly from the light curve as you do with the Poisson error, but depends on the instrument used and its characteristics, so has to be supplied by the user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants