cmtool::CBAlgoProhibitBigClusters Class Reference

#include <CBAlgoProhibitBigClusters.h>

Inheritance diagram for cmtool::CBAlgoProhibitBigClusters:

Public Member Functions
	CBAlgoProhibitBigClusters ()
	Default constructor. More...
virtual	~CBAlgoProhibitBigClusters ()
	Default destructor. More...
virtual bool	Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
virtual void	Report ()
virtual void	Reset ()
	Function to reset the algorithm instance ... maybe implemented via child class. More...
void	SetMinHits (size_t nhits)
Public Member Functions inherited from cmtool::CBoolAlgoBase
	CBoolAlgoBase ()
	Default constructor. More...
virtual	~CBoolAlgoBase ()
	Default destructor. 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
size_t	_min_hits
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 CBoolAlgoBase class doxygen documentation!

Definition at line 26 of file CBAlgoProhibitBigClusters.h.

Constructor & Destructor Documentation

cmtool::CBAlgoProhibitBigClusters::CBAlgoProhibitBigClusters

(

)

Default constructor.

Definition at line 6 of file CBAlgoProhibitBigClusters.cxx.

                                                       : CBoolAlgoBase()
  //-------------------------------------------------------
  {
    SetMinHits(9999);

  }

virtual cmtool::CBAlgoProhibitBigClusters::~CBAlgoProhibitBigClusters ( )

inlinevirtual

Default destructor.

Definition at line 34 of file CBAlgoProhibitBigClusters.h.

{};

Member Function Documentation

bool cmtool::CBAlgoProhibitBigClusters::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 21 of file CBAlgoProhibitBigClusters.cxx.

  {
    //if both clusters are big enough, prohibit merging
    if(cluster1.GetNHits() > _min_hits && cluster2.GetNHits() > _min_hits)
      return true;
    else
      return false;
  }

void cmtool::CBAlgoProhibitBigClusters::Report ( )

virtual

Optional function: called after each Merge() function call by CMergeManager IFF CMergeManager is run with verbosity level kPerMerging. Maybe useful for debugging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 33 of file CBAlgoProhibitBigClusters.cxx.

  {

  }

void cmtool::CBAlgoProhibitBigClusters::Reset ( void  )

virtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 14 of file CBAlgoProhibitBigClusters.cxx.

  {

  }

void cmtool::CBAlgoProhibitBigClusters::SetMinHits ( size_t  nhits )

inline

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 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. Optional function: called at the end of each iteration over all pairs of clusters.

Definition at line 82 of file CBAlgoProhibitBigClusters.h.

{ _min_hits = nhits; }

Member Data Documentation

size_t cmtool::CBAlgoProhibitBigClusters::_min_hits

protected

Definition at line 86 of file CBAlgoProhibitBigClusters.h.

---

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

• larreco/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoProhibitBigClusters.h
• larreco/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoProhibitBigClusters.cxx