Eirik Hatlen / ctools

Commit abedcd6f367e9620fdfc9dbbb0922064f7d369ab

Authored by Luigi Tibaldo
1 parent 2549d836

Polished documentation

Inline Side-by-side
Showing 3 changed files with 12 additions and 4 deletions
cscripts/csphasecrv.par
  View file @abedcd6
@@ -37,8 +37,8 @@ emax, r, a, 100.0,,, "Upper energy limit of events (TeV)" @@ -37,8 +37,8 @@ emax, r, a, 100.0,,, "Upper energy limit of events (TeV)"
37 enumbins, i, a, 0,0,100, "Number of energy bins for binned (0=unbinned for Cube analysis only))" 37 enumbins, i, a, 0,0,100, "Number of energy bins for binned (0=unbinned for Cube analysis only))"
38 coordsys, s, a, CEL,CEL|GAL,, "Coordinate System" 38 coordsys, s, a, CEL,CEL|GAL,, "Coordinate System"
39 proj, s, a, CAR,AIT|AZP|CAR|GLS|MER|MOL|SFL|SIN|STG|TAN,, "Projection method" 39 proj, s, a, CAR,AIT|AZP|CAR|GLS|MER|MOL|SFL|SIN|STG|TAN,, "Projection method"
40 -xref, r, a, 83.63,0,360, "First coordinate of image center in degrees (RA or galactic l)"  
41 -yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DEC or galactic b)" 40 +xref, r, a, 83.63,0,360, "First coordinate of image/source region center in degrees (RA or galactic l)"
  41 +yref, r, a, 22.01,-90,90, "Second coordinate of image/source region center in degrees (DEC or galactic b)"
42 nxpix, i, a, 200,,, "Size of the X axis in pixels" 42 nxpix, i, a, 200,,, "Size of the X axis in pixels"
43 nypix, i, a, 200,,, "Size of the Y axis in pixels" 43 nypix, i, a, 200,,, "Size of the Y axis in pixels"
44 binsz, r, a, 0.02,,, "Pixel size (deg/pixel)" 44 binsz, r, a, 0.02,,, "Pixel size (deg/pixel)"
doc/source/users/reference_manual/cslightcrv.rst
  View file @abedcd6
@@ -69,7 +69,7 @@ General parameters @@ -69,7 +69,7 @@ General parameters
69 ``tbinfile [file]`` 69 ``tbinfile [file]``
70 File defining the time binning. 70 File defining the time binning.
71 71
72 -``method [string]`` 72 +``method <CUBE|ONOFF> [string]``
73 Selects between CUBE analysis (3D spatial/energy likelihood) and ONOFF 73 Selects between CUBE analysis (3D spatial/energy likelihood) and ONOFF
74 analysis (1D likelihood with background from Off regions). 74 analysis (1D likelihood with background from Off regions).
75 75
@@ -103,6 +103,10 @@ General parameters @@ -103,6 +103,10 @@ General parameters
103 ``binsz [real]`` 103 ``binsz [real]``
104 Pixel size for Cube analysis (in degrees/pixel). 104 Pixel size for Cube analysis (in degrees/pixel).
105 105
  106 +``(srcshape = CIRCLE) [string]``
  107 + Shape of the source region.
  108 + ``CIRCLE``: circular region around given position.
  109 +
106 ``rad [real]`` 110 ``rad [real]``
107 Radius of source region circle for On/Off analysis (deg) 111 Radius of source region circle for On/Off analysis (deg)
108 112
doc/source/users/reference_manual/csphasecrv.rst
  View file @abedcd6
@@ -63,7 +63,7 @@ General parameters @@ -63,7 +63,7 @@ General parameters
63 ``phbinfile [file]`` 63 ``phbinfile [file]``
64 File defining the phase binning. 64 File defining the phase binning.
65 65
66 -``method [string]`` 66 +``method <CUBE|ONOFF> [string]``
67 Selects between CUBE analysis (3D spatial/energy likelihood) and ONOFF 67 Selects between CUBE analysis (3D spatial/energy likelihood) and ONOFF
68 analysis (1D likelihood with background from Off regions). 68 analysis (1D likelihood with background from Off regions).
69 69
@@ -97,6 +97,10 @@ General parameters @@ -97,6 +97,10 @@ General parameters
97 ``binsz [real]`` 97 ``binsz [real]``
98 Pixel size (in degrees/pixel). 98 Pixel size (in degrees/pixel).
99 99
  100 +``(srcshape = CIRCLE) [string]``
  101 + Shape of the source region.
  102 + ``CIRCLE``: circular region around given position.
  103 +
100 ``rad [real]`` 104 ``rad [real]``
101 Radius of source region circle for On/Off analysis (deg) 105 Radius of source region circle for On/Off analysis (deg)
102 106