LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Member Functions | Protected Attributes | Private Attributes | List of all members
cmtool::CFAlgoShowerCompat Class Reference

#include "CFAlgoShowerCompat.h"

Inheritance diagram for cmtool::CFAlgoShowerCompat:
cmtool::CFloatAlgoBase cmtool::CMAlgoBase

Public Member Functions

 CFAlgoShowerCompat ()
 Default constructor. More...
 
float Float (util::GeometryUtilities const &, const std::vector< const cluster::ClusterParamsAlg * > &clusters) override
 
void Report () override
 
void Reset () override
 Function to reset the algorithm instance, called together with manager's Reset() More...
 
void PrintClusterInfo (const cluster::ClusterParamsAlg &c)
 
void WriteHaxFile ()
 
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

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...
 

Private Attributes

TTree * _ana_tree
 
double _o_ang_avg
 
double _o_ang_rms
 
double _o_ang_wt_avg
 
double _o_ang_wt_rms
 
double _max_trackness
 
double _max_len_over_width
 
double _min_oa_over_len
 
double _max_poly_perim_over_A
 
double _min_modhitdens
 
TFile * _fout_hax
 

Detailed Description

User implementation for CFloatAlgoBase class doxygen documentation!

Definition at line 32 of file CFAlgoShowerCompat.h.

Constructor & Destructor Documentation

cmtool::CFAlgoShowerCompat::CFAlgoShowerCompat ( )

Default constructor.

Definition at line 9 of file CFAlgoShowerCompat.cxx.

References _ana_tree, _fout_hax, _max_len_over_width, _max_poly_perim_over_A, _max_trackness, _min_modhitdens, _min_oa_over_len, _o_ang_avg, _o_ang_rms, _o_ang_wt_avg, and _o_ang_wt_rms.

11  {
12 
13  _fout_hax = 0;
14  _ana_tree = 0;
15 
16  if (!_fout_hax) _fout_hax = new TFile("fout_hax.root", "RECREATE");
17 
18  if (!_ana_tree) {
19  _ana_tree = new TTree("ana_tree", "ana_tree");
20  _ana_tree->Branch("o_ang_avg", &_o_ang_avg, "o_ang_avg/D");
21  _ana_tree->Branch("o_ang_rms", &_o_ang_rms, "o_ang_rms/D");
22  _ana_tree->Branch("o_ang_wt_avg", &_o_ang_wt_avg, "o_ang_wt_avg/D");
23  _ana_tree->Branch("o_ang_wt_rms", &_o_ang_wt_rms, "o_ang_wt_rms/D");
24  _ana_tree->Branch("max_trackness", &_max_trackness, "max_trackness/D");
25  _ana_tree->Branch("max_len_over_width", &_max_len_over_width, "max_len_over_width/D");
26  _ana_tree->Branch("min_oa_over_len", &_min_oa_over_len, "min_oa_over_len/D");
27  _ana_tree->Branch(
28  "max_poly_perim_over_A", &_max_poly_perim_over_A, "max_poly_perim_over_A/D");
29  _ana_tree->Branch("min_modhitdens", &_min_modhitdens, "min_modhitdens/D");
30  }
31  }

Member Function Documentation

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 {}
float cmtool::CFAlgoShowerCompat::Float ( util::GeometryUtilities const &  ,
const std::vector< const cluster::ClusterParamsAlg * > &  clusters 
)
overridevirtual

Core function: given a set of CPANs, return a float which indicates the compatibility the cluster combination.

Reimplemented from cmtool::CFloatAlgoBase.

Definition at line 39 of file CFAlgoShowerCompat.cxx.

References _ana_tree, _max_len_over_width, _max_poly_perim_over_A, _max_trackness, _min_modhitdens, _min_oa_over_len, _o_ang_avg, _o_ang_rms, _o_ang_wt_avg, and _o_ang_wt_rms.

42  {
43  _o_ang_avg = 0;
44  _o_ang_rms = 0;
45  _o_ang_wt_avg = 0;
46  _o_ang_wt_rms = 0;
47  _max_trackness = -9999.;
48  _max_len_over_width = -9999.;
49  _min_oa_over_len = 9999.;
50  _max_poly_perim_over_A = -9999.;
51  _min_modhitdens = 9999.;
52 
53  //Take the smallest and largest opening angles of clusters in this
54  //permutation and average them
55  double min_OA = 99999.;
56  double max_OA = -99999.;
57  double min_OA_wt = 99999.;
58  double max_OA_wt = -99999.;
59  for (auto const& c : clusters) {
60  // PrintClusterInfo(*c);
61  double this_OA = c->GetParams().opening_angle;
62  if (this_OA > max_OA) max_OA = this_OA;
63  if (this_OA < min_OA) min_OA = this_OA;
64  double this_OA_wt = c->GetParams().opening_angle_charge_wgt;
65  if (this_OA_wt > max_OA) max_OA_wt = this_OA_wt;
66  if (this_OA_wt < min_OA) min_OA_wt = this_OA_wt;
67  double this_trackness = c->GetParams().trackness;
68  if (this_trackness > _max_trackness) _max_trackness = this_trackness;
69  double this_L_over_W = c->GetParams().length / c->GetParams().width;
70  if (this_L_over_W > _max_len_over_width) _max_len_over_width = this_L_over_W;
71  double this_OA_over_L = this_OA / c->GetParams().length;
72  if (this_OA_over_L < _min_oa_over_len) _min_oa_over_len = this_OA_over_L;
73  double this_poly_perim_over_A =
74  c->GetParams().PolyObject.Perimeter() / c->GetParams().PolyObject.Area();
75  if (this_poly_perim_over_A > _max_poly_perim_over_A)
76  _max_poly_perim_over_A = this_poly_perim_over_A;
77  double this_modhitdens = c->GetParams().modified_hit_density;
78  if (this_modhitdens < _min_modhitdens) _min_modhitdens = this_modhitdens;
79  }
80 
81  _o_ang_avg = (min_OA + max_OA) / 2;
82  _o_ang_rms = pow((pow(min_OA, 2) + pow(max_OA, 2)) / 2, 0.5);
83  _o_ang_wt_avg = (min_OA_wt + max_OA_wt) / 2;
84  _o_ang_wt_rms = pow((pow(min_OA_wt, 2) + pow(max_OA_wt, 2)) / 2, 0.5);
85 
86  _ana_tree->Fill();
87 
88  bool accept_match = true;
89  //Reject match if it is very track-like
90  if (_min_oa_over_len < 0.0007) accept_match = false;
91  if (_o_ang_avg * _o_ang_rms < 0.01) accept_match = false;
92  if (_max_len_over_width > 20) accept_match = false;
93 
94  return accept_match ? 1 : -1;
95  }
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::CFAlgoShowerCompat::PrintClusterInfo ( const cluster::ClusterParamsAlg &  c)

Definition at line 102 of file CFAlgoShowerCompat.cxx.

References cluster::ClusterParamsAlg::GetParams(), and cluster::cluster_params::opening_angle.

103  {
104  std::cout << " This cluster's info is as follows:" << std::endl;
105  std::cout << " Opening Angle: " << c.GetParams().opening_angle << std::endl;
106  // std::cout<<" Opening Angle Charge Weight: "<<c.GetParams().opening_angle_charge_wgt<<std::endl;
107  }
cluster::ClusterParamsAlg::GetParams
const cluster_params & GetParams() const
Definition: ClusterParamsAlg.h:82
cluster::cluster_params::opening_angle
double opening_angle
Width of angular distubtion wrt vertx.
Definition: ClusterParams.h:40
void cmtool::CFAlgoShowerCompat::Report ( )
overridevirtual

Optional function: called after each iterative approach if a manager class is run with verbosity level <= kPerIteration. Maybe useful for debugging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 98 of file CFAlgoShowerCompat.cxx.

100  {}
void cmtool::CFAlgoShowerCompat::Reset ( )
overridevirtual

Function to reset the algorithm instance, called together with manager's Reset()

Reimplemented from cmtool::CMAlgoBase.

Definition at line 34 of file CFAlgoShowerCompat.cxx.

36  {}
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; }
cmtool::CMAlgoBase::_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; }
cmtool::CMAlgoBase::_verbose
bool _verbose
Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager&#39;s verbosity level is >= kPer...
Definition: CMAlgoBase.h:82
void cmtool::CFAlgoShowerCompat::WriteHaxFile ( )
inline

Definition at line 61 of file CFAlgoShowerCompat.h.

References _ana_tree, and _fout_hax.

62  {
63  _fout_hax->cd();
64  _ana_tree->Write();
65  _fout_hax->Close();
66  };

Member Data Documentation

TTree* cmtool::CFAlgoShowerCompat::_ana_tree
private

Optional function: called at the beginning of 1st iteration. This is called per event. Optional function: called at the end of event ... after the last merging iteration is over. Optional function: called at the beggining of each iterative loop. 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. Optional function: called at the end of each iterative loop.

Definition at line 66 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), Float(), and WriteHaxFile().

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().

TFile* cmtool::CFAlgoShowerCompat::_fout_hax
private

Definition at line 102 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and WriteHaxFile().

double cmtool::CFAlgoShowerCompat::_max_len_over_width
private

Definition at line 97 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_max_poly_perim_over_A
private

Definition at line 99 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_max_trackness
private

Definition at line 96 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_min_modhitdens
private

Definition at line 100 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_min_oa_over_len
private

Definition at line 98 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_o_ang_avg
private

Definition at line 92 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_o_ang_rms
private

Definition at line 93 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_o_ang_wt_avg
private

Definition at line 94 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

double cmtool::CFAlgoShowerCompat::_o_ang_wt_rms
private

Definition at line 95 of file CFAlgoShowerCompat.h.

Referenced by CFAlgoShowerCompat(), and Float().

bool cmtool::CMAlgoBase::_verbose
protectedinherited

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

Definition at line 82 of file CMAlgoBase.h.

Referenced by cmtool::CBAlgoAngleAlign::Bool(), cmtool::CBAlgoAngleCompat::Bool(), cmtool::CBAlgoPolyOverlap::Bool(), cmtool::CBAlgoOutOfConeSeparate::Bool(), cmtool::CBAlgoAngleSeparate::Bool(), cmtool::CBAlgoCenterOfMassSmall::Bool(), cmtool::CBAlgoCenterOfMass::Bool(), cmtool::CBAlgoStartNearEnd::Bool(), cmtool::CBAlgoProhibitAllTracks::Bool(), cmtool::CMAlgoBase::CMAlgoBase(), cmtool::CFAlgoZOverlap::Float(), cmtool::CFAlgoQRatio::Float(), cmtool::CMAlgoBase::SetVerbose(), cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared(), and cmtool::CBAlgoCenterOfMassSmall::ShortestDistanceSquared().

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