cmtool::CMergeManager Class Reference

#include "CMergeManager.h"

Inheritance diagram for cmtool::CMergeManager:

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

Public Member Functions
	CMergeManager ()
	Default constructor. More...
virtual	~CMergeManager ()
	Default destructor. More...
virtual void	Reset ()
	Method to reset itself. More...
void	AddMergeAlgo (CBoolAlgoBase *algo)
	A simple method to add an algorithm for merging. More...
void	AddSeparateAlgo (CBoolAlgoBase *algo)
	A simple method to add an algorithm for separation. More...
const std::vector< cluster::ClusterParamsAlg > &	GetClusters () const
	A method to obtain output clusters. More...
const CMergeBookKeeper &	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 (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 ()
	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 ()
	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	RunMerge (const std::vector< cluster::ClusterParamsAlg > &in_clusters, CMergeBookKeeper &book_keeper) const
void	RunMerge (const std::vector< cluster::ClusterParamsAlg > &in_clusters, const std::vector< bool > &merge_flag, CMergeBookKeeper &book_keeper) const
void	RunSeparate (const std::vector< cluster::ClusterParamsAlg > &in_clusters, CMergeBookKeeper &book_keeper) const
void	ComputePriority (const std::vector< cluster::ClusterParamsAlg > &clusters)
	Function to compute priority. More...

Protected Attributes
std::vector< cluster::ClusterParamsAlg >	_out_clusters
	Output clusters. More...
CMergeBookKeeper	_book_keeper
	Book keeper instance. More...
::cmtool::CBoolAlgoBase *	_merge_algo
	Merging algorithm. More...
::cmtool::CBoolAlgoBase *	_separate_algo
	Separation algorithm. More...
size_t	_iter_ctr
std::vector< CMergeBookKeeper >	_book_keeper_v
std::vector< std::vector< unsigned short > >	_tmp_merged_indexes
std::vector< cluster::ClusterParamsAlg >	_tmp_merged_clusters
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...

Detailed Description

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

Definition at line 30 of file CMergeManager.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 34 of file CMManagerBase.h.

                      {
      kPerMerging,
      kPerIteration,
      kPerEvent,
      kNone
    };

Constructor & Destructor Documentation

cmtool::CMergeManager::CMergeManager

(

)

Default constructor.

Definition at line 8 of file CMergeManager.cxx.

References _iter_ctr, _merge_algo, _separate_algo, and Reset().

                               : CMManagerBase()
  {
    _iter_ctr=0;
    _merge_algo = nullptr;
    _separate_algo = nullptr;
    Reset();
  }

virtual cmtool::CMergeManager::~CMergeManager ( )

inlinevirtual

Default destructor.

Definition at line 38 of file CMergeManager.h.

References Reset().

{}

Member Function Documentation

void cmtool::CMergeManager::AddMergeAlgo ( CBoolAlgoBase *  algo )

inline

A simple method to add an algorithm for merging.

Definition at line 44 of file CMergeManager.h.

References _merge_algo.

Referenced by cluster::FuzzyClusterMerger::FuzzyClusterMerger(), and cluster::SimpleClusterMerger::SimpleClusterMerger().

{_merge_algo = algo;}

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

inlineinherited

Setter to add an algorithm for priority determination.

Definition at line 63 of file CMManagerBase.h.

References cmtool::CMManagerBase::_priority_algo.

Referenced by cluster::FuzzyClusterMerger::FuzzyClusterMerger(), and ShowerReco3D::ShowerReco3D().

{ _priority_algo = algo; }

void cmtool::CMergeManager::AddSeparateAlgo ( CBoolAlgoBase *  algo )

inline

A simple method to add an algorithm for separation.

Definition at line 47 of file CMergeManager.h.

References _separate_algo.

Referenced by cluster::FuzzyClusterMerger::FuzzyClusterMerger(), and cluster::SimpleClusterMerger::SimpleClusterMerger().

{_separate_algo = algo;}

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

protectedinherited

Function to compute priority.

Definition at line 147 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 cmtool::CMatchManager::IterationProcess(), IterationProcess(), and cmtool::CMManagerBase::SetAnaFile().

                                                                                        {

    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 54 of file CMManagerBase.h.

References cmtool::CMManagerBase::_debug_mode.

Referenced by cluster::SimpleClusterMerger::SimpleClusterMerger().

{_debug_mode=level;}

void cmtool::CMergeManager::EventBegin ( )

protectedvirtual

FMWK function called @ beginning of Process()

Reimplemented from cmtool::CMManagerBase.

Definition at line 30 of file CMergeManager.cxx.

References _book_keeper, _book_keeper_v, cmtool::CMManagerBase::_debug_mode, cmtool::CMManagerBase::_fout, cmtool::CMManagerBase::_in_clusters, _iter_ctr, _merge_algo, cmtool::CMManagerBase::_priority_algo, _separate_algo, _tmp_merged_clusters, _tmp_merged_indexes, cmtool::CMAlgoBase::EventBegin(), cmtool::CMManagerBase::kPerMerging, cmtool::CMergeBookKeeper::Reset(), cmtool::CMAlgoBase::SetAnaFile(), and cmtool::CMAlgoBase::SetVerbose().

Referenced by GetBookKeeper().

  {
    // Initialization per event
    if(!_merge_algo) throw CMTException("No algorithm to run!");

    // Merging algorithm
    _merge_algo->SetAnaFile(_fout);
    _merge_algo->EventBegin(_in_clusters);

    // Separation algorithm
    if(_separate_algo) {
      _separate_algo->SetAnaFile(_fout);
      _separate_algo->EventBegin(_in_clusters);
    }

    // Priority ordering algorithm
    if(_priority_algo) {
      _priority_algo->SetAnaFile(_fout);
      _priority_algo->EventBegin(_in_clusters);
    }

    // Verbosity setting
    if(_debug_mode <= kPerMerging) {
      _merge_algo->SetVerbose(true);
      if(_separate_algo) _separate_algo->SetVerbose(true);
      if(_priority_algo) _priority_algo->SetVerbose(true);
    }
    
    // Book keeper reinitialization
    _book_keeper.Reset(_in_clusters.size());

    // Clear temporary variables
    _iter_ctr = 0;
    _tmp_merged_clusters.clear();
    _tmp_merged_indexes.clear();
    _book_keeper_v.clear();

  }

void cmtool::CMergeManager::EventEnd ( )

protectedvirtual

FMWK function called @ end of Process()

Reimplemented from cmtool::CMManagerBase.

Definition at line 138 of file CMergeManager.cxx.

References _book_keeper, _book_keeper_v, _merge_algo, cmtool::CMManagerBase::_priority_algo, _separate_algo, _tmp_merged_clusters, _tmp_merged_indexes, cmtool::CMergeBookKeeper::Combine(), and cmtool::CMAlgoBase::EventEnd().

Referenced by GetBookKeeper().

  {
    // Gather the full book keeping result
    for(auto const& bk : _book_keeper_v)

      _book_keeper.Combine(bk);

    // Call EventEnd for algorithms
    _merge_algo->EventEnd();
    if(_separate_algo) _separate_algo->EventEnd();
    if(_priority_algo) _priority_algo->EventEnd();

    _book_keeper_v.clear();
    _tmp_merged_clusters.clear();
    _tmp_merged_indexes.clear();
  }

const CMergeBookKeeper& cmtool::CMergeManager::GetBookKeeper ( ) const

inline

A method to obtain book keeper.

Definition at line 53 of file CMergeManager.h.

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

Referenced by cluster::ClusterMergeHelper::Process().

{ return _book_keeper; }

const std::vector<cluster::ClusterParamsAlg>& cmtool::CMergeManager::GetClusters ( ) const

inline

A method to obtain output clusters.

Definition at line 50 of file CMergeManager.h.

References _out_clusters.

Referenced by cluster::ClusterMergeHelper::GetMergedCPAN(), and cluster::ClusterMergeHelper::Process().

{ return _out_clusters; }

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

inlineinherited

A getter for input clusters.

Definition at line 76 of file CMManagerBase.h.

References cmtool::CMManagerBase::_in_clusters.

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

    { return _in_clusters; }

void cmtool::CMergeManager::IterationBegin ( )

protectedvirtual

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

Reimplemented from cmtool::CMManagerBase.

Definition at line 70 of file CMergeManager.cxx.

References cmtool::CMManagerBase::_debug_mode, cmtool::CMManagerBase::_in_clusters, _iter_ctr, _merge_algo, _out_clusters, cmtool::CMManagerBase::_priority_algo, _separate_algo, _tmp_merged_clusters, cmtool::CMAlgoBase::IterationBegin(), and cmtool::CMManagerBase::kPerIteration.

Referenced by GetBookKeeper().

  {

    if(!_iter_ctr) {

      _merge_algo->IterationBegin(_in_clusters);
      if(_separate_algo) _separate_algo->IterationBegin(_in_clusters);
      if(_priority_algo) _priority_algo->IterationBegin(_in_clusters);

    }else{

      _merge_algo->IterationBegin(_in_clusters);
      if(_separate_algo) _separate_algo->IterationBegin(_out_clusters);
      if(_priority_algo) _priority_algo->IterationBegin(_out_clusters);

    }

    if(_debug_mode <= kPerIteration) {
      
      size_t nclusters = _tmp_merged_clusters.size();

      if(!_iter_ctr) nclusters = _in_clusters.size();
      
      std::cout 
        << std::endl
        << Form("  Merging iteration %zu: processing %zu clusters...",_iter_ctr,nclusters)
        << std::endl;

    }

  }

void cmtool::CMergeManager::IterationEnd ( )

protectedvirtual

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

Reimplemented from cmtool::CMManagerBase.

Definition at line 103 of file CMergeManager.cxx.

References cmtool::CMManagerBase::_debug_mode, _iter_ctr, _merge_algo, cmtool::CMManagerBase::_merge_till_converge, _out_clusters, cmtool::CMManagerBase::_priority_algo, _separate_algo, _tmp_merged_clusters, cmtool::CMAlgoBase::IterationEnd(), cmtool::CMManagerBase::kPerIteration, and cmtool::CMAlgoBase::Report().

Referenced by GetBookKeeper().

  {

    _merge_algo->IterationEnd();
    if(_separate_algo) _separate_algo->IterationEnd();
    if(_priority_algo) _priority_algo->IterationEnd();

    if(_debug_mode <= kPerIteration) {

      _merge_algo->Report();
      if(_separate_algo) _separate_algo->Report();
      if(_priority_algo) _priority_algo->Report();

      std::cout
        << Form("  Input / Output cluster length: %zu/%zu",_tmp_merged_clusters.size(),_out_clusters.size())
        << std::endl;
      
      if(_tmp_merged_clusters.size() == _out_clusters.size())
        
        std::cout << "  Did not find any newly merged clusters..." <<std::endl;
      
      if(_out_clusters.size()==1)
        
        std::cout << "  Output cluster length is 1 (= no more merging needed)" << std::endl;
      
      if(!_merge_till_converge) 
        
        std::cout << "  Non-iterative option: terminating..." << std::endl;
      
    }

    _iter_ctr++;
  }

bool cmtool::CMergeManager::IterationProcess ( )

protectedvirtual

FMWK function called @ iterative loop inside Process()

Implements cmtool::CMManagerBase.

Definition at line 155 of file CMergeManager.cxx.

References _book_keeper_v, cmtool::CMManagerBase::_debug_mode, cmtool::CMManagerBase::_in_clusters, _iter_ctr, _merge_algo, _out_clusters, cmtool::CMManagerBase::_planes, _separate_algo, _tmp_merged_clusters, _tmp_merged_indexes, cmtool::CMManagerBase::ComputePriority(), cmtool::CMManagerBase::kPerIteration, cmtool::CMergeBookKeeper::PassResult(), cmtool::CMAlgoBase::Report(), cmtool::CMergeBookKeeper::Reset(), RunMerge(), and RunSeparate().

Referenced by GetBookKeeper().

  {

    // Configure input for RunMerge
    CMergeBookKeeper bk;
    
    if(!_iter_ctr) _tmp_merged_clusters = _in_clusters;
    else _tmp_merged_clusters = _out_clusters;
    _out_clusters.clear();

    bk.Reset(_tmp_merged_clusters.size());

    std::vector<bool> merge_switch(_tmp_merged_clusters.size(),true);

    for(size_t i=0; i<_tmp_merged_indexes.size(); ++i)
      
      if(_tmp_merged_indexes.at(i).size()==1)
        
        merge_switch.at(i) = false;
    
    ComputePriority(_tmp_merged_clusters);
    
    // Run separation algorithm
    if(_separate_algo)
      
      RunSeparate(_tmp_merged_clusters, bk);

    // Run merging algorithm
    RunMerge(_tmp_merged_clusters, merge_switch, bk);
    if(_debug_mode <= kPerIteration)
      
      _merge_algo->Report();
    
    // Save output
    bk.PassResult(_tmp_merged_indexes);
    
    if(bk.size() == _tmp_merged_indexes.size())
      _out_clusters = _tmp_merged_clusters;
    else {
      _out_clusters.reserve(_tmp_merged_indexes.size());
      for(auto const& indexes_v : _tmp_merged_indexes) {
        
        if(indexes_v.size()==1) {
          _out_clusters.push_back(_tmp_merged_clusters.at(indexes_v.at(0)));
          continue;
        }
        
        size_t tmp_hit_counts=0;
        for(auto const& index : indexes_v) 
          tmp_hit_counts += _tmp_merged_clusters.at(index).GetHitVector().size();
        //std::vector<larutil::PxHit> tmp_hits;
        std::vector<util::PxHit> tmp_hits;
        tmp_hits.reserve(tmp_hit_counts);
        
        for(auto const& index : indexes_v) {
          for(auto const& hit : _tmp_merged_clusters.at(index).GetHitVector())
            tmp_hits.push_back(hit);
        }
        _out_clusters.push_back(::cluster::ClusterParamsAlg());
        (*_out_clusters.rbegin()).SetVerbose(false);
        (*_out_clusters.rbegin()).DisableFANN();
        
        if((*_out_clusters.rbegin()).SetHits(tmp_hits) < 1) continue;
        (*_out_clusters.rbegin()).FillParams(true,true,true,true,true,false);
        (*_out_clusters.rbegin()).FillPolygon();
      }
      _book_keeper_v.push_back(bk);
    }

    // Break if no more merging occurred
    if(_tmp_merged_clusters.size() == _out_clusters.size())
      
      return false;

    if(_out_clusters.size() == _planes.size())

      return false;

    return true;
  }

void cmtool::CMManagerBase::MergeTillConverge ( bool  doit = true )

inlineinherited

Switch to continue merging till converges.

Definition at line 66 of file CMManagerBase.h.

References cmtool::CMManagerBase::_merge_till_converge, cmtool::CMManagerBase::SetClusters(), and lar::dump::vector().

Referenced by cluster::FuzzyClusterMerger::FuzzyClusterMerger(), and cluster::SimpleClusterMerger::SimpleClusterMerger().

{_merge_till_converge = doit;}

void cmtool::CMManagerBase::Process ( )

inherited

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

Definition at line 83 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(), showerreco::ShowerRecoManager::Reconstruct(), and cmtool::CMManagerBase::SetMinNHits().

  {
    
    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();

      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 57 of file CMManagerBase.h.

References cmtool::CMManagerBase::_time_report, and cmtool::CMManagerBase::Reset().

{ _time_report = time_report; }

void cmtool::CMergeManager::Reset ( )

virtual

Method to reset itself.

Definition at line 16 of file CMergeManager.cxx.

References _book_keeper, _book_keeper_v, _iter_ctr, _merge_algo, _out_clusters, _separate_algo, _tmp_merged_clusters, _tmp_merged_indexes, cmtool::CMAlgoBase::Reset(), cmtool::CMergeBookKeeper::Reset(), and cmtool::CMManagerBase::Reset().

Referenced by CMergeManager(), cluster::ClusterMergeHelper::SetClusters(), and ~CMergeManager().

  {
    CMManagerBase::Reset();
    _tmp_merged_clusters.clear();
    _tmp_merged_indexes.clear();
    _out_clusters.clear();
    _book_keeper.Reset();
    _book_keeper_v.clear();
    if(_merge_algo)    _merge_algo->Reset();
    if(_separate_algo) _separate_algo->Reset();
    _iter_ctr = 0;
  }

void cmtool::CMergeManager::RunMerge ( const std::vector< cluster::ClusterParamsAlg > &  in_clusters, CMergeBookKeeper &  book_keeper  ) const

protected

Definition at line 236 of file CMergeManager.cxx.

Referenced by GetBookKeeper(), and IterationProcess().

  {
    RunMerge(in_clusters,
             std::vector<bool>(in_clusters.size(),true),
             book_keeper);
  }

void cmtool::CMergeManager::RunMerge ( const std::vector< cluster::ClusterParamsAlg > &  in_clusters, const std::vector< bool > &  merge_flag, CMergeBookKeeper &  book_keeper  ) const

protected

Definition at line 244 of file CMergeManager.cxx.

References cmtool::CMManagerBase::_debug_mode, _merge_algo, cmtool::CMManagerBase::_priority, cmtool::CBoolAlgoBase::Bool(), cmtool::CMergeBookKeeper::GetResult(), cmtool::CMManagerBase::kPerIteration, cmtool::CMManagerBase::kPerMerging, cmtool::CMergeBookKeeper::Merge(), and cmtool::CMergeBookKeeper::MergeAllowed().

  {
    if(merge_flag.size() != in_clusters.size())
      throw CMTException(Form("in_clusters (%zu) and merge_flag (%zu) vectors must be of same length!",
                                   in_clusters.size(),
                                   merge_flag.size()
                                   )
                              );
    if(_debug_mode <= kPerIteration){
      
      std::cout
        << Form("  Calling %s with %zu clusters...",__FUNCTION__,in_clusters.size())
        <<std::endl;

    }

    //
    // Merging
    //
    
    // Run over clusters and execute merging algorithms
    for(auto citer1 = _priority.rbegin();
        citer1 != _priority.rend();
        ++citer1) {
      
      auto citer2 = citer1;

      UChar_t plane1 = in_clusters.at((*citer1).second).Plane();

      while(1) {
        citer2++;
        if(citer2 == _priority.rend()) break;

        // Skip if not on the same plane
        UChar_t plane2 = in_clusters.at((*citer2).second).Plane();
        if(plane1 != plane2) continue;

        // Skip if this combination is not meant to be compared
        if(!(merge_flag.at((*citer2).second)) && !(merge_flag.at((*citer1).second)) ) continue;

        // Skip if this combination is not allowed to merge
        if(!(book_keeper.MergeAllowed((*citer1).second,(*citer2).second))) continue;

        if(_debug_mode <= kPerMerging){
          
          std::cout
            << Form("    \033[93mInspecting a pair (%zu, %zu) for merging... \033[00m",(*citer1).second, (*citer2).second)
            << std::endl;
        }
        
        bool merge = _merge_algo->Bool(in_clusters.at((*citer1).second),in_clusters.at((*citer2).second));

        if(_debug_mode <= kPerMerging) {
          
          if(merge) 
            std::cout << "    \033[93mfound to be merged!\033[00m " 
                      << std::endl
                      << std::endl;
          
          else 
            std::cout << "    \033[93mfound NOT to be merged...\033[00m" 
                      << std::endl
                      << std::endl;

        } // end looping over all sets of algorithms
        
        if(merge)

          book_keeper.Merge((*citer1).second,(*citer2).second);

      } // end looping over all cluster pairs for citer1

    } // end looping over clusters

    if(_debug_mode <= kPerIteration && book_keeper.GetResult().size() != in_clusters.size()) {
      
      std::cout << "  Found following clusters to be merged..." << std::endl;
      for(auto const &indexes_v : book_keeper.GetResult()) {

        if(indexes_v.size()==1) continue;
        std::cout<<"    ";
        for(auto index : indexes_v)

          std::cout<<index<<" ";
        std::cout<<" ... indexes to be merged!"<<std::endl;

      }
    }

  }

void cmtool::CMergeManager::RunSeparate ( const std::vector< cluster::ClusterParamsAlg > &  in_clusters, CMergeBookKeeper &  book_keeper  ) const

protected

Definition at line 337 of file CMergeManager.cxx.

References cmtool::CMManagerBase::_debug_mode, _separate_algo, cmtool::CBoolAlgoBase::Bool(), cmtool::CMManagerBase::kPerIteration, cmtool::CMManagerBase::kPerMerging, and cmtool::CMergeBookKeeper::ProhibitMerge().

Referenced by GetBookKeeper(), and IterationProcess().

  {
    /*
    if(separate_flag.size() != in_clusters.size())
      throw CMTException(Form("in_clusters (%zu) and separate_flag (%zu) vectors must be of same length!",
                                   in_clusters.size(),
                                   separate_flag.size()
                                   )
                              );
    */
    if(_debug_mode <= kPerIteration){
      
      std::cout
        << Form("  Calling %s with %zu clusters...",__FUNCTION__,in_clusters.size())
        <<std::endl;

    }

    //
    // Separation
    //
    
    // Run over clusters and execute merging algorithms
    for(size_t cindex1 = 0; cindex1 < in_clusters.size(); ++cindex1) {
      
      UChar_t plane1 = in_clusters.at(cindex1).Plane();
      
      for(size_t cindex2 = cindex1+1; cindex2 < in_clusters.size(); ++cindex2) {
        
        // Skip if not on the same plane
        UChar_t plane2 = in_clusters.at(cindex2).Plane();
        if(plane1 != plane2) continue;
        
        // Skip if this combination is not meant to be compared
        //if(!(separate_flag.at(cindex2))) continue;
        
        if(_debug_mode <= kPerMerging){
          
          std::cout
            << Form("    \033[93mInspecting a pair (%zu, %zu) for separation... \033[00m",cindex1,cindex2)
            << std::endl;
        }
        
        bool separate = _separate_algo->Bool(in_clusters.at(cindex1),in_clusters.at(cindex2));
        
        if(_debug_mode <= kPerMerging) {
          
          if(separate) 
            std::cout << "    \033[93mfound to be separated!\033[00m " 
                      << std::endl
                      << std::endl;
          
          else 
            std::cout << "    \033[93mfound NOT to be separated...\033[00m" 
                      << std::endl
                      << std::endl;
          
        } // end looping over all sets of algorithms
        
        if(separate)
          
          book_keeper.ProhibitMerge(cindex1,cindex2);
          
      } // end looping over all cluster pairs for citer1
      
    } // end looping over clusters

  }

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

inlineinherited

A setter for an analysis output file.

Definition at line 86 of file CMManagerBase.h.

References cmtool::CMManagerBase::_fout, and cmtool::CMManagerBase::ComputePriority().

{ _fout = fout; }

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

inherited

A simple method to add a cluster.

Definition at line 26 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 cmtool::CMManagerBase::MergeTillConverge(), showerreco::ShowerRecoManager::Reconstruct(), and cluster::ClusterMergeHelper::SetClusters().

  {

    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(true,true,true,true,true,false);
      (*_in_clusters.rbegin()).FillParams(false,false,false,false,false,false);
      (*_in_clusters.rbegin()).FillPolygon();

    }

    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 70 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 80 of file CMManagerBase.h.

References cmtool::CMManagerBase::_min_nhits, n, and cmtool::CMManagerBase::Process().

{ _min_nhits = n; }

Member Data Documentation

CMergeBookKeeper cmtool::CMergeManager::_book_keeper

protected

Book keeper instance.

Definition at line 94 of file CMergeManager.h.

Referenced by EventBegin(), EventEnd(), GetBookKeeper(), and Reset().

std::vector<CMergeBookKeeper> cmtool::CMergeManager::_book_keeper_v

protected

Definition at line 104 of file CMergeManager.h.

Referenced by EventBegin(), EventEnd(), IterationProcess(), and Reset().

CMMSGLevel_t cmtool::CMManagerBase::_debug_mode

protectedinherited

Debug mode switch.

Definition at line 117 of file CMManagerBase.h.

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

TFile* cmtool::CMManagerBase::_fout

protectedinherited

Output analysis plot TFile.

Definition at line 126 of file CMManagerBase.h.

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

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

protectedinherited

Input clusters.

Definition at line 120 of file CMManagerBase.h.

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

size_t cmtool::CMergeManager::_iter_ctr

protected

Definition at line 102 of file CMergeManager.h.

Referenced by CMergeManager(), EventBegin(), IterationBegin(), IterationEnd(), IterationProcess(), and Reset().

::cmtool::CBoolAlgoBase* cmtool::CMergeManager::_merge_algo

protected

Merging algorithm.

Definition at line 97 of file CMergeManager.h.

Referenced by AddMergeAlgo(), CMergeManager(), EventBegin(), EventEnd(), IterationBegin(), IterationEnd(), IterationProcess(), Reset(), and RunMerge().

bool cmtool::CMManagerBase::_merge_till_converge

protectedinherited

Iteration loop switch.

Definition at line 132 of file CMManagerBase.h.

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

unsigned int cmtool::CMManagerBase::_min_nhits

protectedinherited

Minimum number of hits: the limit set for ClusterParamsAlg.

Definition at line 114 of file CMManagerBase.h.

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

std::vector<cluster::ClusterParamsAlg> cmtool::CMergeManager::_out_clusters

protected

Output clusters.

Definition at line 91 of file CMergeManager.h.

Referenced by GetClusters(), IterationBegin(), IterationEnd(), IterationProcess(), and Reset().

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

protectedinherited

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

Definition at line 135 of file CMManagerBase.h.

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

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

protectedinherited

Priority record.

Definition at line 129 of file CMManagerBase.h.

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

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

protectedinherited

Priority algorithm.

Definition at line 123 of file CMManagerBase.h.

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

::cmtool::CBoolAlgoBase* cmtool::CMergeManager::_separate_algo

protected

Separation algorithm.

Definition at line 100 of file CMergeManager.h.

Referenced by AddSeparateAlgo(), CMergeManager(), EventBegin(), EventEnd(), IterationBegin(), IterationEnd(), IterationProcess(), Reset(), and RunSeparate().

bool cmtool::CMManagerBase::_time_report

protectedinherited

Timing verbosity flag.

Definition at line 111 of file CMManagerBase.h.

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

std::vector<cluster::ClusterParamsAlg> cmtool::CMergeManager::_tmp_merged_clusters

protected

Definition at line 108 of file CMergeManager.h.

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

std::vector<std::vector<unsigned short> > cmtool::CMergeManager::_tmp_merged_indexes

protected

Definition at line 106 of file CMergeManager.h.

Referenced by EventBegin(), EventEnd(), IterationProcess(), and Reset().

---

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

• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMToolBase/CMergeManager.h
• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMToolBase/CMergeManager.cxx