-
Notifications
You must be signed in to change notification settings - Fork 192
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
Documentation: Misleading default value in gammapy.estimators.SensitivityEstimator
of spectrum=None
#4659
Labels
Comments
mdpunch
added a commit
to mdpunch/gammapy
that referenced
this issue
Jul 15, 2023
Made a pull request with this... |
registerrier
added a commit
that referenced
this issue
Jul 17, 2023
Change to address Misleading doc for `Sensitivity Estimator` #4659
meeseeksmachine
pushed a commit
to meeseeksmachine/gammapy
that referenced
this issue
Jul 17, 2023
…tivity Estimator` gammapy#4659
meeseeksmachine
pushed a commit
to meeseeksmachine/gammapy
that referenced
this issue
Jul 17, 2023
…tivity Estimator` gammapy#4659
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Gammapy version
gammapy v1.1
Bug description
In the documentation of
gammapy.estimators.SensitivityEstimator
:https://docs.gammapy.org/1.1/api/gammapy.estimators.SensitivityEstimator.html
... the default for
spectrum
is given asNone
But as can be seen in the source code, this becomes:
This might mislead, for the unaware, that the sensitivity could be applied to very soft spectrum sources.
Expected behavior
It would be clearer to specify what the default behaviour for
spectrum
is, e.g. by changingto
(note, some CTA papers have used other assumptions, e.g. https://arxiv.org/pdf/1509.01943.pdf "Real-Time Analysis sensitivity evaluation of the Cherenkov Telescope Array" which has "The MC simulation assumes a source with a power law spectrum and a Crab-like index located at the center of the field of view and observed at a zenith angle of 20 degrees.")
The text was updated successfully, but these errors were encountered: