DavidT3 / XGA

X-ray: Generate and Analyse is a module designed to make the analysis of XMM observations simple and efficient. It provides an interface with SAS for the creation of XMM data products, as well as a way to easily perform fits (scalable for multiple observations) and retrieve information about an object, all within a Python package.
BSD 3-Clause "New" or "Revised" License
29 stars 3 forks source link

Forgot to add the list of choices for inverse abel implementation to the inv_abel_data density function #1188

Closed DavidT3 closed 2 months ago

DavidT3 commented 2 months ago

I need to add the choices in the docstring - along with a disclaimer about the uniform radius sampling.

It would be nice to have a discussion of how the results differ, but I don't really know that yet - and I'm hoping the XCS lot will find that out for me with some more exhaustive testing for their project. Definitely would be worthy of a 'deep-dive' notebook on the XGA documentation website.

I made the choice to not set a default method, to put the choice on to the (hopefully informed) user rather than me, but the docs must play a part in doing the informing.