Metadata-Version: 2.1
Name: lima1983analysis-sebastian-achim-mueller
Version: 0.0.2
Summary: Sensitivity, Ti-Pei Li and Yu-Qian-Ma, APJ 272:317-324, 1983
Home-page: https://github.com/cherenkov-plenoscope/lima1983analysis
Author: Sebastian Achim Mueller
Author-email: sebastian-achim.mueller@mpi-hd.mpg.de
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Description-Content-Type: text/markdown

Li and Ma, 1983, Estimating Significance
========================================

A python implementation of the equations 9, and 17 proposed by Li and Ma in 1983.
```
@article{lima1983analysis,
  title={Analysis methods for results in gamma-ray astronomy},
  author={Li, Ti-Pei and Ma, Yu-Qian},
  journal={The Astrophysical Journal},
  volume={272},
  pages={317--324},
  year={1983}
}
```
The names of the variables are adopted from Li and Ma.

Significance S
--------------
Estimate the significance ```S``` of a detection.

```python
estimate_S_eq9(N_on, N_off, alpha)
estimate_S_eq17(N_on, N_off, alpha)
```

Signal-Counts N_s
-----------------
Estimate how much signal-counts ```N_s``` are required to claim a detection.

```python
estimate_N_s_eq9(N_off, alpha, S)
estimate_N_s_eq17(N_off, alpha, S, margin=1e-6, max_num_iterations=1000, N_s_start=None)
```


