cmtool::CMatchManager Class Reference

#include "CMatchManager.h"

Inheritance diagram for cmtool::CMatchManager:

Public Types
enum	CMMSGLevel_t { kPerMerging, kPerIteration, kPerEvent, kNone }
	Enum to specify message output level. More...

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...
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	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...
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...
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...

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.

Member Enumeration Documentation

enum cmtool::CMManagerBase::CMMSGLevel_t

inherited

Enum to specify message output level.

Enumerator
kPerMerging	Extremely verbose (cout per individual algorithm execution)
kPerIteration	Somewhat verbose (cout per merging iteration)
kPerEvent	Bit verbose (cout per event)
kNone	Normal.

Definition at line 44 of file CMManagerBase.h.

                      {
      kPerMerging,
      kPerIteration,
      kPerEvent,
      kNone
    };

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.

References _match_algo, _nplanes, and Reset().

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

virtual cmtool::CMatchManager::~CMatchManager ( )

inlinevirtual

Default destructor.

Definition at line 40 of file CMatchManager.h.

References Reset().

{}

Member Function Documentation

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

inline

A simple method to add an algorithm for merging.

Definition at line 46 of file CMatchManager.h.

References _match_algo.

Referenced by ShowerReco3D::ShowerReco3D().

{ _match_algo = algo; }

void cmtool::CMManagerBase::AddPriorityAlgo ( CPriorityAlgoBase *  algo )

inlineinherited

Setter to add an algorithm for priority determination.

Definition at line 71 of file CMManagerBase.h.

Referenced by ShowerReco3D::ShowerReco3D().

{ _priority_algo = algo; }

void cmtool::CMManagerBase::ComputePriority ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

protectedinherited

Function to compute priority.

Definition at line 155 of file CMManagerBase.cxx.

References cmtool::CMManagerBase::_planes, cmtool::CMManagerBase::_priority, cmtool::CMManagerBase::_priority_algo, cmtool::CMManagerBase::_time_report, and cmtool::CPriorityAlgoBase::Priority().

Referenced by IterationProcess(), and cmtool::CMergeManager::IterationProcess().

  {

    TStopwatch localWatch;
    localWatch.Start();

    _priority.clear();
    _planes.clear();

    if (!clusters.size()) return;

    // Priority is computed cluster-by-cluster. In case of two clusters having the same priority
    // value the one with lower cluster index gets the priority. Also, clusters with priority < 0
    // are not logged (assumed not to be used)

    for (size_t i = 0; i < clusters.size(); ++i) {

      size_t c_index = clusters.size() - i - 1;

      float priority = clusters.at(c_index).GetNHits();

      if (_priority_algo) { priority = _priority_algo->Priority(clusters.at(c_index)); }

      if (priority > 0) {

        _priority.insert(std::make_pair(priority, c_index));

        if (_planes.find(clusters.at(c_index).Plane()) == _planes.end())

          _planes.insert(clusters.at(c_index).Plane());
      }
    }

    if (_time_report)
      std::cout << Form("  CMManagerBase Time Report: ComputePriority = %g [s]",
                        localWatch.RealTime())
                << std::endl;
  }

void cmtool::CMManagerBase::DebugMode ( CMMSGLevel_t  level )

inlineinherited

Method to enable debug mode (lots of couts)

Definition at line 62 of file CMManagerBase.h.

{ _debug_mode = level; }

void cmtool::CMatchManager::EventBegin ( )

protectedvirtual

FMWK function called @ beginning of Process()

Reimplemented from cmtool::CMManagerBase.

Definition at line 41 of file CMatchManager.cxx.

References cmtool::CMManagerBase::_debug_mode, cmtool::CMManagerBase::_in_clusters, _match_algo, cmtool::CMManagerBase::_priority_algo, cmtool::CMAlgoBase::IterationBegin(), cmtool::CMManagerBase::kPerMerging, and cmtool::CMAlgoBase::SetVerbose().

Referenced by GetBookKeeper().

  {
    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 64 of file CMatchManager.cxx.

References _match_algo, cmtool::CMManagerBase::_priority_algo, and cmtool::CMAlgoBase::EventEnd().

Referenced by GetBookKeeper().

  {
    _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 49 of file CMatchManager.h.

References _book_keeper, EventBegin(), EventEnd(), IterationBegin(), IterationEnd(), and IterationProcess().

Referenced by showerreco::ShowerRecoManager::Reconstruct().

{ return _book_keeper; }

const std::vector<cluster::ClusterParamsAlg>& cmtool::CMManagerBase::GetInputClusters ( ) const

inlineinherited

A getter for input clusters.

Definition at line 84 of file CMManagerBase.h.

Referenced by showerreco::ShowerRecoManager::Process().

{ return _in_clusters; }

void cmtool::CMatchManager::IterationBegin ( )

protectedvirtual

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

Reimplemented from cmtool::CMManagerBase.

Definition at line 52 of file CMatchManager.cxx.

References cmtool::CMManagerBase::_in_clusters, _match_algo, cmtool::CMManagerBase::_priority_algo, and cmtool::CMAlgoBase::IterationBegin().

Referenced by GetBookKeeper().

  {
    _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 58 of file CMatchManager.cxx.

References _match_algo, cmtool::CMManagerBase::_priority_algo, and cmtool::CMAlgoBase::IterationEnd().

Referenced by GetBookKeeper().

  {
    _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 172 of file CMatchManager.cxx.

References _book_keeper, cmtool::CMManagerBase::_debug_mode, cmtool::CMManagerBase::_in_clusters, _match_algo, _nplanes, cmtool::CMManagerBase::_planes, cmtool::CMManagerBase::_priority, cmtool::CMManagerBase::_priority_algo, cmtool::CMManagerBase::ComputePriority(), cmtool::CFloatAlgoBase::Float(), cmtool::CMManagerBase::kPerIteration, cmtool::CMManagerBase::kPerMerging, cmtool::CMatchBookKeeper::Match(), cmtool::PlaneClusterCombinations(), cmtool::CMAlgoBase::Report(), and seed.

Referenced by GetBookKeeper().

  {
    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::CMManagerBase::MergeTillConverge ( bool  doit = true )

inlineinherited

Switch to continue merging till converges.

Definition at line 74 of file CMManagerBase.h.

References lar::dump::vector().

{ _merge_till_converge = doit; }

void cmtool::CMManagerBase::Process ( util::GeometryUtilities const &  gser )

inherited

A method to execute the main action, to be called per event.

Definition at line 89 of file CMManagerBase.cxx.

References cmtool::CMManagerBase::_debug_mode, cmtool::CMManagerBase::_in_clusters, cmtool::CMManagerBase::_merge_till_converge, cmtool::CMManagerBase::_time_report, cmtool::CMManagerBase::EventBegin(), cmtool::CMManagerBase::EventEnd(), cmtool::CMManagerBase::IterationBegin(), cmtool::CMManagerBase::IterationEnd(), cmtool::CMManagerBase::IterationProcess(), and cmtool::CMManagerBase::kPerIteration.

Referenced by cluster::ClusterMergeHelper::Process(), and showerreco::ShowerRecoManager::Reconstruct().

  {

    if (!(_in_clusters.size())) return;

    TStopwatch localWatch;

    localWatch.Start();

    EventBegin();

    if (_time_report)
      std::cout << Form("  CMManagerBase Time Report: EventBegin = %g [s]", localWatch.RealTime())
                << std::endl;

    bool keep_going = true;

    while (keep_going) {

      localWatch.Start();

      IterationBegin();

      if (_time_report)
        std::cout << Form("  CMManagerBase Time Report: IterationBegin = %g [s]",
                          localWatch.RealTime())
                  << std::endl;

      localWatch.Start();

      keep_going = IterationProcess(gser);

      if (_time_report)
        std::cout << Form("  CMManagerBase Time Report: IterationProcess = %g [s]",
                          localWatch.RealTime())
                  << std::endl;
      localWatch.Start();

      IterationEnd();

      if (_time_report)
        std::cout << Form("  CMManagerBase Time Report: IterationEnd = %g [s]",
                          localWatch.RealTime())
                  << std::endl;

      if (!_merge_till_converge) {

        if (_debug_mode <= kPerIteration)

          std::cout
            << "\033[93m  Iterative approach = OFF ... exiting from iteration loop. \033[00m"
            << std::endl;

        break;
      }
    }

    localWatch.Start();

    EventEnd();

    if (_time_report)
      std::cout << Form("  CMManagerBase Time Report: EventEnd = %g [s]", localWatch.RealTime())
                << std::endl;
  }

void cmtool::CMManagerBase::ReportTimings ( bool  time_report = true )

inlineinherited

Method to enable timing profile cout.

Definition at line 65 of file CMManagerBase.h.

References Reset().

{ _time_report = time_report; }

void cmtool::CMatchManager::Reset ( )

virtual

Method to reset itself.

Definition at line 33 of file CMatchManager.cxx.

References _book_keeper, _match_algo, cmtool::CMManagerBase::_priority_algo, cmtool::CMatchBookKeeper::Reset(), cmtool::CMAlgoBase::Reset(), and cmtool::CMManagerBase::Reset().

Referenced by CMatchManager(), showerreco::ShowerRecoManager::Reset(), and ~CMatchManager().

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

void cmtool::CMManagerBase::SetAnaFile ( TFile *  fout )

inlineinherited

A setter for an analysis output file.

Definition at line 93 of file CMManagerBase.h.

{ _fout = fout; }

void cmtool::CMManagerBase::SetClusters ( util::GeometryUtilities const &  gser, const std::vector< std::vector< util::PxHit >> &  clusters  )

inherited

A simple method to add a cluster.

Definition at line 34 of file CMManagerBase.cxx.

References cmtool::CMManagerBase::_in_clusters, cmtool::CMManagerBase::_min_nhits, cmtool::CMManagerBase::_time_report, Initialize(), cmtool::CMManagerBase::Reset(), cluster::ClusterParamsAlg::SetMinNHits(), and cluster::ClusterParamsAlg::SetVerbose().

Referenced by showerreco::ShowerRecoManager::Reconstruct().

  {

    TStopwatch localWatch;

    // Reset
    this->Reset();

    // Clear & fill cluster info

    _in_clusters.clear();

    _in_clusters.reserve(clusters.size());

    ::cluster::ClusterParamsAlg tmp_alg;
    tmp_alg.SetMinNHits(_min_nhits);
    tmp_alg.SetVerbose(false);

    for (auto const& c : clusters) {

      _in_clusters.push_back(tmp_alg);
      (*_in_clusters.rbegin()).Initialize();

      if ((*_in_clusters.rbegin()).SetHits(c) < 3) continue;
      (*_in_clusters.rbegin()).DisableFANN();
      (*_in_clusters.rbegin()).FillParams(gser, false, false, false, false, false, false);
      (*_in_clusters.rbegin()).FillPolygon(gser);
    }

    if (_time_report) {
      std::cout << Form("  CMManagerBase Time Report: SetClusters (CPAN computation) = %g [s]",
                        localWatch.RealTime())
                << " ... details below." << std::endl;

      for (auto const& c : _in_clusters)

        c.TimeReport(std::cout);
    }
  }

void cmtool::CMManagerBase::SetClusters ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

inherited

A simple method to add a cluster.

Definition at line 75 of file CMManagerBase.cxx.

References cmtool::CMManagerBase::_in_clusters, and cmtool::CMManagerBase::_time_report.

  {
    TStopwatch localWatch;

    localWatch.Start();

    _in_clusters = clusters;

    if (_time_report)
      std::cout << Form("  CMManagerBase Time Report: SetClusters (copy) = %g [s]",
                        localWatch.RealTime())
                << std::endl;
  }

void cmtool::CMManagerBase::SetMinNHits ( unsigned int  n )

inlineinherited

A setter for minimum # of hits ... passed onto ClusterParamsAlg.

Definition at line 87 of file CMManagerBase.h.

References n.

{ _min_nhits = n; }

Member Data Documentation

CMatchBookKeeper cmtool::CMatchManager::_book_keeper

protected

Book keeper instance.

Definition at line 73 of file CMatchManager.h.

Referenced by GetBookKeeper(), IterationProcess(), and Reset().

CMMSGLevel_t cmtool::CMManagerBase::_debug_mode

protectedinherited

Debug mode switch.

Definition at line 122 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::CMManagerBase(), EventBegin(), cmtool::CMergeManager::EventBegin(), cmtool::CMergeManager::IterationBegin(), cmtool::CMergeManager::IterationEnd(), IterationProcess(), cmtool::CMergeManager::IterationProcess(), cmtool::CMManagerBase::Process(), cmtool::CMergeManager::RunMerge(), and cmtool::CMergeManager::RunSeparate().

TFile* cmtool::CMManagerBase::_fout

protectedinherited

Output analysis plot TFile.

Definition at line 131 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::CMManagerBase(), and cmtool::CMergeManager::EventBegin().

std::vector<cluster::ClusterParamsAlg> cmtool::CMManagerBase::_in_clusters

protectedinherited

Input clusters.

Definition at line 125 of file CMManagerBase.h.

Referenced by EventBegin(), cmtool::CMergeManager::EventBegin(), IterationBegin(), cmtool::CMergeManager::IterationBegin(), IterationProcess(), cmtool::CMergeManager::IterationProcess(), cmtool::CMManagerBase::Process(), cmtool::CMManagerBase::Reset(), and cmtool::CMManagerBase::SetClusters().

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

protected

Merging algorithm.

Definition at line 76 of file CMatchManager.h.

Referenced by AddMatchAlgo(), CMatchManager(), EventBegin(), EventEnd(), IterationBegin(), IterationEnd(), IterationProcess(), and Reset().

bool cmtool::CMManagerBase::_merge_till_converge

protectedinherited

Iteration loop switch.

Definition at line 137 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::CMManagerBase(), cmtool::CMergeManager::IterationEnd(), and cmtool::CMManagerBase::Process().

unsigned int cmtool::CMManagerBase::_min_nhits

protectedinherited

Minimum number of hits: the limit set for ClusterParamsAlg.

Definition at line 119 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::CMManagerBase(), and cmtool::CMManagerBase::SetClusters().

size_t cmtool::CMatchManager::_nplanes

protected

Number of planes.

Definition at line 79 of file CMatchManager.h.

Referenced by CMatchManager(), and IterationProcess().

std::set<UChar_t> cmtool::CMManagerBase::_planes

protectedinherited

A holder for # of unique planes in the clusters, computed in ComputePriority() function.

Definition at line 140 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::ComputePriority(), IterationProcess(), cmtool::CMergeManager::IterationProcess(), and cmtool::CMManagerBase::Reset().

std::multimap<float, size_t> cmtool::CMManagerBase::_priority

protectedinherited

Priority record.

Definition at line 134 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::ComputePriority(), IterationProcess(), and cmtool::CMergeManager::RunMerge().

::cmtool::CPriorityAlgoBase* cmtool::CMManagerBase::_priority_algo

protectedinherited

Priority algorithm.

Definition at line 128 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::CMManagerBase(), cmtool::CMManagerBase::ComputePriority(), EventBegin(), cmtool::CMergeManager::EventBegin(), EventEnd(), cmtool::CMergeManager::EventEnd(), IterationBegin(), cmtool::CMergeManager::IterationBegin(), IterationEnd(), cmtool::CMergeManager::IterationEnd(), IterationProcess(), Reset(), and cmtool::CMManagerBase::Reset().

bool cmtool::CMManagerBase::_time_report

protectedinherited

Timing verbosity flag.

Definition at line 116 of file CMManagerBase.h.

Referenced by cmtool::CMManagerBase::CMManagerBase(), cmtool::CMManagerBase::ComputePriority(), cmtool::CMManagerBase::Process(), and cmtool::CMManagerBase::SetClusters().

---

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

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