Iftach Sadeh / ctools

Commit 804d33fb5016c708054db70862572f01aa7bb805

Authored by Luigi Tibaldo
1 parent c723e679

modified reference manual

Inline Side-by-side
Showing 1 changed file with 46 additions and 9 deletions
doc/source/users/reference_manual/cslightcrv.rst
  View file @804d33f
... ... @@ -42,8 +42,14 @@ General parameters
42 42 ``irf [string]``
43 43 Instrumental response function.
44 44  
  45 +``(inexclusion = NONE) [file]``
  46 + Optional FITS file containing a WCS map in the first hdu that defines sky
  47 + regions not to be used for background estimation in On/Off analysis (where
  48 + map value != 0).
  49 +
45 50 ``(edisp = no) [boolean]``
46   - Applies energy dispersion to response computation.
  51 + Applies energy dispersion to response computation (for Cube analysis only,
  52 + energy dispersion is always taken into account in On/Off analysis).
47 53  
48 54 ``outfile [file]``
49 55 Name of the light curve output file.
... ... @@ -63,6 +69,10 @@ General parameters
63 69 ``tbinfile [file]``
64 70 File defining the time binning.
65 71  
  72 +``method [string]``
  73 + Selects between Cube analysis (3D spatial/energy likelihood) and On/Off
  74 + analysis (1D likelihood with background from Off regions).
  75 +
66 76 ``emin [real]``
67 77 Lower energy limit of events (in TeV).
68 78  
... ... @@ -70,7 +80,7 @@ General parameters
70 80 Upper energy limit of events (in TeV).
71 81  
72 82 ``enumbins [integer]``
73   - Number of energy bins per light curve bin (0=unbinned).
  83 + Number of energy bins per light curve bin (0=unbinned for Cube analysis only).
74 84  
75 85 ``coordsys <CEL|GAL> [string]``
76 86 Coordinate system (CEL - celestial, GAL - galactic).
... ... @@ -79,26 +89,53 @@ General parameters
79 89 Projection method.
80 90  
81 91 ``xref [real]``
82   - Right Ascension / Galactic longitude of image centre (J2000, in degrees).
  92 + Right Ascension / Galactic longitude of image/On region centre (J2000, in degrees).
83 93  
84 94 ``yref [real]``
85   - Declination / Galactic latitude of image centre (J2000, in degrees).
  95 + Declination / Galactic latitude of image/On region centre (J2000, in degrees).
86 96  
87 97 ``nxpix [integer]``
88   - Size of the Right Ascension / Galactic longitude axis (in pixels).
  98 + Size of the Right Ascension / Galactic longitude axis for Cube analysis (in pixels).
89 99  
90 100 ``nypix [integer]``
91   - Size of the Declination / Galactic latitude axis (in pixels).
  101 + Size of the Declination / Galactic latitude axis for Cube analysis (in pixels).
92 102  
93 103 ``binsz [real]``
94   - Pixel size (in degrees/pixel).
  104 + Pixel size for Cube analysis (in degrees/pixel).
  105 +
  106 +``rad [real]``
  107 + Radius of source region circle for On/Off analysis (deg)
  108 +
  109 +``(bkgmethod = REFLECTED) [string]``
  110 + Method for background estimation in On/Off analysis.
  111 + ``REFLECTED:`` background evaluated in regions with the same shape as
  112 + source region reflected w.r.t. pointing direction for each observation.
  113 +
  114 +``(bkgregmin = 2) [integer]``
  115 + Minimum number of background regions that are required for an observation in
  116 + On/Off analysis. If this number of background regions is not available the observation is
  117 + skipped.
  118 +
  119 +``(maxoffset = 4.0) [real]``
  120 + Maximum offset in degrees of source from camera center to accept the
  121 + observation for On/Off analysis.
  122 +
  123 +``(etruemin = 0.01) [real]``
  124 + Minimum true energy to evaluate instrumental response in On/Off analysis (TeV).
  125 +
  126 +``(etruemax = 0.01) [real]``
  127 + Maximum true energy to evaluate instrumental response in On/Off analysis (TeV).
  128 +
  129 +``(etruebins = 30) [integer]``
  130 + Number of bins per decade for true energy bins to evaluate instrumental
  131 + response in On/Off analysis.
95 132  
96 133 ``(statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]``
97 134 Optimization statistic. ``DEFAULT`` uses the default statistic for all
98 135 observations, which is ``CSTAT`` or the statistic specified in the
99 136 observation definition XML file. ``CSTAT`` uses the C statistic for
100   - all observations, ``WSTAT`` uses the W statistic for all On/Off
101   - observations, and ``CHI2`` uses the Chi squared statistic for all
  137 + all observations, ``WSTAT`` uses the W statistic (for On/Off
  138 + observations), and ``CHI2`` uses the Chi squared statistic for all
102 139 binned or stacked observations.
103 140  
104 141 ``(calc_ts = yes) [boolean]``
... ...