Marianne Lemoine / ctools

Commit 8c02499b187704c584552a134d0bfccdde3aa822

Authored by Jürgen Knödlseder
1 parent 3faa2702

Update reference manual for csresmap to reflect actual parameters.

Inline Side-by-side
Showing 1 changed file with 30 additions and 15 deletions
doc/source/reference_manual/csresmap.rst
  View file @8c02499
@@ -31,18 +31,33 @@ General parameters @@ -31,18 +31,33 @@ General parameters
31 ``inobs [file]`` 31 ``inobs [file]``
32 Input event list, counts cube or observation definition XML file. 32 Input event list, counts cube or observation definition XML file.
33 33
  34 +``modcube [file]``
  35 + Input model cube file (generated with ctmodel).
  36 +
  37 +``expcube [file]``
  38 + Input exposure cube file (only needed for stacked analysis).
  39 +
  40 +``psfcube [file]``
  41 + Input PSF cube file (only needed for stacked analysis).
  42 +
  43 +``bkgcube [file]``
  44 + Input background cube file (only needed for stacked analysis).
  45 +
34 ``inmodel [file]`` 46 ``inmodel [file]``
35 Input model XML file. 47 Input model XML file.
36 48
37 -``outmap [file]``  
38 - Output residual counts map file.  
39 -  
40 ``caldb [string]`` 49 ``caldb [string]``
41 Calibration database. 50 Calibration database.
42 51
43 ``irf [string]`` 52 ``irf [string]``
44 Instrument response function. 53 Instrument response function.
45 54
  55 +``(edisp = no) [boolean]``
  56 + Apply energy dispersion?
  57 +
  58 +``outmap [file]``
  59 + Output residual counts map file.
  60 +
46 ``(ebinalg = LOG) <FILE|LIN|LOG> [string]`` 61 ``(ebinalg = LOG) <FILE|LIN|LOG> [string]``
47 Algorithm for defining energy bins. 62 Algorithm for defining energy bins.
48 63
@@ -58,27 +73,27 @@ General parameters @@ -58,27 +73,27 @@ General parameters
58 ``(ebinfile = NONE) [file]`` 73 ``(ebinfile = NONE) [file]``
59 Name of the file containing the energy bin definition. 74 Name of the file containing the energy bin definition.
60 75
61 -``nxpix [integer]``  
62 - Number of cube bins in Right Ascension or Galactic longitude.  
63 -  
64 -``nypix [integer]``  
65 - Number of cube bins in Declination or Galactic latitude.  
66 -  
67 -``binsz [real]``  
68 - Cube bin size (in degrees/pixel).  
69 -  
70 ``coordsys <CEL|GAL> [string]`` 76 ``coordsys <CEL|GAL> [string]``
71 Coordinate system (CEL - celestial, GAL - galactic). 77 Coordinate system (CEL - celestial, GAL - galactic).
72 78
  79 +``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
  80 + Projection method.
  81 +
73 ``xref [real]`` 82 ``xref [real]``
74 Right Ascension / Galactic longitude of cube centre (J2000, in degrees). 83 Right Ascension / Galactic longitude of cube centre (J2000, in degrees).
75 84
76 ``yref [real]`` 85 ``yref [real]``
77 Declination / Galactic latitude of cube centre (J2000, in degrees). 86 Declination / Galactic latitude of cube centre (J2000, in degrees).
78 87
79 -``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``  
80 - Projection method.  
81 - 88 +``nxpix [integer]``
  89 + Number of cube bins in Right Ascension or Galactic longitude.
  90 +
  91 +``nypix [integer]``
  92 + Number of cube bins in Declination or Galactic latitude.
  93 +
  94 +``binsz [real]``
  95 + Cube bin size (in degrees/pixel).
  96 +
82 ``(algorithm = SUBDIV) <SUB|SUBDIV|SUBDIVSQRT> [string]`` 97 ``(algorithm = SUBDIV) <SUB|SUBDIV|SUBDIVSQRT> [string]``
83 Algorithm used to generate the residual map. 98 Algorithm used to generate the residual map.
84 99