MCBTAlg.h

Go to the documentation of this file.

/**
 * \file MCBTAlg.h
 *
 * \ingroup MCComp
 *
 * \brief Class def header for a class MCBTAlg
 *
 * @author littlejohn, kaleko, terao
 */

/** \addtogroup MCComp

    @{*/
#ifndef RECOTOOL_MCBTALG_H
#define RECOTOOL_MCBTALG_H

#include "lardataobj/Simulation/SimChannel.h"

#include <map>
#include <vector>

namespace detinfo {
  class DetectorClocksData;
}

/**
   \class MCBTAlg
   MCBTAlg is meant to back-track reco-ed hits/clusters to MCShower/MCTrack
 */

namespace btutil {

  struct WireRange_t {
    unsigned int ch;
    double start, end;
    WireRange_t()
    {
      ch = std::numeric_limits<unsigned int>::max();
      start = end = std::numeric_limits<double>::max();
    }
    WireRange_t(unsigned int c, double s, double e)
    {
      ch = c;
      start = s;
      end = e;
    }
  };

  typedef std::vector<double> edep_info_t; // vector of energy deposition

  typedef std::map<unsigned int, ::btutil::edep_info_t>
    ch_info_t; // vector of time (index) for each edep (value)

  class MCBTAlg {

  public:
    MCBTAlg() {}

    MCBTAlg(const std::vector<unsigned int>& g4_trackid_v,
            const std::vector<sim::SimChannel>& simch_v);

    void Reset(const std::vector<unsigned int>& g4_trackid_v,
               const std::vector<sim::SimChannel>& simch_v);

    void Reset(const std::vector<std::vector<unsigned int>>& g4_trackid_v,
               const std::vector<sim::SimChannel>& simch_v);

    /**
       Returns MC charge sum per MCX for a specified plane
     */
    const std::vector<double>& MCQSum(const size_t plane_id) const;

    /**
       Relate Hit => MCShower/MCTrack (called MCX).
       Returns a vector of double w/ length = # of relevant MCX + 1.
       Each entry is # drifted electrons from each relevant MCX.
       The last element contains a sum of drifted electrons that do not belong
       to any of relevant MCX.
    */
    std::vector<double> MCQ(detinfo::DetectorClocksData const& clockData,
                            const WireRange_t& hit) const;

    /**
       Relate Hit => MCX.
       Returns a vector of double w/ length = # of relevant MCXs + 1.
       Each entry is a fraction of # drifted electrons within the specified time
       range from each relevant MCX. The last element contains a sum of drifted
       electrons that do not belong to any of relevant MCX.
    */
    std::vector<double> MCQFrac(detinfo::DetectorClocksData const& clockData,
                                const WireRange_t& hit) const;

    /**
       Relate Cluster => MCX.
       Returns a vector of double w/ length = # of relevant MCXs + 1.
       Each entry is # drifted electrons from each relevant MCX.
       The last element contains a sum of drifted electrons that do not belong
       to any of relevant MCX.
    */
    std::vector<double> MCQ(detinfo::DetectorClocksData const& clockData,
                            const std::vector<btutil::WireRange_t>& hit_v) const;

    /**
       Relate Cluster => MCX.
       Returns a vector of double w/ length = # of relevant MCXs + 1.
       Each entry is a fraction of # drifted electrons within the specified time
       range from each relevant MCX. The last element contains a sum of drifted
       electrons that do not belong to any of relevant MCX.
    */
    std::vector<double> MCQFrac(detinfo::DetectorClocksData const& clockData,
                                const std::vector<btutil::WireRange_t>& hit_v) const;

    size_t Index(const unsigned int g4_track_id) const;

    size_t
    NumParts() const
    {
      return _num_parts - 1;
    }

  protected:
    void Register(const unsigned int& g4_track_id);

    void Register(const std::vector<unsigned int>& g4_track_id);

    void ProcessSimChannel(const std::vector<sim::SimChannel>& simch_v);

    std::vector<::btutil::ch_info_t> _event_info;
    std::vector<size_t> _trkid_to_index;
    std::vector<std::vector<double>> _sum_mcq;
    size_t _num_parts;
  };
}
#endif
/** @} */ // end of doxygen group