stingray icon indicating copy to clipboard operation
stingray copied to clipboard

Enhance docs and warnings with distribution compatibility info

Open ankitkhushwaha opened this issue 8 months ago • 2 comments

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.

ankitkhushwaha avatar Apr 09 '25 05:04 ankitkhushwaha

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

Sauravroy34 avatar Apr 09 '25 06:04 Sauravroy34

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.

dhuppenkothen avatar Apr 09 '25 06:04 dhuppenkothen