Michael Mayer / ctools

Commit 9c0d5da86883c989d752fdaee019aa70882a8b63

Authored by Jürgen Knödlseder
1 parent 73586a8d

Update documentation

Inline Side-by-side
Showing 1 changed file with 47 additions and 9 deletions
doc/source/reference_manual/csobsdef.rst
  View file @9c0d5da
... ... @@ -9,7 +9,45 @@ Generates an observation definition file.
9 9 Synopsis
10 10 --------
11 11  
12   -Generates an observation definition file.
  12 +The csobsdef script generates an observation definition file from
  13 +a pointing list. The pointing list is a colon separated value ASCII
  14 +file with header keywords in the first row followed by a list of
  15 +pointings (one pointing per row). The following header keywords
  16 +are supported (case sensitive, column order irrelevant):
  17 +
  18 +* name - Observation name string
  19 +* id - Unique observation identifier string
  20 +* ra - Right Ascension of pointing (deg)
  21 +* dec - Declination of pointing (deg)
  22 +* lon - Galactic longitude of pointing (deg)
  23 +* lat - Galactic latitude of pointing (deg)
  24 +* duration - Duration of pointing (seconds)
  25 +* emin - Lower energy limit (TeV)
  26 +* emax - Upper energy limit (TeV)
  27 +* rad - Radius of region of interest (deg)
  28 +* deadc - Deadtime correction factor [0-1]
  29 +* caldb - Calibration database
  30 +* irf - Response function name
  31 +
  32 +Only the pairs (ra,dec) or (lon,lat) are mandatory header keywords.
  33 +All other keywords are optional and can be specified when calling
  34 +csobsdef as user parameters. The only exception is the "duration"
  35 +keyword that will automatically queried.
  36 +
  37 +Here some usage examples:
  38 +
  39 +``csobsdef``
  40 + Creates minimal observation definition file.
  41 +
  42 +``csobsdef emin=0.1 emax=100.0``
  43 + Creates observation definition file with an energy range 100 GeV - 100 TeV.
  44 +
  45 +``csobsdef rad=5``
  46 + Creates observation definition file with a ROI radius of 5 deg.
  47 +
  48 +``csobsdef caldb=dummy irf=cta_dummy_irf``
  49 + Creates observation definition file using the "cta_dummy_irf" IRF in the
  50 + "dummy" calibration database.
13 51  
14 52  
15 53 General parameters
... ... @@ -21,22 +59,22 @@ General parameters
21 59 ``outobs [file]``
22 60 Output Observation Definition XML file.
23 61  
24   -``caldb [string]``
  62 +``duration [real]``
  63 + Duration of observation (in seconds).
  64 +
  65 +``(caldb = "") [string]``
25 66 Calibration database.
26 67  
27   -``irf [string]``
  68 +``(irf = "") [string]``
28 69 Instrumental response function.
29 70  
30   -``emin [real]``
  71 +``(emin = UNDEF) [real]``
31 72 Lower energy limit of events (in TeV).
32 73  
33   -``emax [real]``
  74 +``(emax = UNDEF) [real]``
34 75 Upper energy limit of events (in TeV).
35 76  
36   -``duration [real]``
37   - Duration of observation (in seconds).
38   -
39   -``rad [real]``
  77 +``(rad = UNDEF) [real]``
40 78 ROI radius (in degrees).
41 79  
42 80 ``(deadc = 0.95) [real]``
... ...