LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
cmtool::CBAlgoPolyContain Class Reference

#include "CBAlgoPolyContain.h"

Inheritance diagram for cmtool::CBAlgoPolyContain:
cmtool::CBoolAlgoBase cmtool::CMAlgoBase

Public Member Functions

 CBAlgoPolyContain ()
 Default constructor. More...
 
virtual ~CBAlgoPolyContain ()
 Default destructor. More...
 
virtual bool Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
 
void reconfigure ()
 Method to re-configure the instance. More...
 
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

Definition at line 25 of file CBAlgoPolyContain.h.

Constructor & Destructor Documentation

cmtool::CBAlgoPolyContain::CBAlgoPolyContain ( )

Default constructor.

Definition at line 5 of file CBAlgoPolyContain.cxx.

References reconfigure().

5  : CBoolAlgoBase()
6  {
7  // Nothing to be done in the base class
8  this->reconfigure();
9  }
void reconfigure()
Method to re-configure the instance.
CBoolAlgoBase()
Default constructor.
Definition: CBoolAlgoBase.h:31
virtual cmtool::CBAlgoPolyContain::~CBAlgoPolyContain ( )
inlinevirtual

Default destructor.

Definition at line 32 of file CBAlgoPolyContain.h.

References Bool(), and reconfigure().

32 {};

Member Function Documentation

bool cmtool::CBAlgoPolyContain::Bool ( const ::cluster::ClusterParamsAlg cluster1,
const ::cluster::ClusterParamsAlg cluster2 
)
virtual

Core function: given the ClusterParamsAlg input, return whether a cluster should be merged or not.

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 18 of file CBAlgoPolyContain.cxx.

Referenced by ~CBAlgoPolyContain().

20  {
21 
22  if ((cluster1.GetParams().PolyObject.Size() < 3) or
23  (cluster2.GetParams().PolyObject.Size() < 3))
24  return false;
25 
26  //if either polygon is fully contained in other
27  //then return true! --> MERGE!
28  if ((cluster1.GetParams().PolyObject.Contained(cluster2.GetParams().PolyObject)) or
29  (cluster2.GetParams().PolyObject.Contained(cluster1.GetParams().PolyObject)))
30  return true;
31  else
32  return false;
33  }
bool Contained(const Polygon2D &poly2) const
Definition: Polygon2D.cxx:296
Polygon2D PolyObject
Polygon Object...see Polygon2D.hh.
Definition: ClusterParams.h:21
unsigned int Size() const
Create Intersection Polygon.
Definition: Polygon2D.h:41
const cluster_params & GetParams() const
virtual void cmtool::CMAlgoBase::EventBegin ( const std::vector< cluster::ClusterParamsAlg > &  )
inlinevirtualinherited

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 45 of file CMAlgoBase.h.

Referenced by cmtool::CMergeManager::EventBegin().

45 {}
virtual void cmtool::CMAlgoBase::EventEnd ( )
inlinevirtualinherited

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 50 of file CMAlgoBase.h.

Referenced by cmtool::CMatchManager::EventEnd(), and cmtool::CMergeManager::EventEnd().

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

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

Referenced by cmtool::CMatchManager::EventBegin(), cmtool::CMatchManager::IterationBegin(), and cmtool::CMergeManager::IterationBegin().

57 {}
virtual void cmtool::CMAlgoBase::IterationEnd ( )
inlinevirtualinherited

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

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

Definition at line 62 of file CMAlgoBase.h.

Referenced by cmtool::CMatchManager::IterationEnd(), and cmtool::CMergeManager::IterationEnd().

62 {}
void cmtool::CBAlgoPolyContain::reconfigure ( )

Method to re-configure the instance.

Definition at line 11 of file CBAlgoPolyContain.cxx.

Referenced by CBAlgoPolyContain(), and ~CBAlgoPolyContain().

12  {
13 
14  //not sure what needs to be reset/reconfigured for this algo
15 
16  } //end reconfigure function
void cmtool::CMAlgoBase::SetAnaFile ( TFile *  fout)
inlineinherited

Setter function for an output plot TFile pointer.

Definition at line 72 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_fout.

Referenced by cmtool::CMergeManager::EventBegin().

72 { _fout = fout; }
TFile * _fout
TFile pointer to an output file.
Definition: CMAlgoBase.h:79
virtual void cmtool::CMAlgoBase::SetVerbose ( bool  doit = true)
inlinevirtualinherited

Setter function for verbosity.

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

Definition at line 75 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_verbose.

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

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

Member Data Documentation

TFile* cmtool::CMAlgoBase::_fout
protectedinherited

TFile pointer to an output file.

Definition at line 79 of file CMAlgoBase.h.

Referenced by cmtool::CMAlgoBase::CMAlgoBase(), and cmtool::CMAlgoBase::SetAnaFile().


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