Commit 92d0c21e17c48eeca6a3dc2e0a4e8d280dc7ef9d
1 parent
43b52cb3
Added a few sentences to the documentation of csspec
Showing
1 changed file
with
10 additions
and
33 deletions
doc/source/reference_manual/csspec.rst
| @@ -17,9 +17,13 @@ model component(s) (hidden parameter ``fix_bkg``). The script computes the | @@ -17,9 +17,13 @@ model component(s) (hidden parameter ``fix_bkg``). The script computes the | ||
| 17 | source flux and its uncertainty in each energy bin, as well as the significance | 17 | source flux and its uncertainty in each energy bin, as well as the significance |
| 18 | of the source detection. Optionally, it also computes an upper flux limit | 18 | of the source detection. Optionally, it also computes an upper flux limit |
| 19 | that is particularily useful in case that the source is not significantly | 19 | that is particularily useful in case that the source is not significantly |
| 20 | -detected within an energy bin (hidden parameter ``calc_ulim``). | ||
| 21 | - | ||
| 22 | -The script works on event lists only. | 20 | +detected within an energy bin (hidden parameter ``calc_ulim``). The script |
| 21 | +works on both, binned and unbinned observation containers. In case of binned input, | ||
| 22 | +the script will determine from the ``enumbins`` parameter, which energy layers | ||
| 23 | +of the input cube will be merged for one spectral bin. Of course, the script | ||
| 24 | +cannot create more spectral bins as available energy bins in the cube. | ||
| 25 | +Also note that for the moment, the Npred column in the output file is not | ||
| 26 | +filled for binned analyses. | ||
| 23 | 27 | ||
| 24 | On output, the script will provide a FITS file with the fitted source | 28 | On output, the script will provide a FITS file with the fitted source |
| 25 | spectrum. | 29 | spectrum. |
| @@ -56,6 +60,9 @@ General parameters | @@ -56,6 +60,9 @@ General parameters | ||
| 56 | ``irf [string]`` | 60 | ``irf [string]`` |
| 57 | Instrumental response function. | 61 | Instrumental response function. |
| 58 | 62 | ||
| 63 | +``(edisp = no) [boolean]`` | ||
| 64 | + Apply energy dispersion to response computation? | ||
| 65 | + | ||
| 59 | ``emin [real]`` | 66 | ``emin [real]`` |
| 60 | Lower energy limit of events (in TeV). | 67 | Lower energy limit of events (in TeV). |
| 61 | 68 | ||
| @@ -68,36 +75,6 @@ General parameters | @@ -68,36 +75,6 @@ General parameters | ||
| 68 | ``(ebinalg = LOG) <FILE|LIN|LOG> [string]`` | 75 | ``(ebinalg = LOG) <FILE|LIN|LOG> [string]`` |
| 69 | Algorithm for defining energy bins. | 76 | Algorithm for defining energy bins. |
| 70 | 77 | ||
| 71 | -``binned [boolean]`` | ||
| 72 | - Specifies whether a binned computation should be used. | ||
| 73 | - | ||
| 74 | -``(nebins = 5) [integer]`` | ||
| 75 | - Number of bins per spectral point for binned analysis. | ||
| 76 | - | ||
| 77 | -``coordsys <CEL|GAL> [string]`` | ||
| 78 | - Coordinate system (CEL - celestial, GAL - galactic). | ||
| 79 | - | ||
| 80 | -``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]`` | ||
| 81 | - Projection method. | ||
| 82 | - | ||
| 83 | -``xref [real]`` | ||
| 84 | - Right Ascension / Galactic longitude of image centre (J2000, in degrees). | ||
| 85 | - | ||
| 86 | -``yref [real]`` | ||
| 87 | - Declination / Galactic latitude of image centre (J2000, in degrees). | ||
| 88 | - | ||
| 89 | -``nxpix [integer]`` | ||
| 90 | - Size of the Right Ascension / Galactic longitude axis (in pixels). | ||
| 91 | - | ||
| 92 | -``nypix [integer]`` | ||
| 93 | - Size of the Declination / Galactic latitude axis (in pixels). | ||
| 94 | - | ||
| 95 | -``binsz [real]`` | ||
| 96 | - Pixel size (in degrees/pixel). | ||
| 97 | - | ||
| 98 | -``(anumbins = 200) [integer]`` | ||
| 99 | - Number of angular separation bins. | ||
| 100 | - | ||
| 101 | ``(calc_ts = yes) [boolean]`` | 78 | ``(calc_ts = yes) [boolean]`` |
| 102 | Compute TS for each spectral point? | 79 | Compute TS for each spectral point? |
| 103 | 80 |