From 93fded13373532cb11e86ab1e64259e997c711ff Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Fri, 21 Dec 2012 21:50:04 +0100 Subject: [PATCH] Add cscripts documentations. --- doc/html/doc/cspull.html | 373 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/html/doc/cssens.html | 393 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/html/doc/cstsdist.html | 356 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/html/documentation.html | 11 ++++++++++- 4 files changed, 1132 insertions(+), 1 deletion(-) create mode 100644 doc/html/doc/cspull.html create mode 100644 doc/html/doc/cssens.html create mode 100644 doc/html/doc/cstsdist.html diff --git a/doc/html/doc/cspull.html b/doc/html/doc/cspull.html new file mode 100644 index 0000000..85a8433 --- /dev/null +++ b/doc/html/doc/cspull.html @@ -0,0 +1,373 @@ + + +cspull + + + + + + +

cspull

+

Generates pull distribution for all model +parameters.

+
+

Synopsis

+

Generates +pull distributions for all parameters in a model. The pull is defined +by the fitted value minus the simulated true value, devided by the +statistical uncertainty. For unbiased parameter estimates, the pull +distribution should follow a Gaussian centred on 0 and a sigma +parameter of 1.

+
+

Links

+ +

+
+

General parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 srcmdl +[file]
  XML file that describes the +astrophysical sources and the instrumental background.
   
 outfile +[file]
  ASCII file containing the individual +pull values.
   
 ntrials +[integer]
  Number of samples for generating the +pull distribution.
   
 caldb +[string]
  Calibration database repository.
   
 irf +[string]
  Instrumental response function that +should be used for event generation.
   
 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).
   
 emin +[double]
  Lower energy limit of events (in +TeV).
   
 emax +[double]
  Upper energy limit of events (in +TeV).
   
 enumbins +[integer]
  Number of energy bins (0=unbinned).
   
 duration +[double]
  Duration of +observation (in seconds).
   
 (deadc += 0.95) +[double]
  Average deadtime correction factor.
   
 (rad += 5.0) +[double]
  ROI radius (in degrees).
   
 (npix += 200) +[integer]
  Number of pixels for binned analysis.
   
 (binsz += 0.05) +[double]
  Pixel size for binned analysis.
   
+

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 += no) [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 21 December +2012 +

+
+ \ No newline at end of file diff --git a/doc/html/doc/cssens.html b/doc/html/doc/cssens.html new file mode 100644 index 0000000..a301152 --- /dev/null +++ b/doc/html/doc/cssens.html @@ -0,0 +1,393 @@ + + +cssens + + + + + + +

cssens

+

Computes the CTA sensitivity for a number +of energy bins.

+
+

Synopsis

+

Computes +the CTA sensitivity for a number of energy bins using ctlike. Crab spectra are fitted +in narrow energy bins to simulated data, and the flux level is +determined that leads to a particular significance.

+
+

Links

+ +

+
+

General parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 outfile +[file]
  ASCII file containing the +sensitivity +values.
   
 caldb +[string]
  Calibration database repository.
   
 irf +[string]
  Instrumental response function that +should be used for event generation.
   
 type +[string]
  Source model type +(point/gauss/shell/disk).
   
 offset +[double]
  Source offset angle (in +degrees).
   
 bkg +[string]
  Background model file function +(none=power law for subarray E).
   
 duration +[double]
  Effective exposure time (in seconds).
   
 rad +[double]
  Radius of ROI (in degrees).
   
 (enumbins = 0) +[integer]
  Number of energy bins (0=unbinned).
   
 (npix = 200) +[integer]
  Number of pixels for binned analysis.
   
 (binsz = 0.05) +[double]
  Pixel size for binned analysis.
   
 (sigma = 5.0) +[double]
  Significance threshold.
   
 (ts_use = yes) +[boolean]
  Use TS for signifiance estimation?
   
 (index = -2.48) +[double]
  Spectral index for source model.
   
 (radius = 0.1) +[double]
  Extended source model radius (in degrees).
   
 (width = 0.05) +[double]
  Extended source model width (in degrees).
   
 (max_iter = 50) +[integer]
  Maximum number of iterations.
   
 (num_avg = 3) +[integer]
  Number of iterations for sliding average.
   
+

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 += no) [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 21 December +2012 +

+
+ \ No newline at end of file diff --git a/doc/html/doc/cstsdist.html b/doc/html/doc/cstsdist.html new file mode 100644 index 0000000..8150c0e --- /dev/null +++ b/doc/html/doc/cstsdist.html @@ -0,0 +1,356 @@ + + +cstsdist + + + + + + +

cstsdist

+

Generates the TS distribution for a +particular model.

+
+

Synopsis

+

Generates +the Test Statistics (TS) distribution for a particular model based on +Monte-Carlo simulations.

+
+

Links

+ +

+
+

General parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 (outfile += ts.dat) +[file]
  ASCII file containing the TS +distribution values.
   
 ntrials +[integer]
  Number of Monte Carlo samples.
   
 caldb +[string]
  Calibration database repository.
   
 irf +[string]
  Instrumental response function that +should be used for event generation.
   
 type +[string]
  Source model type +(point/gauss/shell/disk).
   
 (index += -2.48) +[double]
  Spectral index for source model.
   
 offset +[double]
  Source offset angle (in +degrees).
   
 bkg +[string]
  Background model file function +(none=power law for subarray E).
   
   
 emin +[double]
  Lower energy limit (in TeV).
   
 emax +[double]
  Upper energy limit (in TeV).
   
 enumbins +[integer]
  Number of energy bins (0=unbinned).
   
 duration +[double]
  Effective exposure time (in seconds).
   
 (rad += 5.0) +[double]
  Radius of ROI (in degrees).
   
 (npix += 200) +[integer]
  Number of pixels for binned analysis.
   
 (binsz += 0.05) +[double]
  Pixel size for binned analysis.
   
+

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 += no) [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 21 December +2012 +

+
+ \ No newline at end of file diff --git a/doc/html/documentation.html b/doc/html/documentation.html index 7ce64d4..ca339bd 100644 --- a/doc/html/documentation.html +++ b/doc/html/documentation.html @@ -19,8 +19,17 @@ references
  • ctskymap

    • +

    cscripts +references +

    + +

    Last updated by: Jürgen -Knödlseder (18 December 2012) +Knödlseder (21 December 2012)

    \ No newline at end of file -- libgit2 0.21.4