diff --git a/doc/html/doc/ctbin.html b/doc/html/doc/ctbin.html new file mode 100644 index 0000000..d40e48e --- /dev/null +++ b/doc/html/doc/ctbin.html @@ -0,0 +1,353 @@ + +
+ctbin
+Calculates counts maps for binned maximum +likelihood analysis.
+Synopsis
+This +tool computes the counts maps for use in a binned likelihood analysis. +The maps are data cubes in Right Ascension or Galactic longitude, +Declination or Galactic latitude, and log(energy).
+Links
+ + +General parameters
+| + | evfile +[file] | +|
| + | + | Input event list. | +
| + | + | + |
| + | outfile +[file] | +|
| + | + | Output counts map. | +
| + | + | + |
| + | (ebinalg += LOG) +<FILE|LIN|LOG> [string] | +|
| + | + | Algorithm for defining energy bins.
+Currently, only LOG is supported. |
+
| + | + | + |
| + | emin +[double] | +|
| + | + | Lower energy value for first energy +bin (in +TeV). | +
| + | + | + |
| + | emax +[double] | +|
| + | + | Upper energy value for last energy +bin +(in +TeV). | +
| + | + | + |
| + | enumbins +[integer] | +|
| + | + | Number of energy bins. | +
| + | + | + |
| + | (ebinfile += NONE) +[file] | +|
| + | + | Name of the file containing the +energy bin definition (not +yet implemented). | +
| + | + | + |
| + | nxpix +[integer] | +|
| + | + | Size of the Right Ascension / Galactic longitude axis (in pixels). | +
| + | + | + |
| + | nypix +[integer] | +|
| + | + | Size of the Declination / Galactic latitude axis (in pixels). | +
| + | + | + |
| + | binsz +[double] | +|
| + | + | Pixel size (in degrees/pixel). | +
| + | + | + |
| + | coordsys += CEL <CEL|GAL> [string] | +|
| + | + | Coordinate system (CEL - celestial, GAL - galactic). |
+
| + | + | + |
| + | xref +[double] | +|
| + | + | Right Ascension / Galactic longitude of image centre +(J2000, in degrees). | +
| + | + | + |
| + | yref +[double] | +|
| + | + | Declination / Galactic latitude of image centre (J2000, +in degrees). | +
| + | + | + |
| + | (axisrot = h) [double] | +|
| + | + | Rotation angle of image axes (in degrees). | +
| + | + | + |
| + | proj = CAR [string] | +|
| + | + | Projection method (only CAR is supported so far). |
+
| + | + | + |
Standard parameters
+| + | (chatter += 2) [integer] | +|
| + | + | Verbosity of the executable: + chatter = 0: no information will be
+logged+ chatter = 1: only errors will be logged+ chatter = 2: errors and actions will be
+logged+ chatter = 3: report about the task
+execution+ chatter = 4: detailed report about the
+task execution |
+
| + | + | + |
| + | (clobber += yes) [boolean] | +|
| + | + | Specifies whether an existing output counts map should be overwritten. | +
| + | + | + |
| + | (debug += yes) [boolean] | +|
| + | + | Enables debug mode. In debug mode +the executable will dump any log file output in the console. | +
| + | + | + |
| + | (mode += ql) [string] | +|
| + | + | Mode of automatic parameters. | +
| + | + | + |
Related FTOOLS
+Last updated by: Jürgen Knödlseder 8 March +2011 +
+ctlike
+Performs binned and unbinned maximum +likelihood analysis of CTA data.
+Synopsis
+Determines +source model parameters, such as flux, spectral index, source position, +and source extent from a maximum likelihood analysis of CTA data. The +analysis can be done in a binned or an unbinned formulation of the +log-likelihood function. For binned analysis, a counts map producted by +ctbin is required. For +unbinned analysis, an events list processed by ctselect is required.
+Links
+ + +General parameters
+| + | evfile +[file] | +|
| + | + | Input event list (for unbinned +analysis only). | +
| + | + | + |
| + | cntfile +[file] | +|
| + | + | Input counts map (for binned +analysis only). | +
| + | + | + |
| + | method += BINNED <BINNED|UNBINNED> [string] | +|
| + | + | Maximum likelihood analysis method (BINNED
+- for binned maximum likelihood analysis, UNBINNED
+- for unbinned maximum likelihood analysis). |
+
| + | + | + |
| + | (stat += POISSON) [string] | +|
| + | + | Fitting statistics (only affects +binned analysis). | +
| + | + | + |
| + | (refit += no) [boolean] | +|
| + | + | Performs refitting of solution after +initial fit. | +
| + | + | + |
| + | caldb +[string] | +|
| + | + | Calibration databas. | +
| + | + | + |
| + | irf +[string] | +|
| + | + | Instrument response function | +
| + | + | + |
| + | srcmdl +[string] | +|
| + | + | Source model input XML file. | +
| + | + | + |
| + | outmdl +[string] | +|
| + | + | Source model result XML file. | +
| + | + | + |
Standard parameters
+| + | (chatter += 2) [integer] | +|
| + | + | Verbosity of the executable: + chatter = 0: no information will be
+logged+ chatter = 1: only errors will be logged+ chatter = 2: errors and actions will be
+logged+ chatter = 3: report about the task
+execution+ chatter = 4: detailed report about the
+task execution |
+
| + | + | + |
| + | (clobber += yes) [boolean] | +|
| + | + | Specifies whether an existing source +model result file should be overwritten. | +
| + | + | + |
| + | (debug += yes) [boolean] | +|
| + | + | Enables debug mode. In debug mode +the executable will dump any log file output in the console. | +
| + | + | + |
| + | (mode += ql) [string] | +|
| + | + | Mode of automatic parameters. | +
| + | + | + |
Related FTOOLS
+ +Last updated by: Jürgen Knödlseder 8 March +2011 +
+ctobssim
+Observation simulator.
+Synopsis
+Generate +photon events from astrophysical sources and process those photons +according to the specified instrument response functions and generate +instrumental background events.
+Links
+ + +General parameters
+| + | infile +[file] | +|
| + | + | XML file that describes the +astrophysical sources and the instrumental background. | +
| + | + | + |
| + | outfile +[file] | +|
| + | + | Output event list. | +
| + | + | + |
| + | caldb +[string] | +|
| + | + | Calibration database repository. | +
| + | + | + |
| + | irf +[string] | +|
| + | + | Instrumental response function that +should be used for event generation. | +
| + | + | + |
| + | (seed += 1) [integer] | +|
| + | + | Integer seed value to be used for +Monte Carlo simulations. | +
| + | + | + |
| + | ra +[double] | +|
| + | + | Right Ascension of CTA pointing +(J2000, in degrees). | +
| + | + | + |
| + | dec +[double] | +|
| + | + | Declination of CTA pointing (J2000, +in degrees). | +
| + | + | + |
| + | rad +[double] | +|
| + | + | Radius of CTA field of view (simulation cone radius) (in degrees). | +
| + | + | + |
| + | tmin +[double] | +|
| + | + | Mission elapsed start time of +observation (in seconds). | +
| + | + | + |
| + | tmax +[double] | +|
| + | + | Mission elapsed stop time of +observation (in seconds). | +
| + | + | + |
| + | emin +[double] | +|
| + | + | Lower energy limit of events (in +TeV). | +
| + | + | + |
| + | emax +[double] | +|
| + | + | Upper energy limit of events (in +TeV). | +
| + | + | + |
Standard parameters
+| + | (chatter += 2) [integer] | +|
| + | + | Verbosity of the executable: + chatter = 0: no information will be
+logged+ chatter = 1: only errors will be logged+ chatter = 2: errors and actions will be
+logged+ chatter = 3: report about the task
+execution+ chatter = 4: detailed report about the
+task execution |
+
| + | + | + |
| + | (clobber += yes) [boolean] | +|
| + | + | Specifies whether an existing output +event list should be overwritten. | +
| + | + | + |
| + | (debug += yes) [boolean] | +|
| + | + | Enables debug mode. In debug mode +the executable will dump any log file output in the console. | +
| + | + | + |
| + | (mode += ql) [string] | +|
| + | + | Mode of automatic parameters. | +
| + | + | + |
Related FTOOLS
+Last updated by: Jürgen Knödlseder 8 March +2011 +
+ctselect
+Performs sub-selections of event data +which are needed for unbinned maximum likelihood analysis.
+Synopsis
+Creates +a new FITS file of selected events from an input event list based on +spatial, temporal, and energy cuts. Event selection is mandatory for +unbinned maximum likelihood analysis.
+Links
+ + +General parameters
+| + | infile +[file] | +|
| + | + | Input event list. | +
| + | + | + |
| + | outfile +[file] | +|
| + | + | Output event list. | +
| + | + | + |
| + | ra +[double] | +|
| + | + | Right Ascension of acceptance cone +(or ROI) centre +(J2000, in degrees). | +
| + | + | + |
| + | dec +[double] | +|
| + | + | Declination of acceptance cone (or +ROI) centre (J2000, +in degrees). | +
| + | + | + |
| + | rad +[double] | +|
| + | + | Radius of acceptance cone (or +ROI) centre (in degrees). | +
| + | + | + |
| + | tmin +[double] | +|
| + | + | Mission elapsed start time defining the earliest event (in +seconds). | +
| + | + | + |
| + | tmax +[double] | +|
| + | + | Mission elapsed stop time defining the latest event (in +seconds). | +
| + | + | + |
| + | emin +[double] | +|
| + | + | Lower energy limit of events (in +TeV). | +
| + | + | + |
| + | emax +[double] | +|
| + | + | Upper energy limit of events (in +TeV). | +
| + | + | + |
Standard parameters
+| + | (chatter += 2) [integer] | +|
| + | + | Verbosity of the executable: + chatter = 0: no information will be
+logged+ chatter = 1: only errors will be logged+ chatter = 2: errors and actions will be
+logged+ chatter = 3: report about the task
+execution+ chatter = 4: detailed report about the
+task execution |
+
| + | + | + |
| + | (clobber += yes) [boolean] | +|
| + | + | Specifies whether an existing output +event list should be overwritten. | +
| + | + | + |
| + | (debug += yes) [boolean] | +|
| + | + | Enables debug mode. In debug mode +the executable will dump any log file output in the console. | +
| + | + | + |
| + | (mode += ql) [string] | +|
| + | + | Mode of automatic parameters. | +
| + | + | + |
Related FTOOLS
+Last updated by: Jürgen Knödlseder 8 March +2011 +
+Basic FTOOL Parameter Usage
+Automatic Parameters:
+| + | par_name +[ = value ] +<valid values> type | +|
| + | + | Where par_name
+is the name of the parameter, value is the
+default value,
+valid values are valid parameter values,
+separated by | characters,
+and type is the type of the parameter. The
+type is enclosed in square
+brackets. |
+
Hidden Parameters:
+| + | (par_name += value ) type | +|
| + | + | Where par_name
+is the name of the parameter, value is the
+default value,
+and type is the type of the parameter. The
+type is enclosed in square
+brackets. |
+
Examples:
+| + | infile +[file] | +|
| + | + | Describes an +automatic (queried) file-type parameter with no default value. | +
| + | + | + |
| + | irf += kb_E_50h_v3 <kb_E_50h_v3|kb_H_50h_v3> [string] | +|
| + | + | Describes an automatic (quiered) +string-type parameter with two value options. | +
| + | + | + |
| + | (plot += yes) [bool] | +|
| + | + | Describes a +hidden bool-type parameter named plot, whose default value is yes +(true). | +
| + | + | + |
|
+ Note: To set hidden parameters at runtime, +specify them explicitly at the command line; for example: +++ |
+||
Last updated by: Jürgen Knödlseder 8 March +2011 +
+