added documentation and cleaned up code

ldivenere
1 parent 41d52614
Showing 4 changed files with 91 additions and 18 deletions
doc/source/users/reference_manual/ctprob.rst
doc/source/users/reference_manual/index.rst
src/ctprob/ctprob.cpp
src/ctprob/ctprob.hpp
+	.. _ctprob:
+
+ctprob
+========
+
+Compute event probability for a given model.
+
+
+Synopsis
+--------
+
+This tool takes an event list file (or an XML observation file) and a source 
+model as input. For each event, it evalutes the probability for that event 
+to come from each of the source in the model. This probability is obtained 
+evaluating the differential expected counts for each source at the event 
+direction and energy and normalizing it to the total differential expected 
+counts for the given model. If only one source is provided in the model, 
+the probability is set to 1 for each photon.
+A column for each source in the model is added to the event list in order to 
+store these values. The name of each column is made by the source name with 
+the prefix "PROB_".
+
+
+General parameters
+------------------
+
+``inobs [file]``
+    Input event list or observation definition XML file
+ 	 	 
+``outobs [file]``
+    Output event list or observation definition XML file.
+ 	 	 
+``(prefix = "prob_") [string]``
+    Prefix for output event lists in observation definition file.
+ 	 	 
+``inmodel [string]``
+    Input model XML file.
+
+``caldb [string]``
+    Calibration database.
+ 	 	 
+``irf [string]``
+    Instrument response function.
+ 	 	 
+``(edisp = no) [boolean]``
+    Apply energy dispersion to response computation.
+
+
+Standard parameters
+-------------------
+
+``(publish = no) [boolean]``
+    Specifies whether the event list(s) should be published on VO Hub.
+
+``(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 existing output files should be overwritten.
+ 	 	 
+``(debug = no) [boolean]``
+    Enables debug mode. In debug mode the executable will dump any log file output to the console.
+ 	 	 
+``(mode = ql) [string]``
+    Mode of automatic parameters (default is "ql", i.e. "query and learn").
+
+``(logfile = ctlike.log) [string]``
+    Name of log file.
+
+
+Related tools or scripts
+------------------------
+
+:doc:`ctphase`
+:doc:`csphasecrv`
+
@@ -31,6 +31,7 @@ ctools
    ctskymap --- Generates sky map <ctskymap>
    cttsmap --- Generates Test Statistic map <cttsmap>
    ctulimit --- Calculates upper limit <ctulimit>
+   ctprob --- Computes event probability for a given model <ctprob>
 cscripts
@@ -673,11 +673,11 @@ void ctprob::get_obs(void)
  *
  *
  * For each event from the input event file evaluates the probability that
- * the event comes from any of the source in the input model. This is done 
- * by evaluating differential expected counts for the event direction and 
- * energy and normalizing it to the total differential expected counts for 
- * given model. If only one source is provided in the model, the probability
- * is set to 1. for each photon.
+ * the event comes from any of the source in the input model.  This is done 
+ * by evaluating the differential expected counts for each source at the event 
+ * direction and energy and normalizing it to the total differential expected 
+ * counts for the given model. If only one source is provided in the model, 
+ * the probability is set to 1 for each photon.
  *
  * A FITS column for each source in the model is created and added to 
  * the event list. The name of each column is made by the source name with 
@@ -87,14 +87,6 @@ protected:
     // User parameters
     std::string m_outobs;     //!< Output event list or XML file
     std::string m_prefix;     //!< Prefix for multiple event lists
-  //    bool        m_usepnt;     //!< Use pointing instead of RA/DEC parameters
-  //GCTARoi     m_roi;        //!< RoI selection
-  //double      m_tmin;       //!< Start time
-  //double      m_tmax;       //!< Stop time
-  //double      m_emin;       //!< Lower energy
-  //double      m_emax;       //!< Upper energy
-  //std::string m_expr;       //!< Selection expression
-  //std::string m_usethres;   //!< Energy threshold type
     bool        m_apply_edisp;  //!< Apply energy dispersion?
     bool        m_publish;      //!< Publish model cube?
     GChatter    m_chatter;    //!< Chattiness
@@ -103,11 +95,6 @@ protected:
     std::vector<std::string> m_infiles;       //!< Input event filenames
     std::vector<std::string> m_evtname;       //!< Event extension names
     std::vector<std::string> m_gtiname;       //!< GTI extension names
-  //GTime                    m_timemin;       //!< Earliest time
-  //GTime                    m_timemax;       //!< Latest time
-  //bool                     m_select_energy; //!< Perform energy selection
-  //bool                     m_select_roi;    //!< Perform RoI selection
-  //bool                     m_select_time;   //!< Perform time selection
 };