Johan Bregeon / ctools

Commit ad72820d94325168d50547bf0959478cf5e33157

Authored by Jürgen Knödlseder
1 parent 8183808c

Remove default values for automatic parameters.

Inline Side-by-side
Showing 9 changed files with 127 additions and 127 deletions
doc/source/reference_manual/ctbin.rst
  View file @ad72820
... ... @@ -21,49 +21,49 @@ provided on input, the tool will stack all data into a single counts cube.
21 21 General parameters
22 22 ------------------
23 23  
24   -``inobs = events.fits [file]``
  24 +``inobs [file]``
25 25 Input event list or observation definition XML file.
26 26  
27   -``outcube = cntcube.fits [file]``
  27 +``outcube [file]``
28 28 Output counts cube file.
29 29  
30   -``ebinalg = LOG <FILE|LIN|LOG> [string]``
  30 +``ebinalg <FILE|LIN|LOG> [string]``
31 31 Algorithm for defining energy bins.
32 32  
33   -``emin = 0.1 [real]``
  33 +``emin [real]``
34 34 Lower energy value for first energy bin (in TeV).
35 35  
36   -``emax = 100.0 [real]``
  36 +``emax [real]``
37 37 Upper energy value for last energy bin (in TeV).
38 38  
39   -``enumbins = 20 [integer]``
  39 +``enumbins [integer]``
40 40 Number of energy bins.
41 41  
42   -``ebinfile = NONE [file]``
  42 +``ebinfile [file]``
43 43 Name of the file containing the energy bin definition.
44 44  
45 45 ``(usepnt = no) [boolean]``
46 46 Use CTA pointing direction for cube centre instead of xref/yref parameters?
47 47  
48   -``nxpix = 200 [integer]``
  48 +``nxpix [integer]``
49 49 Number of cube bins in Right Ascension or Galactic longitude.
50 50  
51   -``nypix = 200 [integer]``
  51 +``nypix [integer]``
52 52 Number of cube bins in Declination or Galactic latitude.
53 53  
54   -``binsz = 0.02 [real]``
  54 +``binsz [real]``
55 55 Cube bin size (in degrees/pixel).
56 56  
57   -``coordsys = CEL <CEL|GAL> [string]``
  57 +``coordsys <CEL|GAL> [string]``
58 58 Coordinate system (CEL - celestial, GAL - galactic).
59 59  
60   -``xref = 83.63 [real]``
  60 +``xref [real]``
61 61 Right Ascension / Galactic longitude of cube centre (J2000, in degrees).
62 62  
63   -``yref = 22.01 [real]``
  63 +``yref [real]``
64 64 Declination / Galactic latitude of cube centre (J2000, in degrees).
65 65  
66   -``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
  66 +``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
67 67 Projection method.
68 68  
69 69  
... ...
doc/source/reference_manual/ctbkgcube.rst
  View file @ad72820
... ... @@ -16,61 +16,61 @@ likelihood analysis.
16 16 General parameters
17 17 ------------------
18 18  
19   -``inobs = NONE [file]``
  19 +``inobs [file]``
20 20 Input event list, cube or observation definition XML file.
21 21  
22   -``inmodel = NONE [file]``
  22 +``inmodel [file]``
23 23 Input (background) model XML file.
24 24  
25   -``incube = NONE [file]``
  25 +``incube [file]``
26 26 Counts cube for background cube definition.
27 27  
28   -``outcube = bkgcube.fits [file]``
  28 +``outcube [file]``
29 29 Output background cube file.
30 30  
31   -``caldb = dummy [string]``
  31 +``caldb [string]``
32 32 Calibration database.
33 33  
34   -``irf = cta_dummy_irf [string]``
  34 +``irf [string]``
35 35 Response function.
36 36  
37   -``ebinalg = LOG <FILE|LIN|LOG> [string]``
  37 +``ebinalg <FILE|LIN|LOG> [string]``
38 38 Algorithm for defining energy bins.
39 39  
40   -``emin = 0.1 [real]``
  40 +``emin [real]``
41 41 Lower energy value for first energy bin (in TeV).
42 42  
43   -``emax = 100.0 [real]``
  43 +``emax [real]``
44 44 Upper energy value for last energy bin (in TeV).
45 45  
46   -``enumbins =20 [integer]``
  46 +``enumbins [integer]``
47 47 Number of energy bins.
48 48  
49   -``ebinfile = NONE [file]``
  49 +``ebinfile [file]``
50 50 Name of the file containing the energy bin definition.
51 51  
52 52 ``(usepnt = no) [boolean]``
53 53 Use CTA pointing direction for cube centre instead of xref/yref parameters?
54 54  
55   -``nxpix = 200 [integer]``
  55 +``nxpix [integer]``
56 56 Number of cube bins in Right Ascension or Galactic longitude.
57 57  
58   -``nypix = 200 [integer]``
  58 +``nypix [integer]``
59 59 Number of cube bins in Declination or Galactic latitude.
60 60  
61   -``binsz = 0.02 [real]``
  61 +``binsz [real]``
62 62 Cube bin size (in degrees/pixel).
63 63  
64   -``coordsys = CEL <CEL|GAL> [string]``
  64 +``coordsysL <CEL|GAL> [string]``
65 65 Coordinate system (CEL - celestial, GAL - galactic).
66 66  
67   -``xref = 83.63 [real]``
  67 +``xref [real]``
68 68 Right Ascension / Galactic longitude of cube centre (J2000, in degrees).
69 69  
70   -``yref = 22.01 [real]``
  70 +``yref [real]``
71 71 Declination / Galactic latitude of cube centre (J2000, in degrees).
72 72  
73   -``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
  73 +``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
74 74 Projection method.
75 75  
76 76  
... ...
doc/source/reference_manual/ctcubemask.rst
  View file @ad72820
... ... @@ -16,13 +16,13 @@ corresponding pixels to negative values.
16 16 General parameters
17 17 ------------------
18 18  
19   -``inobs = cntmap.fits [file]``
  19 +``inobs [file]``
20 20 Input counts cube or observation definition XML file.
21 21  
22   -``regfile = NONE [file]``
  22 +``regfile [file]``
23 23 Exclusion region file in ds9 format.
24 24  
25   -``outcube = filtered_cube.fits [file]``
  25 +``outcube [file]``
26 26 Output counts cube or observation definition XML file.
27 27  
28 28 ``(prefix = filtered_) [string]``
... ... @@ -32,19 +32,19 @@ General parameters
32 32 ``(usepnt = no) [boolean]``
33 33 Use CTA pointing direction instead of ra/dec parameters?
34 34  
35   -``ra = 83.63 [real]``
  35 +``ra [real]``
36 36 Right Ascension of circular selection region centre (J2000, in degrees).
37 37  
38   -``dec = 22.01 [real]``
  38 +``dec [real]``
39 39 Declination of circular selection region centre (J2000, in degrees).
40 40  
41   -``rad = 3.0 [real]``
  41 +``rad [real]``
42 42 Radius of circular selection region (in degrees).
43 43  
44   -``emin = 0.1 [real]``
  44 +``emin [real]``
45 45 Lower energy limit (in TeV).
46 46  
47   -``emax = 100.0 [real]``
  47 +``emax [real]``
48 48 Upper energy limit (in TeV).
49 49  
50 50  
... ...
doc/source/reference_manual/ctexpcube.rst
  View file @ad72820
... ... @@ -16,61 +16,61 @@ analysis.
16 16 General parameters
17 17 ------------------
18 18  
19   -``inobs = NONE [file]``
  19 +``inobs [file]``
20 20 Input event list or observation definition XML file.
21 21  
22   -``incube = NONE [file]``
  22 +``incube [file]``
23 23 Counts cube for PSF cube definition.
24 24  
25   -``outcube = expcube.fits [file]``
  25 +``outcube [file]``
26 26 Output exposure cube file.
27 27  
28   -``caldb = dummy [string]``
  28 +``caldb [string]``
29 29 Calibration database.
30 30  
31   -``irf = cta_dummy_irf [string]``
  31 +``irf [string]``
32 32 Response function.
33 33  
34 34 ``(edisp = no) [boolean]``
35 35 Apply energy dispersion for response computation?
36 36  
37   -``ebinalg = LOG <FILE|LIN|LOG> [string]``
  37 +``ebinalg <FILE|LIN|LOG> [string]``
38 38 Algorithm for defining energy bins.
39 39  
40   -``emin = 0.1 [real]``
  40 +``emin [real]``
41 41 Lower energy value for first energy bin (in TeV).
42 42  
43   -``emax = 100.0 [real]``
  43 +``emax [real]``
44 44 Upper energy value for last energy bin (in TeV).
45 45  
46   -``enumbins = 20 [integer]``
  46 +``enumbins [integer]``
47 47 Number of energy bins.
48 48  
49   -``ebinfile = NONE [file]``
  49 +``ebinfile [file]``
50 50 Name of the file containing the energy bin definition.
51 51  
52 52 ``(usepnt = no) [boolean]``
53 53 Use CTA pointing direction for cube centre instead of xref/yref parameters?
54 54  
55   -``nxpix = 200 [integer]``
  55 +``nxpix [integer]``
56 56 Number of cube bins in Right Ascension or Galactic longitude.
57 57  
58   -``nypix = 200 [integer]``
  58 +``nypix [integer]``
59 59 Number of cube bins in Declination or Galactic latitude.
60 60  
61   -``binsz = 0.02 [real]``
  61 +``binsz [real]``
62 62 Cube bin size (in degrees/pixel).
63 63  
64   -``coordsys = CEL <CEL|GAL> [string]``
  64 +``coordsys <CEL|GAL> [string]``
65 65 Coordinate system (CEL - celestial, GAL - galactic).
66 66  
67   -``xref = 83.63 [real]``
  67 +``xref [real]``
68 68 Right Ascension / Galactic longitude of cube centre (J2000, in degrees).
69 69  
70   -``yref = 22.01 [real]``
  70 +``yref [real]``
71 71 Declination / Galactic latitude of cube centre (J2000, in degrees).
72 72  
73   -``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
  73 +``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
74 74 Projection method.
75 75  
76 76  
... ...
doc/source/reference_manual/ctlike.rst
  View file @ad72820
... ... @@ -22,16 +22,16 @@ and unbinned maximum likelihood analysis.
22 22 General parameters
23 23 ------------------
24 24  
25   -``inobs = events.fits [file]``
  25 +``inobs [file]``
26 26 Input event list, counts cube or observation definition XML file.
27 27  
28   -``inmodel = $CTOOLS/share/models/crab.xml [string]``
  28 +``inmodel [string]``
29 29 Source model input XML file.
30 30  
31   -``expcube = NONE [file]``
  31 +``expcube [file]``
32 32 Exposure cube file (only needed for stacked analysis).
33 33  
34   -``psfcube = NONE [file]``
  34 +``psfcube [file]``
35 35 PSF cube file (only needed for stacked analysis).
36 36  
37 37 ``caldb [string]``
... ...
doc/source/reference_manual/ctmodel.rst
  View file @ad72820
... ... @@ -17,51 +17,51 @@ Galactic longitude, Declination or Galactic latitude, and energy.
17 17 General parameters
18 18 ------------------
19 19  
20   -``incube = NONE [file]``
  20 +``incube [file]``
21 21 Input counts cube. If a filename is given the counts cube will be
22 22 used to define the dimensions of the model cube. The content of
23 23 the counts cube is not relevant.
24 24  
25   -``inmodel = $CTOOLS/share/models/crab.xml [string]``
  25 +``inmodel [string]``
26 26 Source model XML file.
27 27  
28   -``outcube = modcube.fits [file]``
  28 +``outcube [file]``
29 29 Output model counts cube.
30 30  
31 31 ``(edisp = no) [boolean]``
32 32 Apply energy dispersion to response computation.
33 33  
34   -``inobs = NONE [file]``
  34 +``inobs [file]``
35 35 Input event list, counts cube or observation definition XML file.
36 36 This information is needed to determine the observation information
37 37 (number of observations, duration, liftime, pointing, eventually
38 38 observation specific instrument response functions, etc.).
39 39  
40   -``expcube = NONE [file]``
  40 +``expcube [file]``
41 41 Exposure cube file (only needed for stacked analysis).
42 42  
43   -``psfcube = NONE [file]``
  43 +``psfcube [file]``
44 44 PSF cube file (only needed for stacked analysis).
45 45  
46   -``caldb = dummy [string]``
  46 +``caldb [string]``
47 47 Calibration database.
48 48  
49   -``irf = cta_dummy_irf [string]``
  49 +``irf [string]``
50 50 Instrument response function.
51 51  
52   -``ra = 83.63 [real]``
  52 +``ra [real]``
53 53 Right Ascension of pointing (J2000, in degrees).
54 54  
55   -``dec = 22.01 [real]``
  55 +``dec [real]``
56 56 Declination of pointing (J2000, in degrees).
57 57  
58   -``rad = 5.0 [real]``
  58 +``rad [real]``
59 59 Radius of field of view (in degrees).
60 60  
61   -``tmin = 0.0 [real]``
  61 +``tmin [real]``
62 62 CTA mission elapsed start time (in seconds).
63 63  
64   -``tmax = 1800.0 [real]``
  64 +``tmax [real]``
65 65 CTA mission elapsed stop time (in seconds).
66 66  
67 67 ``(deadc = 0.95) [real]``
... ... @@ -70,13 +70,13 @@ General parameters
70 70 ``(ebinalg = LOG) <FILE|LIN|LOG> [string]``
71 71 Algorithm for defining energy bins.
72 72  
73   -``emin = 0.1 [real]``
  73 +``emin [real]``
74 74 Lower energy value for first energy bin (in TeV).
75 75  
76   -``emax = 100 [real]``
  76 +``emax [real]``
77 77 Upper energy value for last energy bin (in TeV).
78 78  
79   -``enumbins = 20 [integer]``
  79 +``enumbins [integer]``
80 80 Number of energy bins.
81 81  
82 82 ``(ebinfile = NONE) [file]``
... ... @@ -85,25 +85,25 @@ General parameters
85 85 ``(usepnt = no) [boolean]``
86 86 Use pointing instead of xref/yref parameters?
87 87  
88   -``nxpix = 200 [integer]``
  88 +``nxpix [integer]``
89 89 Size of the Right Ascension / Galactic longitude axis (in pixels).
90 90  
91   -``nypix = 200 [integer]``
  91 +``nypix [integer]``
92 92 Size of the Declination / Galactic latitude axis (in pixels).
93 93  
94   -``binsz = 0.02 [real]``
  94 +``binsz [real]``
95 95 Pixel size (in degrees/pixel).
96 96  
97   -``coordsys = CEL <CEL|GAL> [string]``
  97 +``coordsys <CEL|GAL> [string]``
98 98 Coordinate system (CEL - celestial, GAL - galactic).
99 99  
100   -``xref = 83.63 [real]``
  100 +``xref [real]``
101 101 Right Ascension / Galactic longitude of image centre (J2000, in degrees).
102 102  
103   -``yref = 22.01 [real]``
  103 +``yref [real]``
104 104 Declination / Galactic latitude of image centre (J2000, in degrees).
105 105  
106   -``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
  106 +``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
107 107 Projection method.
108 108  
109 109  
... ...
doc/source/reference_manual/ctpsfcube.rst
  View file @ad72820
... ... @@ -17,61 +17,61 @@ maximum likelihood analysis.
17 17 General parameters
18 18 ------------------
19 19  
20   -``inobs = NONE [file]``
  20 +``inobs [file]``
21 21 Input event list or observation definition XML file.
22 22  
23   -``incube = NONE [file]``
  23 +``incube [file]``
24 24 Counts cube for PSF cube definition.
25 25  
26   -``outcube = psfcube.fits [file]``
  26 +``outcube [file]``
27 27 Output PSF cube file.
28 28  
29   -``caldb = dummy [string]``
  29 +``caldb [string]``
30 30 Calibration database.
31 31  
32   -``irf = cta_dummy_irf [string]``
  32 +``irf [string]``
33 33 Response function.
34 34  
35 35 ``(edisp = no) [boolean]``
36 36 Apply energy dispersion for response computation.
37 37  
38   -``ebinalg = LOG <FILE|LIN|LOG> [string]``
  38 +``ebinalg <FILE|LIN|LOG> [string]``
39 39 Algorithm for defining energy bins.
40 40  
41   -``emin = 0.1 [real]``
  41 +``emin [real]``
42 42 Lower energy value for first energy bin (in TeV).
43 43  
44   -``emax = 100.0 [real]``
  44 +``emax [real]``
45 45 Upper energy value for last energy bin (in TeV).
46 46  
47   -``enumbins =20 [integer]``
  47 +``enumbins [integer]``
48 48 Number of energy bins.
49 49  
50   -``ebinfile = NONE [file]``
  50 +``ebinfile [file]``
51 51 Name of the file containing the energy bin definition.
52 52  
53 53 ``(usepnt = no) [boolean]``
54 54 Use CTA pointing direction for cube centre instead of xref/yref parameters?
55 55  
56   -``nxpix = 200 [integer]``
  56 +``nxpix [integer]``
57 57 Number of cube bins in Right Ascension or Galactic longitude.
58 58  
59   -``nypix = 200 [integer]``
  59 +``nypix [integer]``
60 60 Number of cube bins in Declination or Galactic latitude.
61 61  
62   -``binsz = 0.02 [real]``
  62 +``binsz [real]``
63 63 Cube bin size (in degrees/pixel).
64 64  
65   -``coordsys = CEL <CEL|GAL> [string]``
  65 +``coordsys <CEL|GAL> [string]``
66 66 Coordinate system (CEL - celestial, GAL - galactic).
67 67  
68   -``xref = 83.63 [real]``
  68 +``xref [real]``
69 69 Right Ascension / Galactic longitude of cube centre (J2000, in degrees).
70 70  
71   -``yref = 22.01 [real]``
  71 +``yref [real]``
72 72 Declination / Galactic latitude of cube centre (J2000, in degrees).
73 73  
74   -``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
  74 +``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
75 75 Projection method.
76 76  
77 77 ``(amax = 0.3) [real]``
... ...
doc/source/reference_manual/ctskymap.rst
  View file @ad72820
... ... @@ -15,40 +15,40 @@ This tool generates a sky map from CTA data.
15 15 General parameters
16 16 ------------------
17 17  
18   -``inobs = events.fits [file]``
  18 +``inobs [file]``
19 19 Input event list or observation definition XML file.
20 20  
21   -``outmap = skymap.fits [file]``
  21 +``outmap [file]``
22 22 Output sky map.
23 23  
24   -``emin = 0.1 [real]``
  24 +``emin [real]``
25 25 Minimum energy in map (in TeV).
26 26  
27   -``emax = 100.0 [real]``
  27 +``emax [real]``
28 28 Maximum energy in map (in TeV).
29 29  
30 30 ``(usepnt = no) [boolean]``
31 31 Use pointing instead of xref/yref parameters?
32 32  
33   -``nxpix = 200 [integer]``
  33 +``nxpix [integer]``
34 34 Size of the Right Ascension / Galactic longitude axis (in pixels).
35 35  
36   -``nypix = 200 [integer]``
  36 +``nypix [integer]``
37 37 Size of the Declination / Galactic latitude axis (in pixels).
38 38  
39   -``binsz = 0.02 [real]``
  39 +``binsz [real]``
40 40 Pixel size (in degrees/pixel).
41 41  
42   -``coordsys = CEL <CEL|GAL> [string]``
  42 +``coordsys <CEL|GAL> [string]``
43 43 Coordinate system (CEL - celestial, GAL - galactic).
44 44  
45   -``xref = 83.63 [real]``
  45 +``xref [real]``
46 46 Right Ascension / Galactic longitude of image centre (J2000, in degrees).
47 47  
48   -``yref = 22.01 [real]``
  48 +``yref [real]``
49 49 Declination / Galactic latitude of image centre (J2000, in degrees).
50 50  
51   -``proj = CAR <AIT|AZP|CAR|MER|STG|TAN> [string]``
  51 +``proj <AIT|AZP|CAR|MER|STG|TAN> [string]``
52 52 Projection method.
53 53  
54 54  
... ...
doc/source/reference_manual/cttsmap.rst
  View file @ad72820
... ... @@ -15,53 +15,53 @@ This tool generates a test statistics map.
15 15 General parameters
16 16 ------------------
17 17  
18   -``inobs = events.fits [file]``
  18 +``inobs [file]``
19 19 Input event list, counts cube or observation definition XML file.
20 20  
21   -``inmodel = $CTOOLS/share/models/crab.xml [file]``
  21 +``inmodel [file]``
22 22 Input source model XML file.
23 23  
24   -``srcname = Crab [string]``
  24 +``srcname [string]``
25 25 Name of the source in the source model XML file for which the Test
26 26 Statistic map should be computed.
27 27  
28   -``expcube = NONE [file]``
  28 +``expcube [file]``
29 29 Exposure cube file (only needed for stacked analysis).
30 30  
31   -``psfcube = NONE [file]``
  31 +``psfcube [file]``
32 32 PSF cube file (only needed for stacked analysis).
33 33  
34   -``caldb = dummy [string]``
  34 +``caldb [string]``
35 35 Calibration database.
36 36  
37   -``irf = cta_dummy_irf [string]``
  37 +``irf [string]``
38 38 Response function.
39 39  
40   -``outmap = tsmap.fits [file]``
  40 +``outmap [file]``
41 41 Output Test Statistic map file.
42 42  
43 43 ``(usepnt = no) [boolean]``
44 44 Use CTA pointing direction for map centre instead of xref/yref parameters?
45 45  
46   -``nxpix = 200 [integer]``
  46 +``nxpix [integer]``
47 47 Number of map pixels in Right Ascension or Galactic longitude.
48 48  
49   -``nypix = 200 [integer]``
  49 +``nypix [integer]``
50 50 Number of map pixels in Declination or Galactic latitude.
51 51  
52   -``binsz = 0.02 [real]``
  52 +``binsz [real]``
53 53 Map pixel size (in degrees/pixel).
54 54  
55   -``coordsys = CEL <CEL|GAL> [string]``
  55 +``coordsys <CEL|GAL> [string]``
56 56 Coordinate system (CEL - celestial, GAL - galactic).
57 57  
58   -``xref = 83.63 [real]``
  58 +``xref [real]``
59 59 Right Ascension / Galactic longitude of map centre (J2000, in degrees).
60 60  
61   -``yref = 22.01 [real]``
  61 +``yref [real]``
62 62 Declination / Galactic latitude of map centre (J2000, in degrees).
63 63  
64   -``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
  64 +``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
65 65 Projection method.
66 66  
67 67 ``(binmin = -1) [integer]``
... ...