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

#include "CBAlgoStartNearEnd.h"

Inheritance diagram for cmtool::CBAlgoStartNearEnd:
cmtool::CBoolAlgoBase cmtool::CMAlgoBase

Public Member Functions

 CBAlgoStartNearEnd ()
 Default constructor. More...
 
virtual ~CBAlgoStartNearEnd ()
 Default destructor. More...
 
void SetMaxStartEndSeparation (double d)
 
void SetMaxAngle (double a)
 
void SetMinHits (size_t n)
 
virtual bool Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
 
virtual void Reset ()
 Function to reset the algorithm instance ... maybe implemented via child class. More...
 
virtual void Report ()
 Function to report what's going on per merging. More...
 
virtual void EventBegin (const std::vector< cluster::ClusterParamsAlg > &)
 
virtual void EventEnd ()
 
virtual void IterationBegin (const std::vector< cluster::ClusterParamsAlg > &)
 
virtual void IterationEnd ()
 
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

double _maxopeningangle
 
double _separation
 
size_t _MinHits
 
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

Merge if start point of one is near end point of another and require angle compatibility

Definition at line 26 of file CBAlgoStartNearEnd.h.

Constructor & Destructor Documentation

cmtool::CBAlgoStartNearEnd::CBAlgoStartNearEnd ( )

Default constructor.

Definition at line 6 of file CBAlgoStartNearEnd.cxx.

References SetMaxAngle(), SetMaxStartEndSeparation(), and SetMinHits().

6  : CBoolAlgoBase()
7  //----------------------------------------
8  {
9  SetMaxStartEndSeparation(10); //cm^2
10  SetMinHits(40); //cm^2
11  SetMaxAngle(20 * (3.14 / 180)); //rad: max angle of end-point cluster
12  // Nothing to be done in the base class
13  }
CBoolAlgoBase()
Default constructor.
Definition: CBoolAlgoBase.h:31
void SetMaxStartEndSeparation(double d)
virtual cmtool::CBAlgoStartNearEnd::~CBAlgoStartNearEnd ( )
inlinevirtual

Default destructor.

Definition at line 33 of file CBAlgoStartNearEnd.h.

33 {};

Member Function Documentation

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

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

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 16 of file CBAlgoStartNearEnd.cxx.

References _maxopeningangle, _MinHits, _separation, and cmtool::CMAlgoBase::_verbose.

Referenced by SetMinHits().

19  {
20 
21  double start_w1 = cluster1.GetParams().start_point.w;
22  double start_t1 = cluster1.GetParams().start_point.t;
23  double end_w1 = cluster1.GetParams().end_point.w;
24  double end_t1 = cluster1.GetParams().end_point.t;
25 
26  double start_w2 = cluster2.GetParams().start_point.w;
27  double start_t2 = cluster2.GetParams().start_point.t;
28  double end_w2 = cluster2.GetParams().end_point.w;
29  double end_t2 = cluster2.GetParams().end_point.t;
30 
31  double angle_1 = cluster1.GetParams().opening_angle;
32  double angle_2 = cluster2.GetParams().opening_angle;
33 
34  size_t hits_1 = cluster1.GetHitVector().size();
35  size_t hits_2 = cluster2.GetHitVector().size();
36 
37  if ((angle_1 < _maxopeningangle) and (hits_1 > _MinHits) and
38  (((start_w2 - end_w1) * (start_w2 - end_w1) + (start_t2 - end_t1) * (start_t2 - end_t1)) <
39  _separation)) {
40  if (_verbose) std::cout << "Start in End!" << std::endl;
41  return true;
42  }
43 
44  if ((angle_2 < _maxopeningangle) and (hits_2 > _MinHits) and
45  (((start_w1 - end_w2) * (start_w1 - end_w2) + (start_t1 - end_t2) * (start_t1 - end_t2)) <
46  _separation)) {
47  if (_verbose) std::cout << "Start in End!" << std::endl;
48  return true;
49  }
50 
51  return false;
52  }
const cluster_params & GetParams() const
double t
Definition: PxUtils.h:10
const std::vector< util::PxHit > & GetHitVector() const
util::PxPoint start_point
start point
Definition: ClusterParams.h:23
double w
Definition: PxUtils.h:9
util::PxPoint end_point
end point
Definition: ClusterParams.h:24
double opening_angle
Width of angular distubtion wrt vertx.
Definition: ClusterParams.h:40
bool _verbose
Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager&#39;s verbosity level is >= kPer...
Definition: CMAlgoBase.h:82
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::CBAlgoStartNearEnd::Report ( )
virtual

Function to report what's going on per merging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 55 of file CBAlgoStartNearEnd.cxx.

Referenced by Reset().

57  {}
virtual void cmtool::CBAlgoStartNearEnd::Reset ( )
inlinevirtual

Function to reset the algorithm instance ... maybe implemented via child class.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 50 of file CBAlgoStartNearEnd.h.

References Report().

50 {}
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
void cmtool::CBAlgoStartNearEnd::SetMaxAngle ( double  a)
inline

Definition at line 42 of file CBAlgoStartNearEnd.h.

References _maxopeningangle.

Referenced by CBAlgoStartNearEnd().

void cmtool::CBAlgoStartNearEnd::SetMaxStartEndSeparation ( double  d)
inline

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

Definition at line 40 of file CBAlgoStartNearEnd.h.

References _separation, and d.

Referenced by CBAlgoStartNearEnd().

40 { _separation = d; }
Float_t d
Definition: plot.C:235
void cmtool::CBAlgoStartNearEnd::SetMinHits ( size_t  n)
inline

Definition at line 44 of file CBAlgoStartNearEnd.h.

References _MinHits, Bool(), and n.

Referenced by CBAlgoStartNearEnd().

44 { _MinHits = n; }
Char_t n[5]
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().

double cmtool::CBAlgoStartNearEnd::_maxopeningangle
protected

Definition at line 56 of file CBAlgoStartNearEnd.h.

Referenced by Bool(), and SetMaxAngle().

size_t cmtool::CBAlgoStartNearEnd::_MinHits
protected

Definition at line 58 of file CBAlgoStartNearEnd.h.

Referenced by Bool(), and SetMinHits().

double cmtool::CBAlgoStartNearEnd::_separation
protected

Definition at line 57 of file CBAlgoStartNearEnd.h.

Referenced by Bool(), and SetMaxStartEndSeparation().


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