#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
	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
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 (util::GeometryUtilities const &gser)=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 41 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 44 of file CMManagerBase.h.

                       {
       /// Extremely verbose (cout per individual algorithm execution)
       kPerMerging,
       /// Somewhat verbose (cout per merging iteration)
       kPerIteration,
       /// Bit verbose (cout per event)
       kPerEvent,
       /// Normal
       kNone
     };

Constructor & Destructor Documentation

cmtool::CMManagerBase::CMManagerBase ( )

Default constructor.

Definition at line 16 of file CMManagerBase.cxx.

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

virtual cmtool::CMManagerBase::~CMManagerBase ( )

virtualdefault

Default destructor.

Member Function Documentation

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

inline

Setter to add an algorithm for priority determination.

Definition at line 80 of file CMManagerBase.h.

     {
       _priority_algo = algo;
     }

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

protected

Function to compute priority.

Definition at line 160 of file CMManagerBase.cxx.

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

     {
       _debug_mode = level;
     }

virtual void cmtool::CMManagerBase::EventBegin ( )

inlineprotectedvirtual

FMWK function called @ beginning of Process()

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

Definition at line 129 of file CMManagerBase.h.

130 {}

virtual void cmtool::CMManagerBase::EventEnd ( )

inlineprotectedvirtual

FMWK function called @ end of Process()

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

Definition at line 147 of file CMManagerBase.h.

148 {}

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

inline

A getter for input clusters.

Definition at line 101 of file CMManagerBase.h.

     {
       return _in_clusters;
     }

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

135 {}

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

143 {}

virtual bool cmtool::CMManagerBase::IterationProcess ( util::GeometryUtilities const & gser )

protectedpure virtual

FMWK function called @ iterative loop inside Process()

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

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

inline

Switch to continue merging till converges.

Definition at line 87 of file CMManagerBase.h.

     {
       _merge_till_converge = doit;
     }

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

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

Definition at line 93 of file CMManagerBase.cxx.

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

inline

Method to enable timing profile cout.

Definition at line 70 of file CMManagerBase.h.

     {
       _time_report = time_report;
     }

void cmtool::CMManagerBase::Reset ( void )

Method to reset itself.

Definition at line 28 of file CMManagerBase.cxx.

   {
     _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 118 of file CMManagerBase.h.

     {
       _fout = fout;
     }

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

A simple method to add a cluster.

Definition at line 36 of file CMManagerBase.cxx.

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

A simple method to add a cluster.

Definition at line 78 of file CMManagerBase.cxx.

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

     {
       _min_nhits = n;
     }

Member Data Documentation

CMMSGLevel_t cmtool::CMManagerBase::_debug_mode

protected

Debug mode switch.

Definition at line 158 of file CMManagerBase.h.

TFile* cmtool::CMManagerBase::_fout

protected

Output analysis plot TFile.

Definition at line 167 of file CMManagerBase.h.

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

protected

Input clusters.

Definition at line 161 of file CMManagerBase.h.

bool cmtool::CMManagerBase::_merge_till_converge

protected

Iteration loop switch.

Definition at line 173 of file CMManagerBase.h.

unsigned int cmtool::CMManagerBase::_min_nhits

protected

Minimum number of hits: the limit set for ClusterParamsAlg.

Definition at line 155 of file CMManagerBase.h.

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

protected

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

Definition at line 176 of file CMManagerBase.h.

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

protected

Priority record.

Definition at line 170 of file CMManagerBase.h.

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

protected

Priority algorithm.

Definition at line 164 of file CMManagerBase.h.

bool cmtool::CMManagerBase::_time_report

protected

Timing verbosity flag.

Definition at line 152 of file CMManagerBase.h.

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

larreco/larreco/RecoAlg/CMTool/CMToolBase/CMManagerBase.h
larreco/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