cmtool::CMatchManager Class Reference

#include <CMatchManager.h>

Inheritance diagram for cmtool::CMatchManager:

Public Member Functions
	CMatchManager (size_t nplanes)
virtual	~CMatchManager ()
	Default destructor. More...
virtual void	Reset ()
	Method to reset itself. More...
void	AddMatchAlgo (CFloatAlgoBase *algo)
	A simple method to add an algorithm for merging. More...
const CMatchBookKeeper &	GetBookKeeper () const
	A method to obtain book keeper. More...
Public Member Functions inherited from cmtool::CMManagerBase
	CMManagerBase ()
	Default constructor. More...
virtual	~CMManagerBase ()=default
	Default destructor. More...
void	DebugMode (CMMSGLevel_t level)
	Method to enable debug mode (lots of couts) More...
void	ReportTimings (bool time_report=true)
	Method to enable timing profile cout. More...
void	Reset ()
	Method to reset itself. More...
void	AddPriorityAlgo (CPriorityAlgoBase *algo)
	Setter to add an algorithm for priority determination. More...
void	MergeTillConverge (bool doit=true)
	Switch to continue merging till converges. More...
void	SetClusters (util::GeometryUtilities const &gser, const std::vector< std::vector< util::PxHit >> &clusters)
	A simple method to add a cluster. More...
void	SetClusters (const std::vector< cluster::ClusterParamsAlg > &clusters)
	A simple method to add a cluster. More...
const std::vector< cluster::ClusterParamsAlg > &	GetInputClusters () const
	A getter for input clusters. More...
void	SetMinNHits (unsigned int n)
	A setter for minimum # of hits ... passed onto ClusterParamsAlg. More...
void	Process (util::GeometryUtilities const &gser)
	A method to execute the main action, to be called per event. More...
void	SetAnaFile (TFile *fout)
	A setter for an analysis output file. More...

Protected Member Functions
virtual void	EventBegin ()
	FMWK function called @ beginning of Process() More...
virtual void	IterationBegin ()
	FMWK function called @ beginning of iterative loop inside Process() More...
virtual bool	IterationProcess (util::GeometryUtilities const &gser)
	FMWK function called @ iterative loop inside Process() More...
virtual void	IterationEnd ()
	FMWK function called @ end of iterative loop inside Process() More...
virtual void	EventEnd ()
	FMWK function called @ end of Process() More...
Protected Member Functions inherited from cmtool::CMManagerBase
void	ComputePriority (const std::vector< cluster::ClusterParamsAlg > &clusters)
	Function to compute priority. More...

Protected Attributes
CMatchBookKeeper	_book_keeper
	Book keeper instance. More...
::cmtool::CFloatAlgoBase *	_match_algo
	Merging algorithm. More...
size_t	_nplanes
	Number of planes. More...
Protected Attributes inherited from cmtool::CMManagerBase
bool	_time_report
	Timing verbosity flag. More...
unsigned int	_min_nhits
	Minimum number of hits: the limit set for ClusterParamsAlg. More...
CMMSGLevel_t	_debug_mode
	Debug mode switch. More...
std::vector< cluster::ClusterParamsAlg >	_in_clusters
	Input clusters. More...
::cmtool::CPriorityAlgoBase *	_priority_algo
	Priority algorithm. More...
TFile *	_fout
	Output analysis plot TFile. More...
std::multimap< float, size_t >	_priority
	Priority record. More...
bool	_merge_till_converge
	Iteration loop switch. More...
std::set< UChar_t >	_planes
	A holder for # of unique planes in the clusters, computed in ComputePriority() function. More...

Private Member Functions
	CMatchManager ()
	Default constructor is private because we need an argument to configure w/ # planes in the detector. More...

Additional Inherited Members
Public Types inherited from cmtool::CMManagerBase
enum	CMMSGLevel_t { kPerMerging, kPerIteration, kPerEvent, kNone }
	Enum to specify message output level. More...

Detailed Description

A class that instantiates merging algorithm(s) and run. The book-keeping of merged cluster sets are done by CMatchBookKeeper.

Definition at line 30 of file CMatchManager.h.

Constructor & Destructor Documentation

cmtool::CMatchManager::CMatchManager ( )

private

Default constructor is private because we need an argument to configure w/ # planes in the detector.

Definition at line 21 of file CMatchManager.cxx.

                               : CMManagerBase()
  {
    throw CMTException("Default ctor needs # planes as an argument!");
  }

cmtool::CMatchManager::CMatchManager

(

size_t

nplanes

)

Definition at line 26 of file CMatchManager.cxx.

                                             : CMManagerBase()
  {
    _match_algo = nullptr;
    _nplanes = nplanes;
    Reset();
  }

virtual cmtool::CMatchManager::~CMatchManager ( )

inlinevirtual

Default destructor.

Definition at line 40 of file CMatchManager.h.

{}

Member Function Documentation

void cmtool::CMatchManager::AddMatchAlgo ( CFloatAlgoBase *  algo )

inline

A simple method to add an algorithm for merging.

Definition at line 47 of file CMatchManager.h.

    {
      _match_algo = algo;
    }

void cmtool::CMatchManager::EventBegin ( )

protectedvirtual

FMWK function called @ beginning of Process()

Reimplemented from cmtool::CMManagerBase.

Definition at line 43 of file CMatchManager.cxx.

  {
    if (_debug_mode <= kPerMerging) {
      if (_match_algo) _match_algo->SetVerbose(true);
      if (_priority_algo) _priority_algo->SetVerbose(true);
    }

    _match_algo->IterationBegin(_in_clusters);
    if (_priority_algo) _priority_algo->IterationBegin(_in_clusters);
  }

void cmtool::CMatchManager::EventEnd ( )

protectedvirtual

FMWK function called @ end of Process()

Reimplemented from cmtool::CMManagerBase.

Definition at line 69 of file CMatchManager.cxx.

  {
    _match_algo->EventEnd();
    if (_priority_algo) _priority_algo->EventEnd();
  }

const CMatchBookKeeper& cmtool::CMatchManager::GetBookKeeper ( ) const

inline

A method to obtain book keeper.

Definition at line 54 of file CMatchManager.h.

    {
      return _book_keeper;
    }

void cmtool::CMatchManager::IterationBegin ( )

protectedvirtual

FMWK function called @ beginning of iterative loop inside Process()

Reimplemented from cmtool::CMManagerBase.

Definition at line 55 of file CMatchManager.cxx.

  {
    _match_algo->IterationBegin(_in_clusters);
    if (_priority_algo) _priority_algo->IterationBegin(_in_clusters);
  }

void cmtool::CMatchManager::IterationEnd ( )

protectedvirtual

FMWK function called @ end of iterative loop inside Process()

Reimplemented from cmtool::CMManagerBase.

Definition at line 62 of file CMatchManager.cxx.

  {
    _match_algo->IterationEnd();
    if (_priority_algo) _priority_algo->IterationEnd();
  }

bool cmtool::CMatchManager::IterationProcess ( util::GeometryUtilities const &  gser )

protectedvirtual

FMWK function called @ iterative loop inside Process()

Implements cmtool::CMManagerBase.

Definition at line 181 of file CMatchManager.cxx.

  {
    TStopwatch localWatch;

    //
    // Create plane-by-plane vectors
    //
    ComputePriority(_in_clusters);

    if (_planes.size() < 2) return false;

    if (_planes.size() > _nplanes)
      throw CMTException("Found more plane IDs than specified number of planes!");

    // Index array of clusters per plane
    std::vector<std::vector<size_t>> cluster_array;

    // Resize to # of planes w/ clusters
    cluster_array.reserve(_planes.size());

    // plane-to-index map
    std::vector<size_t> plane_to_index(_nplanes, _nplanes);

    // Fill plane-to-index map
    for (size_t plane = 0; plane < _nplanes; ++plane) {
      if (_planes.find(plane) != _planes.end()) {
        plane_to_index[plane] = cluster_array.size();

        cluster_array.push_back(std::vector<size_t>());
      }
    }

    // Fill cluster_array
    for (auto riter = _priority.rbegin(); riter != _priority.rend(); ++riter)
      cluster_array.at(plane_to_index.at(_in_clusters.at((*riter).second).Plane()))
        .push_back((*riter).second);

    // Find combinations
    std::vector<size_t> seed;
    seed.reserve(cluster_array.size());
    for (auto const& clusters_per_plane : cluster_array)
      seed.push_back(clusters_per_plane.size());

    auto const& combinations = PlaneClusterCombinations(seed);

    // Loop over combinations and call algorithm
    for (auto const& comb : combinations) {

      std::vector<const cluster::ClusterParamsAlg*> ptr_v;

      std::vector<unsigned int> tmp_index_v;
      tmp_index_v.reserve(comb.size());

      ptr_v.reserve(comb.size());

      for (auto const& plane_cluster : comb) {
        auto const& in_cluster_index =
          cluster_array.at(plane_cluster.first).at(plane_cluster.second);

        tmp_index_v.push_back(in_cluster_index);

        ptr_v.push_back(&(_in_clusters.at(in_cluster_index)));
      }

      if (_debug_mode <= kPerMerging) {
        std::cout << "    \033[93m"
                  << "Inspecting a pair (";
        for (auto const& index : tmp_index_v)
          std::cout << index << " ";
        std::cout << ") \033[00m" << std::flush;

        localWatch.Start();
      }

      auto const& score = _match_algo->Float(gser, ptr_v);

      if (_debug_mode <= kPerMerging)
        std::cout << " ... Time taken = " << localWatch.RealTime() << " [s]" << std::endl;

      if (score > 0) _book_keeper.Match(tmp_index_v, score);
    }

    if (_debug_mode <= kPerIteration) {
      if (_match_algo) _match_algo->Report();
      if (_priority_algo) _priority_algo->Report();
    }

    return false;
  }

void cmtool::CMatchManager::Reset ( void  )

virtual

Method to reset itself.

Definition at line 34 of file CMatchManager.cxx.

  {
    CMManagerBase::Reset();
    if (_match_algo) _match_algo->Reset();
    if (_priority_algo) _priority_algo->Reset();
    _book_keeper.Reset();
  }

Member Data Documentation

CMatchBookKeeper cmtool::CMatchManager::_book_keeper

protected

Book keeper instance.

Definition at line 81 of file CMatchManager.h.

::cmtool::CFloatAlgoBase* cmtool::CMatchManager::_match_algo

protected

Merging algorithm.

Definition at line 84 of file CMatchManager.h.

size_t cmtool::CMatchManager::_nplanes

protected

Number of planes.

Definition at line 87 of file CMatchManager.h.

---

The documentation for this class was generated from the following files:

• larreco/larreco/RecoAlg/CMTool/CMToolBase/CMatchManager.h
• larreco/larreco/RecoAlg/CMTool/CMToolBase/CMatchManager.cxx