include/N3AnaBase/cuts/tof_cut.h

// -*- mode: c++; -*-
// energy_cut.h

/* Description of the cut:
 *
 *  This cut propose different ways to check if some
 *  energy deposits in the scintillator blocks fall
 *  within some range:
 *
 *  Units:
 *
 *    Energy is given in keV
 *
 *  Energy range is defined via:
 *
 *    MIN == lower bound of the energy interval
 *    MAX == upper bound of the energy interval
 *
 *  Available modes:
 *
 *    ENERGY_MIN == check if the minimum energy deposit is in range
 *    ENERGY_MAX == check if the maximum energy deposit is in range
 *    ENERGY_SUM == check if the total energy deposit is in range
 *    ENERGY_EACH == check if each energy deposit is in range
 *
 *  The INVERTED flag check if the value is outside the given range
 *
 */

#ifndef __N3AnaBase__energy_cut_h
#define __N3AnaBase__energy_cut_h 1

#include <cstdlib>
#include <iostream>
#include <string>
#include <sstream>
#include <stdexcept>

#include <boost/numeric/interval.hpp>

#include <N3AnaBase/cuts/i_ana_event_cut.h>
#include <N3AnaBase/measurements/tof_tools.h>

namespace nemo3 {

  class tof_cut : public nemo3::i_ana_event_cut
    {
    public:
      enum mode_t
        {
          MODE_INVALID    = -1,
          MODE_INCLUSIVE  = 0,
          MODE_EXCLUSIVE  = 1,//mode externe ?
        };


      static const std::string INTERNAL_ELECTRON_CANDIDATE; // = "tof.internal_electron_candidate";
      static const std::string INTERNAL_GAMMA_CANDIDATE;    // = "tof.internal_gamma_candidate";

      static int get_mode_from_label (const std::string & label_);

      static std::string get_label_from_mode (int mode_);

      static bool is_mode_valid (int mode_);

      static std::ostream & print_NENG (std::ostream & out_,
                                        int NE_, int NG_,
                                        double proba_int_ee_, double proba_ext_ee_,
                                        double proba_int_eg_, double proba_ext_eg_);

    private:

      double  __NE;
      double  __NG;
      double  __NGT;
      double  __proba_int_ee;
      double  __proba_ext_ee;
      double  __proba_int_eg;
      double  __proba_ext_eg;
      double  __proba_int_gg;
      bool    __debug;
      int     __mode;
      std::string __tracking_name;
      tof_tools * __tof_tools;

    public:

      bool is_mode_inclusive () const;

      bool is_mode_exclusive () const;

      tof_cut (bool debug_ = false); // default ctor

      virtual ~tof_cut (); // dtor

      void set (int mode_, int ne_, int ng_, int ngt,
                double proba_int_ee_, double proba_ext_ee_,
                double proba_int_eg_, double proba_ext_eg_,
                double proba_int_gg_);

    public:

      bool is_debug () const;

      void set_debug (bool);

      void dump (std::ostream & out_ = std::clog) const;

    public:
      bool accept ();

    protected:
      virtual void __prepare_cut ();

    // used by the cuts' factory stuff:
    private:
      static creator_registration<tof_cut> __CR;

    public:

      static const std::string CUT_ID;

      virtual std::string cut_id () const;

      virtual cut_creator_t cut_creator () const;

      static nemo3::i_ana_event_cut * create (const nemocuts::ICutFactory::cut_properties_t & cut_properties_);

    };

} // end of namespace nemo3

#endif /* __N3AnaBase_energy__cut_h */

// end of tof_cut.h