diff --git a/cscripts/cslightcrv.py b/cscripts/cslightcrv.py index 94000a3..5b63a3a 100755 --- a/cscripts/cslightcrv.py +++ b/cscripts/cslightcrv.py @@ -98,10 +98,10 @@ class cslightcrv(ctools.cscript): # Create default parfile pars = gammalib.GApplicationPars() - pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition file")) - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model")) + pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition XML file")) + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file")) pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name")) - pars.append(gammalib.GApplicationPar("outfile","f","a","lightcurve.fits","","","Output file name")) + pars.append(gammalib.GApplicationPar("outfile","f","a","lightcurve.fits","","","Output lightcurve file")) pars.append(gammalib.GApplicationPar("expcube","f","a","NONE","","","Exposure cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("psfcube","f","a","NONE","","","PSF cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("bkgcube","s","a","NONE","","","Background cube file (only needed for stacked analysis)")) diff --git a/cscripts/csobsdef.py b/cscripts/csobsdef.py index be4ce1c..0c54f02 100755 --- a/cscripts/csobsdef.py +++ b/cscripts/csobsdef.py @@ -128,8 +128,8 @@ class csobsdef(ctools.cscript): # Create default parfile pars = gammalib.GApplicationPars() - pars.append(gammalib.GApplicationPar("inpnt","f","a","NONE","","","Pointing definition file")) - pars.append(gammalib.GApplicationPar("outobs","f","a","obs.xml","","","Output observation definition file")) + pars.append(gammalib.GApplicationPar("inpnt","f","a","NONE","","","Input pointing definition file")) + pars.append(gammalib.GApplicationPar("outobs","f","a","obs.xml","","","Output observation definition XML file")) pars.append(gammalib.GApplicationPar("duration","r","a","1800.0","","","Pointing duration (seconds)")) pars.append(gammalib.GApplicationPar("caldb","s","h","","","","Calibration database")) pars.append(gammalib.GApplicationPar("irf","s","h","","","","Instrument response function")) diff --git a/cscripts/cspull.py b/cscripts/cspull.py index 796cb22..14fbf04 100755 --- a/cscripts/cspull.py +++ b/cscripts/cspull.py @@ -101,9 +101,9 @@ class cspull(ctools.cscript): # Create default parfile pars = gammalib.GApplicationPars() - pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition file")) - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model")) - pars.append(gammalib.GApplicationPar("outfile","f","a","pull.dat","","","Output file name")) + pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition XML file")) + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file")) + pars.append(gammalib.GApplicationPar("outfile","f","a","pull.dat","","","Output pull distribution file")) pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database")) pars.append(gammalib.GApplicationPar("irf","s","a","South_50h","","","Instrument response function")) pars.append(gammalib.GApplicationPar("deadc","r","h","0.95","0","1","Deadtime correction factor")) diff --git a/cscripts/csresmap.py b/cscripts/csresmap.py index 23aa1c3..0b07d61 100755 --- a/cscripts/csresmap.py +++ b/cscripts/csresmap.py @@ -103,12 +103,12 @@ class csresmap(ctools.cscript): # Create default parfile pars = gammalib.GApplicationPars() - pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition file")) + pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition XML file")) pars.append(gammalib.GApplicationPar("modcube","f","a","NONE","","","Model cube file (generated with ctmodel)")) pars.append(gammalib.GApplicationPar("expcube","f","a","NONE","","","Exposure cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("psfcube","f","a","NONE","","","PSF cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("bkgcube","f","a","NONE","","","Background cube file (only needed for stacked analysis)")) - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model")) + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file")) pars.append(gammalib.GApplicationPar("outmap","f","a","resmap.fits","","","Output residual map")) pars.append(gammalib.GApplicationPar("edisp","b","h","no","","","Apply energy dispersion?")) pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database")) diff --git a/cscripts/cssens.py b/cscripts/cssens.py index a422824..1e22058 100755 --- a/cscripts/cssens.py +++ b/cscripts/cssens.py @@ -97,14 +97,14 @@ class cssens(ctools.cscript): # Create default parfile pars = gammalib.GApplicationPars() - pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition file")) - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model")) + pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition XML file")) + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file")) pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name")) pars.append(gammalib.GApplicationPar("offset","r","h","0.0","","","Source offset angle (deg)")) pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database")) pars.append(gammalib.GApplicationPar("irf","s","a","South_50h","","","Instrument response function")) pars.append(gammalib.GApplicationPar("deadc","r","h","0.95","0","1","Deadtime correction factor")) - pars.append(gammalib.GApplicationPar("outfile","f","h","sensitivity.dat","","","Output file name")) + pars.append(gammalib.GApplicationPar("outfile","f","h","sensitivity.dat","","","Output sensitivity file")) pars.append(gammalib.GApplicationPar("duration","r","a","180000.0","","","Effective exposure time (s)")) pars.append(gammalib.GApplicationPar("rad","r","a","5.0","","","Radius of ROI (deg)")) pars.append(gammalib.GApplicationPar("edisp","b","h","no","","","Apply energy dispersion?")) diff --git a/cscripts/csspec.py b/cscripts/csspec.py index 2afd36a..964be94 100755 --- a/cscripts/csspec.py +++ b/cscripts/csspec.py @@ -100,10 +100,10 @@ class csspec(ctools.cscript): # Create default parfile pars = gammalib.GApplicationPars() - pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition file")) - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model")) + pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition XML file")) + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file")) pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name")) - pars.append(gammalib.GApplicationPar("outfile","f","a","spectrum.fits","","","Output file name")) + pars.append(gammalib.GApplicationPar("outfile","f","a","spectrum.fits","","","Output spectrum file")) pars.append(gammalib.GApplicationPar("expcube","f","a","NONE","","","Exposure cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("psfcube","f","a","NONE","","","PSF cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("bkgcube","f","a","NONE","","","Background cube file (only needed for stacked analysis)")) diff --git a/cscripts/cstsdist.py b/cscripts/cstsdist.py index 70b02c1..a6e5626 100755 --- a/cscripts/cstsdist.py +++ b/cscripts/cstsdist.py @@ -94,10 +94,10 @@ class cstsdist(ctools.cscript): # Create default parfile pars = gammalib.GApplicationPars() - pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition file")) - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model")) + pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition XML file")) + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file")) pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name")) - pars.append(gammalib.GApplicationPar("outfile","f","a","ts.dat","","","Output file name")) + pars.append(gammalib.GApplicationPar("outfile","f","a","ts.dat","","","Output Test Statistics distribution file")) pars.append(gammalib.GApplicationPar("expcube","s","a","NONE","","","Exposure cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("psfcube","s","a","NONE","","","PSF cube file (only needed for stacked analysis)")) pars.append(gammalib.GApplicationPar("bkgcube","s","a","NONE","","","Background cube file (only needed for stacked analysis)")) diff --git a/doc/source/reference_manual/ctbin.rst b/doc/source/reference_manual/ctbin.rst index 3831fd1..59bae73 100644 --- a/doc/source/reference_manual/ctbin.rst +++ b/doc/source/reference_manual/ctbin.rst @@ -106,4 +106,6 @@ Standard parameters Related tools ------------- -None +:doc:`ctexpcube` +:doc:`ctpsfcube` +:doc:`ctbkgcube` diff --git a/src/ctbin/ctbin.par b/src/ctbin/ctbin.par index 0b26264..02ee1f9 100644 --- a/src/ctbin/ctbin.par +++ b/src/ctbin/ctbin.par @@ -17,7 +17,7 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Event list or observation definition file" +inobs, f, a, "events.fits",,, "Event list or observation definition XML file" outcube, f, a, "cntcube.fits",,, "Output counts cube" # # Energy binning parameters diff --git a/src/ctbkgcube/ctbkgcube.par b/src/ctbkgcube/ctbkgcube.par index f2a5ee1..a6ef498 100644 --- a/src/ctbkgcube/ctbkgcube.par +++ b/src/ctbkgcube/ctbkgcube.par @@ -17,7 +17,7 @@ # # Observational parameters #=================== -inobs, f, a, "NONE",,, "Input event list or observation definition file" +inobs, f, a, "NONE",,, "Input event list or observation definition XML file" inmodel, f, a, "NONE",,, "Input model XML file" incube, f, a, "NONE",,, "Counts cube for background cube definition" outcube, f, a, "bkgcube.fits",,, "Output background cube file" diff --git a/src/ctbutterfly/ctbutterfly.par b/src/ctbutterfly/ctbutterfly.par index 7af995b..5dd555a 100644 --- a/src/ctbutterfly/ctbutterfly.par +++ b/src/ctbutterfly/ctbutterfly.par @@ -17,8 +17,8 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,,"Input event list, counts cube or observation definition file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" +inobs, f, a, "events.fits",,,"Input event list, counts cube or observation definition XML file" +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file" srcname, s, a, "Crab",,,"Source of interest" expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)" psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)" @@ -26,7 +26,7 @@ bkgcube, f, a, "NONE",,, "Background cube file (only needed for stacked analy caldb, s, a, "prod2",,, "Calibration database" irf, s, a, "South_50h",,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" -outfile, f, a, "butterfly.txt",,, "Output ascii file" +outfile, f, a, "butterfly.txt",,, "Output ASCII file" refit, b, h, no,,, "Do refitting?" confidence, r, h, 0.68,0.0,1.0, "Confidence level" matrix, f, h, "NONE",,, "Input covariance Matrix FITS file" diff --git a/src/ctcubemask/ctcubemask.par b/src/ctcubemask/ctcubemask.par index 616239f..094d4d0 100644 --- a/src/ctcubemask/ctcubemask.par +++ b/src/ctcubemask/ctcubemask.par @@ -17,7 +17,7 @@ # # File information #================= -inobs, f, a, "cntmap.fits",,, "Input counts cube or observation definition file" +inobs, f, a, "cntmap.fits",,, "Input counts cube or observation definition XML file" regfile, f, a, "NONE",,, "Exclusion region file in ds9 format" outcube, f, a, "filtered_cube.fits",,, "Output counts cube or observation definition file" prefix, s, h, "filtered_",,, "Prefix for counts cube in observation definition file" diff --git a/src/cterror/cterror.par b/src/cterror/cterror.par index 8def721..2c666ac 100644 --- a/src/cterror/cterror.par +++ b/src/cterror/cterror.par @@ -18,9 +18,9 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" -outmodel, f, a, "results.xml",,, "Source model output file" +inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file" +outmodel, f, a, "results.xml",,, "Output model XML file" srcname, s, a, "Crab",,, "Source of interest" expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)" psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)" diff --git a/src/ctexpcube/ctexpcube.par b/src/ctexpcube/ctexpcube.par index bce8ab6..a3959bc 100644 --- a/src/ctexpcube/ctexpcube.par +++ b/src/ctexpcube/ctexpcube.par @@ -17,7 +17,7 @@ # # Observational parameters #=================== -inobs, f, a, "NONE",,, "Event list or observation definition file" +inobs, f, a, "NONE",,, "Event list or observation definition XML file" incube, f, a, "NONE",,, "Counts cube for exposure cube definition" outcube, f, a, "expcube.fits",,, "Output exposure cube file" caldb, s, a, "prod2",,, "Calibration database" diff --git a/src/ctlike/ctlike.par b/src/ctlike/ctlike.par index 2fd8286..3f17035 100644 --- a/src/ctlike/ctlike.par +++ b/src/ctlike/ctlike.par @@ -17,18 +17,18 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Event list, counts cube or observation definition file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" +inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file" expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)" psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)" bkgcube, f, a, "NONE",,, "Background cube file (only needed for stacked analysis)" caldb, s, a, "prod2",,, "Calibration database" irf, s, a, "South_50h",,, "Instrument response function" -outmodel, f, a, "crab_results.xml",,, "Source model output file" +outmodel, f, a, "crab_results.xml",,, "Output model XML file" stat, s, h, "POISSON",,, "Optimization statistics" edisp, b, h, no,,, "Apply energy dispersion?" refit, b, h, no,,, "Do refitting?" -fix_spat_for_ts, b, h, no,,,"Fix spatial parameters for TS computation?" +fix_spat_for_ts, b, h, no,,, "Fix spatial parameters for TS computation?" # # Standard parameters diff --git a/src/ctmodel/ctmodel.par b/src/ctmodel/ctmodel.par index f0f6265..577a442 100644 --- a/src/ctmodel/ctmodel.par +++ b/src/ctmodel/ctmodel.par @@ -18,7 +18,7 @@ # General parameters #=================== incube, f, a, "NONE",,, "Input counts cube" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file" outcube, f, a, "modcube.fits",,, "Output model cube" edisp, b, h, no,,, "Apply energy dispersion?" # diff --git a/src/ctobssim/ctobssim.par b/src/ctobssim/ctobssim.par index 71359c0..9871f63 100644 --- a/src/ctobssim/ctobssim.par +++ b/src/ctobssim/ctobssim.par @@ -17,10 +17,10 @@ # # File information #================= -inobs, f, h, "NONE",,, "Input event list or observation definition file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Model" -outevents, f, a, "events.fits",,, "Output event data file or observation definition file" -prefix, s, h, "sim_events_",,, "Prefix for event lists in observation definition file" +inobs, f, h, "NONE",,, "Input event list or observation definition XML file" +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file" +outevents, f, a, "events.fits",,, "Output event data file or observation definition XML file" +prefix, s, h, "sim_events_",,, "Prefix for event lists in observation definition XML file" # # Observation parameters #======================= diff --git a/src/ctpsfcube/ctpsfcube.par b/src/ctpsfcube/ctpsfcube.par index 8002221..dd7fb5b 100644 --- a/src/ctpsfcube/ctpsfcube.par +++ b/src/ctpsfcube/ctpsfcube.par @@ -17,7 +17,7 @@ # # Observational parameters #=================== -inobs, f, a, "NONE",,, "Event list or observation definition file" +inobs, f, a, "NONE",,, "Event list or observation definition XML file" incube, f, a, "NONE",,, "Counts cube for psf cube definition" outcube, f, a, "psfcube.fits",,, "Output psf cube file" caldb, s, a, "prod2",,, "Calibration database" diff --git a/src/ctselect/ctselect.par b/src/ctselect/ctselect.par index 1490613..84d69d4 100644 --- a/src/ctselect/ctselect.par +++ b/src/ctselect/ctselect.par @@ -17,9 +17,9 @@ # # File information #================= -inobs, f, a, "events.fits",,, "Input event list or observation definition file" -outobs, f, a, "selected_events.fits",,, "Output event list or observation definition file" -prefix, s, h, "selected_",,, "Prefix for event lists in observation definition file" +inobs, f, a, "events.fits",,, "Input event list or observation definition XML file" +outobs, f, a, "selected_events.fits",,, "Output event list or observation definition XML file" +prefix, s, h, "selected_",,, "Prefix for event lists in observation definition XML file" # # Selection parameters #===================== diff --git a/src/ctskymap/ctskymap.par b/src/ctskymap/ctskymap.par index 0d57998..6ad4473 100644 --- a/src/ctskymap/ctskymap.par +++ b/src/ctskymap/ctskymap.par @@ -17,8 +17,8 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Event list or observation definition file" -outmap, f, a, "skymap.fits",,, "Output file name" +inobs, f, a, "events.fits",,, "Event list or observation definition XML file" +outmap, f, a, "skymap.fits",,, "Output skymap file" # # Event selection parameters #=========================== diff --git a/src/cttsmap/cttsmap.par b/src/cttsmap/cttsmap.par index d3bd20b..1b32423 100644 --- a/src/cttsmap/cttsmap.par +++ b/src/cttsmap/cttsmap.par @@ -17,8 +17,8 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" +inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file" srcname, s, a, "Crab",,, "Test source" expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)" psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)" diff --git a/src/ctulimit/ctulimit.par b/src/ctulimit/ctulimit.par index 88675cf..78bf3ff 100644 --- a/src/ctulimit/ctulimit.par +++ b/src/ctulimit/ctulimit.par @@ -17,8 +17,8 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" +inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file" srcname, s, a, "Crab",,, "Source of interest" expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)" psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)"