CMAlgoBase.h

Go to the documentation of this file.

/**
 * \file CMAlgoBase.h
 *
 * \ingroup CMTool
 *
 * \brief Class def header for a class CMAlgoBase
 *
 * @author kazuhiro
 */

/** \addtogroup CMTool

    @{*/
#ifndef RECOTOOL_CMALGOBASE_H
#define RECOTOOL_CMALGOBASE_H

#include "larreco/RecoAlg/ClusterRecoUtil/ClusterParamsAlg.h"
#include <vector>

class TFile;

namespace cmtool {

  /**
     \class CMAlgoBase
     An abstract base class for merging/matching algorithm. Having this base class helps
     to have a better overall design of various merging for iterative approach.
     The algorithms are run through CMergeManager.
  */
  class CMAlgoBase {
  public:
    CMAlgoBase()
    {
      _fout = 0;
      _verbose = false;
    }
    virtual ~CMAlgoBase() = default;

    /// Function to reset the algorithm instance called within CMergeManager/CMatchManager's Reset() ... maybe implemented via child class
    virtual void
    Reset()
    {}

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

    /**
       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>&)
    {}

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

    /**
       Optional function: called after Bool() function is called for all possible cluster
       pairs by CMergeManager/CMatchManager IFF run with verbosity level kPerIteration.
       Maybe useful for debugging.
     */
    virtual void
    Report()
    {}

    /// Setter function for an output plot TFile pointer
    void
    SetAnaFile(TFile* fout)
    {
      _fout = fout;
    }

    /// Setter function for verbosity
    virtual void
    SetVerbose(bool doit = true)
    {
      _verbose = doit;
    }

  protected:
    /// TFile pointer to an output file
    TFile* _fout;

    /// Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager's verbosity level is >= kPerMerging
    bool _verbose;
  };

}

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