#include "CMManagerBase.h"

Inheritance diagram for cmtool::CMManagerBase:

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

Public Member Functions
	CMManagerBase ()
	Default constructor. More...

virtual	~CMManagerBase ()
	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 (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
void	ComputePriority (const std::vector< cluster::ClusterParamsAlg > &clusters)
	Function to compute priority. More...

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 ()=0
	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 Attributes
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 29 of file CMManagerBase.h.

Member Enumeration Documentation

enum cmtool::CMManagerBase::CMMSGLevel_t

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::CMManagerBase::CMManagerBase ( )

Default constructor.

Definition at line 8 of file CMManagerBase.cxx.

References _debug_mode, _fout, _merge_till_converge, _min_nhits, _priority_algo, _time_report, kNone, and Reset().

   {
     _fout = 0;
     _debug_mode = kNone;
     _priority_algo = nullptr;
     _min_nhits = 0;
     _merge_till_converge = false;
     Reset();
     _time_report=false;
   }

virtual cmtool::CMManagerBase::~CMManagerBase ( )

inlinevirtual

Default destructor.

Definition at line 51 of file CMManagerBase.h.

51 {}

Member Function Documentation

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

inline

Setter to add an algorithm for priority determination.

Definition at line 63 of file CMManagerBase.h.

References _priority_algo.

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

63 { _priority_algo = algo; }

cmtool::CMManagerBase::_priority_algo

::cmtool::CPriorityAlgoBase * _priority_algo

Priority algorithm.

Definition: CMManagerBase.h:123

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

protected

Function to compute priority.

Definition at line 147 of file CMManagerBase.cxx.

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

Referenced by cmtool::CMatchManager::IterationProcess(), cmtool::CMergeManager::IterationProcess(), and 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 )

inline

Method to enable debug mode (lots of couts)

Definition at line 54 of file CMManagerBase.h.

References _debug_mode.

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

54 {_debug_mode=level;}

cmtool::CMManagerBase::_debug_mode

CMMSGLevel_t _debug_mode

Debug mode switch.

Definition: CMManagerBase.h:117

virtual void cmtool::CMManagerBase::EventBegin ( )

inlineprotectedvirtual

FMWK function called @ beginning of Process()

Reimplemented in cmtool::CMergeManager, and cmtool::CMatchManager.

Definition at line 94 of file CMManagerBase.h.

Referenced by Process().

94 {}

virtual void cmtool::CMManagerBase::EventEnd ( )

inlineprotectedvirtual

FMWK function called @ end of Process()

Reimplemented in cmtool::CMergeManager, and cmtool::CMatchManager.

Definition at line 106 of file CMManagerBase.h.

Referenced by Process().

106 {}

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

inline

A getter for input clusters.

Definition at line 76 of file CMManagerBase.h.

References _in_clusters.

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

77 { return _in_clusters; }

cmtool::CMManagerBase::_in_clusters

std::vector< cluster::ClusterParamsAlg > _in_clusters

Input clusters.

Definition: CMManagerBase.h:120

virtual void cmtool::CMManagerBase::IterationBegin ( )

inlineprotectedvirtual

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

Reimplemented in cmtool::CMergeManager, and cmtool::CMatchManager.

Definition at line 97 of file CMManagerBase.h.

References IterationProcess().

Referenced by Process().

97 {}

virtual void cmtool::CMManagerBase::IterationEnd ( )

inlineprotectedvirtual

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

Reimplemented in cmtool::CMergeManager, and cmtool::CMatchManager.

Definition at line 103 of file CMManagerBase.h.

Referenced by Process().

103 {}

virtual bool cmtool::CMManagerBase::IterationProcess ( )

protectedpure virtual

FMWK function called @ iterative loop inside Process()

Implemented in cmtool::CMergeManager, and cmtool::CMatchManager.

Referenced by IterationBegin(), and Process().

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

inline

Switch to continue merging till converges.

Definition at line 66 of file CMManagerBase.h.

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

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

66 {_merge_till_converge = doit;}

cmtool::CMManagerBase::_merge_till_converge

bool _merge_till_converge

Iteration loop switch.

Definition: CMManagerBase.h:132

void cmtool::CMManagerBase::Process ( )

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

Definition at line 83 of file CMManagerBase.cxx.

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

Referenced by cluster::ClusterMergeHelper::Process(), showerreco::ShowerRecoManager::Reconstruct(), and 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 )

inline

Method to enable timing profile cout.

Definition at line 57 of file CMManagerBase.h.

References _time_report, and Reset().

57 { _time_report = time_report; }

cmtool::CMManagerBase::_time_report

bool _time_report

Timing verbosity flag.

Definition: CMManagerBase.h:111

void cmtool::CMManagerBase::Reset ( )

Method to reset itself.

Definition at line 19 of file CMManagerBase.cxx.

References _in_clusters, _planes, _priority_algo, and cmtool::CMAlgoBase::Reset().

Referenced by CMManagerBase(), ReportTimings(), cmtool::CMergeManager::Reset(), cmtool::CMatchManager::Reset(), and SetClusters().

   {
     _planes.clear();
     _in_clusters.clear();
     if(_priority_algo) _priority_algo->Reset();
   }

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

inline

A setter for an analysis output file.

Definition at line 86 of file CMManagerBase.h.

References _fout, and ComputePriority().

86 { _fout = fout; }

cmtool::CMManagerBase::_fout

TFile * _fout

Output analysis plot TFile.

Definition: CMManagerBase.h:126

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

A simple method to add a cluster.

Definition at line 26 of file CMManagerBase.cxx.

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

Referenced by 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 )

A simple method to add a cluster.

Definition at line 70 of file CMManagerBase.cxx.

References _in_clusters, and _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 )

inline

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

Definition at line 80 of file CMManagerBase.h.

References _min_nhits, n, and Process().

80 { _min_nhits = n; }

cmtool::CMManagerBase::_min_nhits

unsigned int _min_nhits

Minimum number of hits: the limit set for ClusterParamsAlg.

Definition: CMManagerBase.h:114

n

Char_t n[5]

Definition: comparison_ascii.C:55

Member Data Documentation

CMMSGLevel_t cmtool::CMManagerBase::_debug_mode

protected

Debug mode switch.

Definition at line 117 of file CMManagerBase.h.

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

TFile* cmtool::CMManagerBase::_fout

protected

Output analysis plot TFile.

Definition at line 126 of file CMManagerBase.h.

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

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

protected

Input clusters.

Definition at line 120 of file CMManagerBase.h.

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

bool cmtool::CMManagerBase::_merge_till_converge

protected

Iteration loop switch.

Definition at line 132 of file CMManagerBase.h.

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

unsigned int cmtool::CMManagerBase::_min_nhits

protected

Minimum number of hits: the limit set for ClusterParamsAlg.

Definition at line 114 of file CMManagerBase.h.

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

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

protected

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

Definition at line 135 of file CMManagerBase.h.

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

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

protected

Priority record.

Definition at line 129 of file CMManagerBase.h.

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

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

protected

Priority algorithm.

Definition at line 123 of file CMManagerBase.h.

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

bool cmtool::CMManagerBase::_time_report

protected

Timing verbosity flag.

Definition at line 111 of file CMManagerBase.h.

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

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

/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMToolBase/CMManagerBase.h
/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMToolBase/CMManagerBase.cxx

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation