Add event time classifier: update doc

Author: llebanowski

doc/users_guide/reconstruction.rst

@@ -220,22 +220,22 @@ Command:
 
 Parameters
 ''''''''''
-No parameters are required though a position reconstruction should be run before and a light speed is needed
-to calculate time residuals.  Several useful parameters can be set in macro, which allows the processor to be
-run multiple times with different settings in a single macro.  Detailed implementations are illustrated in
-macros/examples/classifytimes.mac
+No parameters are required though a position reconstruction should be run before (or a fixed position specified) and a
+light speed is needed to calculate time residuals.  The light speed and a time window for the ratio are specified in
+CLASSIFIER.ratdb.  Several useful parameters can be set in macro, which allows the processor to be run multiple times
+with different settings in a single macro.  Detailed implementations are illustrated in macros/examples/classifytimes.mac.
 
 =========================   ==========================  ===================
 **Field**                   **Type**                    **Description**
 =========================   ==========================  ===================
-``classifier_name``         ``string``                  Defaults to "classifytimes"
-``position_fitter``         ``string``                  Name of fitter providing position input
+``classifier_name``         ``string``                  Defaults to "classifytimes".
+``position_fitter``         ``string``                  Name of fitter providing position input.
 
 ``pmt_type``                ``int``                     PMT "type" to use.  Multiple types can be used.  Defaults to all types.
 ``verbose``                 ``int``                     FOM save option.  1 saves ``num_PMT``'s.  2 also saves ``time_resid_low`` and ``time_resid_up``
 
-``numer_time_resid_low``    ``double``                  Lower cut on time residuals in ns.  Used for ``ratio``.
-``numer_time_resid_up``     ``double``                  Upper cut on time residuals in ns.  Used for ``ratio``.
+``numer_time_resid_low``    ``double``                  Lower cut on time residuals in ns.  Used for ``ratio``.  Defaults to value in CLASSIFIER.ratdb.
+``numer_time_resid_up``     ``double``                  Upper cut on time residuals in ns.  Used for ``ratio``.  Defaults to value in CLASSIFIER.ratdb.
 
 ``denom_time_resid_low``    ``double``                  Lower cut on time residuals in ns.  Used for ``ratio``.  Defaults to full range.
 ``denom_time_resid_up``     ``double``                  Upper cut on time residuals in ns.  Used for ``ratio``.  Defaults to full range.
@@ -246,28 +246,28 @@ macros/examples/classifytimes.mac
 ``time_resid_frac_low``     ``double``                  Lower cut on time residuals as a fraction in [0.0, 1.0).  Option for central moments.
 ``time_resid_frac_up``      ``double``                  Upper cut on time residuals as a fraction in (0.0, 1.0].  Option for central moments.
 
-``light_speed``             ``double``                  Speed of light in material in mm/ns.  Defaults to water.
+``light_speed``             ``double``                  Speed of light in material in mm/ns.  Defaults to water value in CLASSIFIER.ratdb.
 
-``event_position_x``        ``double``                  Fixed position of event in mm
-``event_position_y``        ``double``                  Fixed position of event in mm
-``event_position_z``        ``double``                  Fixed position of event in mm
+``event_position_x``        ``double``                  Fixed position of event in mm.
+``event_position_y``        ``double``                  Fixed position of event in mm.
+``event_position_z``        ``double``                  Fixed position of event in mm.
 
-``event_time``              ``double``                  Fixed offset of time residuals in ns
+``event_time``              ``double``                  Fixed offset of time residuals in ns.
 =========================   ==========================  ===================
 
 Classifier information in data structure
 ''''''''''''''''''''''''''''''''''''''''''
 * name - ``classifytimes``
 * classifier result - ``ratio`` is the ratio of the numbers of PMTs selected by specified time windows
-* classifier result - ``mean`` is the mean time within a specified time window
-* classifier result - ``stddev`` is the unbiased standard deviation of times within a specified time window
-* classifier result - ``skewness`` is the standardized unbiased skewness of times within a specified time window
-* classifier result - ``kurtosis`` is the standardized unbiased excess kurtosis of times within a specified time window
-* classifier result - ``num_PMT`` is the number of PMTs used in a reconstruction
-* classifier result - ``num_PMT_numer`` is the number of PMTs used in a reconstruction
-* classifier result - ``num_PMT_denom`` is the number of PMTs used in a reconstruction
-* classifier result - ``time_resid_low`` is the earliest time residual that passes the lower time residual cut
-* classifier result - ``time_resid_up`` is the latest time residual that passes the upper time residual cut
+* classifier result - ``mean`` is the mean time within the time window for central moments
+* classifier result - ``stddev`` is the unbiased standard deviation of times within the time window for central moments
+* classifier result - ``skewness`` is the standardized unbiased skewness of times within the time window for central moments
+* classifier result - ``kurtosis`` is the standardized unbiased excess kurtosis of times within the time window for central moments
+* classifier result - ``num_PMT`` is the number of PMTs used in the central moment calculations
+* classifier result - ``num_PMT_numer`` is the number of PMTs used in the numerator of the ratio
+* classifier result - ``num_PMT_denom`` is the number of PMTs used in the denominator of the ratio
+* classifier result - ``time_resid_low`` is the earliest time residual in the time window for central moments
+* classifier result - ``time_resid_up`` is the latest time residual in the time window for central moments
 
 ----------------------