cmtool::CFAlgoQRatio Class Reference

#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...
Public Member Functions inherited from cmtool::CMAlgoBase
	CMAlgoBase ()
virtual	~CMAlgoBase ()=default
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
Protected Attributes inherited from cmtool::CMAlgoBase
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.

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

Member Function Documentation

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

  {

    // 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);
  }

void cmtool::CFAlgoQRatio::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 72 of file CFAlgoQRatio.cxx.

  {}

void cmtool::CFAlgoQRatio::Reset ( void  )

overridevirtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 14 of file CFAlgoQRatio.cxx.

  {}

void cmtool::CFAlgoQRatio::SetQRatioCut ( float  cut )

inline

Setter for the minimum value for charge ratio (below this value Float() returns -1)

Definition at line 55 of file CFAlgoQRatio.h.

    {
      _qratio_cut = cut;
    }

Member Data Documentation

float cmtool::CFAlgoQRatio::_qratio_cut

protected

Definition at line 61 of file CFAlgoQRatio.h.

---

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

• larreco/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoQRatio.h
• larreco/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoQRatio.cxx