diff --git a/doc/source/reference_manual/ctbkgcube.rst b/doc/source/reference_manual/ctbkgcube.rst index a7d47be..e875a51 100644 --- a/doc/source/reference_manual/ctbkgcube.rst +++ b/doc/source/reference_manual/ctbkgcube.rst @@ -54,13 +54,7 @@ General parameters Input model XML file. ``incube [file]`` - Counts cube file to extract background cube definition. - -``outcube [file]`` - Output background cube file. - -``outmodel [file]`` - Output model XML file. + Input counts cube file to extract background cube definition. ``caldb [string]`` Calibration database. @@ -68,6 +62,12 @@ General parameters ``irf [string]`` Instrument response function. +``outcube [file]`` + Output background cube file. + +``outmodel [file]`` + Output model XML file. + ``ebinalg [string]`` Algorithm for defining energy bins. diff --git a/doc/source/reference_manual/ctbutterfly.rst b/doc/source/reference_manual/ctbutterfly.rst index 95355f7..b412924 100644 --- a/doc/source/reference_manual/ctbutterfly.rst +++ b/doc/source/reference_manual/ctbutterfly.rst @@ -28,19 +28,19 @@ General parameters Input event list, counts cube or observation definition XML file. ``inmodel [file]`` - Model XML file containing the source and background definitions. + Input model XML file. ``srcname [string]`` Name of model component for which butterfly should be computed. ``expcube [file]`` - Exposure cube file (only needed for stacked analysis). + Input exposure cube file (only needed for stacked analysis). ``psfcube [file]`` - PSF cube file (only needed for stacked analysis). + Input PSF cube file (only needed for stacked analysis). ``bkgcube [file]`` - Background cube file (only needed for stacked analysis). + Input background cube file (only needed for stacked analysis). ``caldb [string]`` Calibration database. diff --git a/doc/source/reference_manual/cterror.rst b/doc/source/reference_manual/cterror.rst index 91ec9f1..115f6b1 100644 --- a/doc/source/reference_manual/cterror.rst +++ b/doc/source/reference_manual/cterror.rst @@ -21,22 +21,19 @@ General parameters Input event list, counts cube or observation definition XML file. ``inmodel [file]`` - Model XML file containing the source and background definitions. - -``outmodel [file]`` - Model XML file with updated error information. + Input model XML file. ``srcname [string]`` Name of model component for which upper limit should be computed. ``expcube [file]`` - Exposure cube file (only needed for stacked analysis). + Input exposure cube file (only needed for stacked analysis). ``psfcube [file]`` - PSF cube file (only needed for stacked analysis). + Input PSF cube file (only needed for stacked analysis). ``bkgcube [file]`` - Background cube file (only needed for stacked analysis). + Input background cube file (only needed for stacked analysis). ``caldb [string]`` Calibration database. @@ -47,6 +44,9 @@ General parameters ``(edisp = no) [boolean]`` Applies energy dispersion to response computation. +``outmodel [file]`` + Output model XML file with updated error information. + ``(confidence = 0.68) [real]`` Confidence level for error computation. diff --git a/doc/source/reference_manual/ctexpcube.rst b/doc/source/reference_manual/ctexpcube.rst index f85c3f6..e1eba89 100644 --- a/doc/source/reference_manual/ctexpcube.rst +++ b/doc/source/reference_manual/ctexpcube.rst @@ -45,10 +45,7 @@ General parameters Input event list or observation definition XML file. ``incube [file]`` - Counts cube file to extract exposure cube definition. - -``outcube [file]`` - Output exposure cube file. + Input counts cube file to extract exposure cube definition. ``caldb [string]`` Calibration database. @@ -59,6 +56,9 @@ General parameters ``(edisp = no) [boolean]`` Apply energy dispersion for response computation? +``outcube [file]`` + Output exposure cube file. + ``ebinalg [string]`` Algorithm for defining energy bins. diff --git a/doc/source/reference_manual/ctlike.rst b/doc/source/reference_manual/ctlike.rst index 79db24c..b547fdc 100644 --- a/doc/source/reference_manual/ctlike.rst +++ b/doc/source/reference_manual/ctlike.rst @@ -63,13 +63,13 @@ General parameters Input model XML file. ``expcube [file]`` - Exposure cube file (only needed for stacked analysis). + Input exposure cube file (only needed for stacked analysis). ``psfcube [file]`` - PSF cube file (only needed for stacked analysis). + Input PSF cube file (only needed for stacked analysis). ``bkgcube [file]`` - Background cube file (only needed for stacked analysis). + Input background cube file (only needed for stacked analysis). ``caldb [string]`` Calibration database. diff --git a/doc/source/reference_manual/ctobssim.rst b/doc/source/reference_manual/ctobssim.rst index 27754f5..bf930d5 100644 --- a/doc/source/reference_manual/ctobssim.rst +++ b/doc/source/reference_manual/ctobssim.rst @@ -23,14 +23,7 @@ General parameters simulation. ``inmodel [file]`` - XML file that describes the astrophysical sources and the instrumental - background model. - -``outevents [file]`` - Output event list or observation definition XML file. - -``(prefix = sim_events_) [string]`` - Prefix for event list in observation definition XML file. + Input model XML file. ``caldb [string]`` Calibration database. @@ -38,6 +31,15 @@ General parameters ``irf [string]`` Instrumental response function. +``(edisp = no) [boolean]`` + Apply energy dispersion? + +``outevents [file]`` + Output event list or observation definition XML file. + +``(prefix = sim_events_) [string]`` + Prefix for event list in observation definition XML file. + ``(seed = 1) [integer]`` Integer seed value to be used for Monte Carlo simulations. Keep this parameter at the same value for repeatable simulations, or increment @@ -65,9 +67,6 @@ General parameters ``emax [real]`` Upper energy limit of simulated events (in TeV). -``(edisp = no) [boolean]`` - Apply energy dispersion? - ``(deadc = 0.95) [real]`` Average deadtime correction factor. diff --git a/doc/source/reference_manual/ctpsfcube.rst b/doc/source/reference_manual/ctpsfcube.rst index 5cb62f2..e9f6f79 100644 --- a/doc/source/reference_manual/ctpsfcube.rst +++ b/doc/source/reference_manual/ctpsfcube.rst @@ -45,10 +45,7 @@ General parameters Input event list or observation definition XML file. ``incube [file]`` - Counts cube file to extract point spread function cube definition. - -``outcube [file]`` - Output point spread function cube file. + Input counts cube file to extract point spread function cube definition. ``caldb [string]`` Calibration database. @@ -59,6 +56,9 @@ General parameters ``(edisp = no) [boolean]`` Apply energy dispersion for response computation. +``outcube [file]`` + Output point spread function cube file. + ``ebinalg [string]`` Algorithm for defining energy bins. diff --git a/doc/source/reference_manual/ctskymap.rst b/doc/source/reference_manual/ctskymap.rst index 3f81795..e992dd1 100644 --- a/doc/source/reference_manual/ctskymap.rst +++ b/doc/source/reference_manual/ctskymap.rst @@ -19,7 +19,7 @@ General parameters Input event list or observation definition XML file. ``outmap [file]`` - Output sky map. + Output sky map file. ``emin [real]`` Minimum energy in map (in TeV). diff --git a/doc/source/reference_manual/cttsmap.rst b/doc/source/reference_manual/cttsmap.rst index 9789cfc..259fc9e 100644 --- a/doc/source/reference_manual/cttsmap.rst +++ b/doc/source/reference_manual/cttsmap.rst @@ -26,13 +26,13 @@ General parameters Statistic map should be computed. ``expcube [file]`` - Exposure cube file (only needed for stacked analysis). + Input exposure cube file (only needed for stacked analysis). ``psfcube [file]`` - PSF cube file (only needed for stacked analysis). + Input PSF cube file (only needed for stacked analysis). ``bkgcube [file]`` - Background cube file (only needed for stacked analysis). + Input background cube file (only needed for stacked analysis). ``caldb [string]`` Calibration database. diff --git a/doc/source/reference_manual/ctulimit.rst b/doc/source/reference_manual/ctulimit.rst index 41c7f29..3247437 100644 --- a/doc/source/reference_manual/ctulimit.rst +++ b/doc/source/reference_manual/ctulimit.rst @@ -19,19 +19,19 @@ General parameters Input event list, counts cube or observation definition XML file. ``inmodel [file]`` - Model XML file containing the source and background definitions. + Input model XML file. ``srcname [string]`` Name of model component for which upper limit should be computed. ``expcube [file]`` - Exposure cube file (only needed for stacked analysis). + Input exposure cube file (only needed for stacked analysis). ``psfcube [file]`` - PSF cube file (only needed for stacked analysis). + Input PSF cube file (only needed for stacked analysis). ``bkgcube [file]`` - Background cube file (only needed for stacked analysis). + Input background cube file (only needed for stacked analysis). ``caldb [string]`` Calibration database.