Public Member Functions | Protected Attributes | List of all members
cmtool::CMAlgoBase Class Reference

#include <CMAlgoBase.h>

Inheritance diagram for cmtool::CMAlgoBase:
cmtool::CBoolAlgoBase cmtool::CFloatAlgoBase cmtool::CPriorityAlgoBase cmtool::CBAlgoAngleAlign cmtool::CBAlgoAngleCompat cmtool::CBAlgoAngleIncompat cmtool::CBAlgoAngleSeparate cmtool::CBAlgoArray cmtool::CBAlgoCenterOfMass cmtool::CBAlgoCenterOfMassSmall cmtool::CBAlgoFake cmtool::CBAlgoMergeAll cmtool::CBAlgoMergeTinyWithBig cmtool::CBAlgoOutOfConeSeparate cmtool::CBAlgoPolyContain cmtool::CBAlgoPolyHitOverlap cmtool::CBAlgoPolyOverlap cmtool::CBAlgoPolyShortestDist cmtool::CBAlgoProhibitAllTracks cmtool::CBAlgoProhibitBigClusters cmtool::CBAlgoStartNearEnd cmtool::CBAlgoStartTrack cmtool::CFAlgoQRatio cmtool::CFAlgoShowerCompat cmtool::CFAlgoTimeOverlap cmtool::CFAlgoZOverlap cmtool::CPAlgoArray cmtool::CPAlgoIgnoreTracks cmtool::CPAlgoNHits cmtool::CPAlgoPolyArea cmtool::CPAlgoQSum

Public Member Functions

 CMAlgoBase ()
 
virtual ~CMAlgoBase ()=default
 
virtual void Reset ()
 Function to reset the algorithm instance called within CMergeManager/CMatchManager's Reset() ... maybe implemented via child class. More...
 
virtual void EventBegin (const std::vector< cluster::ClusterParamsAlg > &)
 
virtual void EventEnd ()
 
virtual void IterationBegin (const std::vector< cluster::ClusterParamsAlg > &)
 
virtual void IterationEnd ()
 
virtual void Report ()
 
void SetAnaFile (TFile *fout)
 Setter function for an output plot TFile pointer. More...
 
virtual void SetVerbose (bool doit=true)
 Setter function for verbosity. More...
 

Protected Attributes

TFile * _fout
 TFile pointer to an output file. More...
 
bool _verbose
 Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager's verbosity level is >= kPerMerging. More...
 

Detailed Description

An abstract base class for merging/mathcing algorithm. Having this base class helps to have a better overall design of various merging for iterative approach. The algorithms are run through CMergeManager.

Definition at line 30 of file CMAlgoBase.h.

Constructor & Destructor Documentation

cmtool::CMAlgoBase::CMAlgoBase ( )
inline

Definition at line 32 of file CMAlgoBase.h.

33  {
34  _fout = 0;
35  _verbose = false;
36  }
TFile * _fout
TFile pointer to an output file.
Definition: CMAlgoBase.h:99
bool _verbose
Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager&#39;s verbosity level is >= kPer...
Definition: CMAlgoBase.h:102
virtual cmtool::CMAlgoBase::~CMAlgoBase ( )
virtualdefault

Member Function Documentation

virtual void cmtool::CMAlgoBase::EventBegin ( const std::vector< cluster::ClusterParamsAlg > &  )
inlinevirtual

Optional function: called at the beginning of 1st iteration. This is called per event.

Reimplemented in cmtool::CPAlgoArray, cmtool::CBAlgoArray, and cmtool::CBAlgoPolyShortestDist.

Definition at line 48 of file CMAlgoBase.h.

49  {}
virtual void cmtool::CMAlgoBase::EventEnd ( )
inlinevirtual

Optional function: called at the end of event ... after the last merging iteration is over.

Reimplemented in cmtool::CPAlgoArray, and cmtool::CBAlgoArray.

Definition at line 55 of file CMAlgoBase.h.

56  {}
virtual void cmtool::CMAlgoBase::IterationBegin ( const std::vector< cluster::ClusterParamsAlg > &  )
inlinevirtual

Optional function: called at the beggining of each iteration over all pairs of clusters. This provides all clusters' information in case the algorithm need them. Note this is called per iteration which may be more than once per event.

Reimplemented in cmtool::CPAlgoArray, and cmtool::CBAlgoArray.

Definition at line 64 of file CMAlgoBase.h.

65  {}
virtual void cmtool::CMAlgoBase::IterationEnd ( )
inlinevirtual

Optional function: called at the end of each iteration over all pairs of clusters.

Reimplemented in cmtool::CPAlgoArray, and cmtool::CBAlgoArray.

Definition at line 71 of file CMAlgoBase.h.

72  {}
virtual void cmtool::CMAlgoBase::Report ( )
inlinevirtual
virtual void cmtool::CMAlgoBase::Reset ( void  )
inlinevirtual
void cmtool::CMAlgoBase::SetAnaFile ( TFile *  fout)
inline

Setter function for an output plot TFile pointer.

Definition at line 85 of file CMAlgoBase.h.

86  {
87  _fout = fout;
88  }
TFile * _fout
TFile pointer to an output file.
Definition: CMAlgoBase.h:99
virtual void cmtool::CMAlgoBase::SetVerbose ( bool  doit = true)
inlinevirtual

Setter function for verbosity.

Reimplemented in cmtool::CBAlgoArray, and cmtool::CFAlgoTimeOverlap.

Definition at line 92 of file CMAlgoBase.h.

93  {
94  _verbose = doit;
95  }
bool _verbose
Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager&#39;s verbosity level is >= kPer...
Definition: CMAlgoBase.h:102

Member Data Documentation

TFile* cmtool::CMAlgoBase::_fout
protected

TFile pointer to an output file.

Definition at line 99 of file CMAlgoBase.h.

bool cmtool::CMAlgoBase::_verbose
protected

Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager's verbosity level is >= kPerMerging.

Definition at line 102 of file CMAlgoBase.h.


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