CBAlgoStartTrack.h

Go to the documentation of this file.

/**
 * \file CBAlgoStartTrack.h
 *
 * \ingroup CMTool
 *
 * \brief This merge algo is looking for short tracks from the
 *        start of a shower that are overlapping a blob that is
 *        a cluster belonging to the same shower.
 *
 * @author davidkaleko
 */

/** \addtogroup CMTool

    @{*/
#ifndef RECOTOOL_CBALGOSTARTTRACK_H
#define RECOTOOL_CBALGOSTARTTRACK_H

#include "larreco/RecoAlg/CMTool/CMToolBase/CBoolAlgoBase.h"
#include "larreco/RecoAlg/ClusterRecoUtil/ClusterParamsAlg.h"

namespace cmtool {
  /**
     \class CBAlgoStartTrack
     User implementation for CBoolAlgoBase class
     doxygen documentation!
  */
  class CBAlgoStartTrack : public CBoolAlgoBase {

  public:

    /// Default constructor
    CBAlgoStartTrack();

    /// Default destructor
    virtual ~CBAlgoStartTrack(){};

    /**
       Optional function: called at the beginning of 1st iteration. This is called per event.
     */
    //virtual void EventBegin(const std::vector<cluster::ClusterParamsAlg> &clusters);

    /**
       Optional function: called at the end of event ... after the last merging iteration is over.
     */
    //virtual void EventEnd();

    /**
       Optional function: called at the beggining of each iteration over all pairs of clusters.
       This provides all clusters' information in case the algorithm need them. Note this
       is called per iteration which may be more than once per event.
     */
    //virtual void IterationBegin(const std::vector<cluster::ClusterParamsAlg> &clusters);

    /**
       Optional function: called at the end of each iteration over all pairs of clusters.
     */
    //virtual void IterationEnd();

    /**
       Core function: given the CPAN input, return whether a cluster should be
       merged or not.
    */
    virtual bool Bool(const ::cluster::ClusterParamsAlg &cluster1,
                      const ::cluster::ClusterParamsAlg &cluster2);

    /**
       Optional function: called after each Merge() function call by CMergeManager IFF
       CMergeManager is run with verbosity level kPerMerging. Maybe useful for debugging.
    */
    virtual void Report();

    /// Function to reset the algorithm instance ... maybe implemented via child class
    virtual void Reset();

    bool IsStartTrack(const ::cluster::ClusterParamsAlg &cluster);

    bool IsOverlappingBlob(const ::cluster::ClusterParamsAlg &cluster);

    void SetMinWidth(double value) { _min_width = value; }

    void SetMinOpeningAngle(double value) { _min_opening_angle = value; }

    void SetMinEP(double value) { _min_EP = value; }

    void SetMinHits(size_t value) { _min_hits = value; }

    void SetDebug(bool flag) { _debug = flag; }

  protected:

    size_t _min_hits;
    double _min_width, _min_opening_angle, _min_EP;
    bool _debug;

  };
}
#endif
/** @} */ // end of doxygen group