Iftach Sadeh / ctools

Commit a9a8d129d19bd8cd45f9ec0247535daddc288ab3

Authored by Luigi Tibaldo
1 parent 2124dfc0

documentation

Inline Side-by-side
Showing 3 changed files with 47 additions and 7 deletions
cscripts/cslightcrv.par
  View file @a9a8d12
... ... @@ -39,8 +39,8 @@ emax, r, a, 100.0,,, "Upper energy limit of events (TeV)"
39 39 enumbins, i, a, 0,0,100, "Number of energy bins for binned (0=unbinned for Cube analysis only)"
40 40 coordsys, s, a, CEL,CEL|GAL,, "Coordinate System"
41 41 proj, s, a, CAR,AIT|AZP|CAR|GLS|MER|MOL|SFL|SIN|STG|TAN,, "Projection method"
42   -xref, r, a, 83.63,0,360, "First coordinate of image center in degrees (RA or galactic l)"
43   -yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DEC or galactic b)"
  42 +xref, r, a, 83.63,0,360, "First coordinate of image/source region center in degrees (RA or galactic l)"
  43 +yref, r, a, 22.01,-90,90, "Second coordinate of image/source region center in degrees (DEC or galactic b)"
44 44 nxpix, i, a, 200,,, "Size of the X axis in pixels"
45 45 nypix, i, a, 200,,, "Size of the Y axis in pixels"
46 46 binsz, r, a, 0.02,,, "Pixel size (deg/pixel)"
... ...
doc/source/users/reference_manual/cslightcrv.rst
  View file @a9a8d12
... ... @@ -70,7 +70,7 @@ General parameters
70 70 File defining the time binning.
71 71  
72 72 ``method [string]``
73   - Selects between Cube analysis (3D spatial/energy likelihood) and On/Off
  73 + Selects between CUBE analysis (3D spatial/energy likelihood) and ONOFF
74 74 analysis (1D likelihood with background from Off regions).
75 75  
76 76 ``emin [real]``
... ...
doc/source/users/reference_manual/csphasecrv.rst
  View file @a9a8d12
... ... @@ -10,14 +10,16 @@ Synopsis
10 10 --------
11 11  
12 12 This script computes spectra by performing a maximum likelihood fit using
13   -:doc:`ctlike` in a series of phase bins for pulsars. The phase bins can be
  13 +:doc:`ctlike` in a series of phase bins for periodic sources. The input event
  14 +list must have a ``PHASE`` column containing the phase values, that can be
  15 +assigned using :doc:`ctphase`. The phase bins can be
14 16 either specified in an ASCII file or as an interval divided into equally sized
15 17 phase bins. The format of the ASCII file is one row per phase bin, each
16 18 specifying the start of stop value of the phase bin, separated by a whitespace.
17 19 The phase goes from 0.0 to 1.0.
18 20  
19   -On output the script writes the fitting results into a FITS file. The script
20   -also produces one XML file per phase bin that contains the fitting results for
  21 +The script writes the fit results into a FITS file. The script
  22 +also produces one XML file per phase bin that contains the best-fit model for
21 23 that bin.
22 24  
23 25  
... ... @@ -39,8 +41,14 @@ General parameters
39 41 ``irf [string]``
40 42 Instrumental response function.
41 43  
  44 +``(inexclusion = NONE) [file]``
  45 + Optional FITS file containing a WCS map in the first hdu that defines sky
  46 + regions not to be used for background estimation in On/Off analysis (where
  47 + map value != 0).
  48 +
42 49 ``(edisp = no) [boolean]``
43   - Applies energy dispersion to response computation.
  50 + Applies energy dispersion to response computation (for Cube analysis only,
  51 + energy dispersion is always taken into account in On/Off analysis).
44 52  
45 53 ``outfile [file]``
46 54 Name of the XML output file. The phase interval will be automatically
... ... @@ -55,6 +63,10 @@ General parameters
55 63 ``phbinfile [file]``
56 64 File defining the phase binning.
57 65  
  66 +``method [string]``
  67 + Selects between CUBE analysis (3D spatial/energy likelihood) and ONOFF
  68 + analysis (1D likelihood with background from Off regions).
  69 +
58 70 ``emin [real]``
59 71 Lower energy limit of events (in TeV).
60 72  
... ... @@ -85,6 +97,33 @@ General parameters
85 97 ``binsz [real]``
86 98 Pixel size (in degrees/pixel).
87 99  
  100 +``rad [real]``
  101 + Radius of source region circle for On/Off analysis (deg)
  102 +
  103 +``(bkgmethod = REFLECTED) [string]``
  104 + Method for background estimation in On/Off analysis.
  105 + ``REFLECTED:`` background evaluated in regions with the same shape as
  106 + source region reflected w.r.t. pointing direction for each observation.
  107 +
  108 +``(bkgregmin = 2) [integer]``
  109 + Minimum number of background regions that are required for an observation in
  110 + On/Off analysis. If this number of background regions is not available the observation is
  111 + skipped.
  112 +
  113 +``(maxoffset = 4.0) [real]``
  114 + Maximum offset in degrees of source from camera center to accept the
  115 + observation for On/Off analysis.
  116 +
  117 +``(etruemin = 0.01) [real]``
  118 + Minimum true energy to evaluate instrumental response in On/Off analysis (TeV).
  119 +
  120 +``(etruemax = 0.01) [real]``
  121 + Maximum true energy to evaluate instrumental response in On/Off analysis (TeV).
  122 +
  123 +``(etruebins = 30) [integer]``
  124 + Number of bins per decade for true energy bins to evaluate instrumental
  125 + response in On/Off analysis.
  126 +
88 127 ``(statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]``
89 128 Optimization statistic. ``DEFAULT`` uses the default statistic for all
90 129 observations, which is ``CSTAT`` or the statistic specified in the
... ... @@ -129,4 +168,5 @@ Standard parameters
129 168 Related tools or scripts
130 169 ------------------------
131 170  
  171 +:doc:`ctphase`
132 172 :doc:`ctlike`
... ...