#include "CFAlgoQRatio.h"

Inheritance diagram for cmtool::CFAlgoQRatio:

Public Member Functions
	CFAlgoQRatio ()
	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	SetQRatioCut (float cut)
	Setter for the minimum value for charge ratio (below this value Float() returns -1) 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
float	_qratio_cut

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

User implementation for CFloatAlgoBase class This algorithm compares charge ratio of clusters to find a match

Definition at line 25 of file CFAlgoQRatio.h.

Constructor & Destructor Documentation

cmtool::CFAlgoQRatio::CFAlgoQRatio ( )

Default constructor.

Definition at line 6 of file CFAlgoQRatio.cxx.

References _qratio_cut.

                              : CFloatAlgoBase()
   //-------------------------------------------------------
   {
     _qratio_cut = 0.1; // Preliminary cuts
   }

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::CFAlgoQRatio::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 18 of file CFAlgoQRatio.cxx.

References _qratio_cut, and cmtool::CMAlgoBase::_verbose.

   {
 
     // Code-block by Kazu starts
     // This ensures the algorithm works only if # clusters is > 2 (and not =2)
     // You may take out this block if you want to allow matching using clusters from only 2 planes.
     if (clusters.size() == 2) return -1;
     // Code-block by Kazu ends
 
     double q_max = -1;
     float ratio = 1;
 
     // Search for max charge & return if any cluster has negative charge
     for (auto const& c : clusters) {
 
       //Ignore all clusters with less than 40 hits
 
       if (c->GetParams().sum_charge < 0) {
         if (_verbose)
           std::cout << "\033[00m Found a cluster with negative charge!\033[00m ... aborting "
                     << __FUNCTION__ << std::endl;
         return -1;
       }
 
       if (q_max < c->GetParams().sum_charge) q_max = c->GetParams().sum_charge;
     }
 
     // Compute ratio
     for (auto const& c : clusters) {
       ratio *= c->GetParams().sum_charge / q_max;
 
       if (_verbose) {
         std::cout << "Sum Charge: " << c->GetParams().sum_charge;
         std::cout << "Q max : " << q_max << std::endl;
         std::cout << "Ratio is: " << ratio << std::endl;
       }
     }
 
     if (_verbose) {
       if (ratio > _qratio_cut)
         std::cout << " ... pass!" << std::endl;
       else
         std::cout << " ... below cut value: " << _qratio_cut << std::endl;
     }
 
     return (ratio > _qratio_cut ? ratio : -1);
   }

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::CFAlgoQRatio::Report ( )