Commit 0279112062d0b07008d428c6ad2cde834bdef1a5
1 parent
18e3d77f
Update reference manual documentation.
Showing
13 changed files
with
86 additions
and
34 deletions
doc/source/reference_manual/cscaldb.rst
| 1 | -.. _cscaldb: cscaldb ======= Dumps all available instrument response functions into log file. Synopsis -------- This scripts dumps all instrument response functions that are available in the calibration database into the log file. If you want the information on the screen, add the ``debug=yes`` parameter. General parameters ------------------ None Standard parameters ------------------- ``(chatter = 2) [integer]`` Verbosity of the executable: chatter = 0: no information will be logged chatter = 1: only errors will be logged chatter = 2: errors and actions will be logged chatter = 3: report about the task execution chatter = 4: detailed report about the task execution ``(clobber = yes) [boolean]`` Specifies whether an existing output counts cube should be overwritten. ``(debug = no) [boolean]`` Enables debug mode. In debug mode the executable will dump any log file output to the console. ``(mode = ql) [string]`` Mode of automatic parameters (default is "ql", i.e. "query and learn"). Related tools ------------- None | |
| 2 | 1 | \ No newline at end of file |
| 2 | +.. _cscaldb: cscaldb ======= Dumps all available instrument response functions into log file. Synopsis -------- This scripts dumps all instrument response functions that are available in the calibration database into the log file. If you want the information on the screen, add the ``debug=yes`` parameter. General parameters ------------------ None Standard parameters ------------------- ``(chatter = 2) [integer]`` Verbosity of the executable: chatter = 0: no information will be logged chatter = 1: only errors will be logged chatter = 2: errors and actions will be logged chatter = 3: report about the task execution chatter = 4: detailed report about the task execution ``(clobber = yes) [boolean]`` Specifies whether an existing output counts cube should be overwritten. ``(debug = no) [boolean]`` Enables debug mode. In debug mode the executable will dump any log file output to the console. ``(mode = ql) [string]`` Mode of automatic parameters (default is "ql", i.e. "query and learn"). Related tools or scripts ------------------------ None | |
| 3 | 3 | \ No newline at end of file | ... | ... |
doc/source/reference_manual/ctbin.rst
doc/source/reference_manual/ctbkgcube.rst
doc/source/reference_manual/ctbutterfly.rst
doc/source/reference_manual/ctcubemask.rst
doc/source/reference_manual/cterror.rst
doc/source/reference_manual/ctexpcube.rst
doc/source/reference_manual/ctlike.rst
doc/source/reference_manual/ctmodel.rst
doc/source/reference_manual/ctobssim.rst
| ... | ... | @@ -3,14 +3,39 @@ |
| 3 | 3 | ctobssim |
| 4 | 4 | ======== |
| 5 | 5 | |
| 6 | -Simulates CTA events. | |
| 6 | +Simulate event list(s). | |
| 7 | 7 | |
| 8 | 8 | |
| 9 | 9 | Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | -Generate photon events from astrophysical sources and background events | |
| 13 | -from an instrumental background model. | |
| 12 | +This tool simulates event list(s) using the instrument characteristics | |
| 13 | +specified by the instrument response function(s) and an input model. The | |
| 14 | +simulation includes photon events from astrophysical sources and background | |
| 15 | +events from an instrumental background model. | |
| 16 | + | |
| 17 | +By default, ctobssim creates a single event list. ctobssim queries a pointing | |
| 18 | +direction, the radius of the simulation region, a time interval, an energy | |
| 19 | +interval, an instrumental response function, and an input model. ctobssim uses | |
| 20 | +a numerical random number generator for the simulations with a seed value | |
| 21 | +provided by the hidden ``seed`` parameter. Changing this parameter for | |
| 22 | +subsequent runs will lead to different event samples. | |
| 23 | + | |
| 24 | +ctobssim performs a safety check on the maximum photon rate for all model | |
| 25 | +components to avoid that the tool locks up and requests huge memory | |
| 26 | +ressources, which may happen if a mistake was made in setting up the input | |
| 27 | +model (for example if an error in the flux units is made). The maximum allowed | |
| 28 | +photon rate is controlled by the hidden ``maxrate`` parameter, which by default | |
| 29 | +is set to 1e6. | |
| 30 | + | |
| 31 | +ctobssim can also generate multiple event lists if an observation definition | |
| 32 | +file is specified on input using the hidden ``inobs`` parameter. In that | |
| 33 | +case, simulation information will be gathered from the file, and for each | |
| 34 | +observation an event list will be created. | |
| 35 | + | |
| 36 | +For each event file, the simulation parameters will be written as data | |
| 37 | +selection keywords to the FITS header. These keywords are mandatory for any | |
| 38 | +unbinned maximum likelihood analysis of the event data. | |
| 14 | 39 | |
| 15 | 40 | |
| 16 | 41 | General parameters |
| ... | ... | @@ -106,7 +131,7 @@ Standard parameters |
| 106 | 131 | Name of log file. |
| 107 | 132 | |
| 108 | 133 | |
| 109 | -Related tools | |
| 110 | -------------- | |
| 134 | +Related tools or scripts | |
| 135 | +------------------------ | |
| 111 | 136 | |
| 112 | -None | |
| 137 | +:doc:`csobsdef` | ... | ... |
doc/source/reference_manual/ctpsfcube.rst
doc/source/reference_manual/ctselect.rst
| ... | ... | @@ -3,14 +3,36 @@ |
| 3 | 3 | ctselect |
| 4 | 4 | ======== |
| 5 | 5 | |
| 6 | -Performs sub-selections of event data. | |
| 6 | +Select events from event list(s). | |
| 7 | 7 | |
| 8 | 8 | |
| 9 | 9 | Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | -Creates a new FITS file of selected events from an input event list based | |
| 13 | -on spatial, temporal, and energy cuts. | |
| 12 | +This tool selects events from one or several event lists. Event selection | |
| 13 | +is based on a circular acceptance region, a time interval and an energy | |
| 14 | +interval. In addition, any expression following the cfitsio syntax can be | |
| 15 | +used for event selection. | |
| 16 | + | |
| 17 | +Optionally, ctselect may also apply energy thresholds. If ``usethres=DEFAULT`` | |
| 18 | +is specified, ctselect will extract any save thresholds from the instrument | |
| 19 | +response functions, and if they exist, will apply them to the respective | |
| 20 | +event list. Alternatively, if ``usethres=USER`` is specified, ctselect will | |
| 21 | +extract any user thresholds from the observation definition file (attributes | |
| 22 | +``emin`` and ``emax``), and if either of the attributes exists, will apply | |
| 23 | +them to the respective event list. | |
| 24 | + | |
| 25 | +If an event list is provided on input, ctselect creates a new FITS file on | |
| 26 | +output that contains only the selected events. In case that an observation | |
| 27 | +definition file is specified on input, ctselect creates for each event file | |
| 28 | +referenced in the observation definition file a new FITS file with the value | |
| 29 | +of ``prefix`` prepended to the file name that contains only the selected | |
| 30 | +events. In addition, a new observation definition file will be written | |
| 31 | +that references the new FITS files. | |
| 32 | + | |
| 33 | +For each event file, the event selection parameters will be writted as data | |
| 34 | +selection keywords to the FITS header. These keywords are mandatory for any | |
| 35 | +unbinned maximum likelihood analysis of the event data. | |
| 14 | 36 | |
| 15 | 37 | |
| 16 | 38 | General parameters |
| ... | ... | @@ -98,7 +120,7 @@ Standard parameters |
| 98 | 120 | Name of log file. |
| 99 | 121 | |
| 100 | 122 | |
| 101 | -Related tools | |
| 102 | -------------- | |
| 123 | +Related tools or scripts | |
| 124 | +------------------------ | |
| 103 | 125 | |
| 104 | 126 | None | ... | ... |
doc/source/reference_manual/ctskymap.rst
| ... | ... | @@ -3,13 +3,18 @@ |
| 3 | 3 | ctskymap |
| 4 | 4 | ======== |
| 5 | 5 | |
| 6 | -Computes sky map from CTA data. | |
| 6 | +Generate sky map from event list(s). | |
| 7 | 7 | |
| 8 | 8 | |
| 9 | 9 | Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | -This tool generates a sky map from CTA data. | |
| 12 | +This tool creates a sky map from either a single event list or event lists | |
| 13 | +provided in an observation definition file. The tool will loop over all event | |
| 14 | +lists that are provided and fill all events into a single sky map. Only events | |
| 15 | +within an energy interval spanned by ``emin`` and ``emax`` are considered. | |
| 16 | + | |
| 17 | +ctskymap generates a FITS file comprising a sky map as primary extension. | |
| 13 | 18 | |
| 14 | 19 | |
| 15 | 20 | General parameters |
| ... | ... | @@ -80,7 +85,7 @@ Standard parameters |
| 80 | 85 | Name of log file. |
| 81 | 86 | |
| 82 | 87 | |
| 83 | -Related tools | |
| 84 | -------------- | |
| 88 | +Related tools or scripts | |
| 89 | +------------------------ | |
| 85 | 90 | |
| 86 | 91 | None | ... | ... |