cluster::CMAlgo_Class_Name Class Reference

#include <cmalgo.h>

Inheritance diagram for cluster::CMAlgo_Class_Name:

Public Member Functions
	CMAlgo_Class_Name ()
	Default constructor. More...
virtual	~CMAlgo_Class_Name ()
	Default destructor. More...
virtual void	EventBegin (const std::vector< cluster::ClusterParamsAlg > &clusters)
virtual void	EventEnd ()
virtual void	IterationBegin (const std::vector< cluster::ClusterParamsAlg > &clusters)
virtual void	IterationEnd ()
virtual bool	Bool (const ClusterParamsAlg &cluster1, const ClusterParamsAlg &cluster2)
virtual void	Report ()
virtual void	Reset ()
	Function to reset the algorithm instance ... maybe implemented via child class. More...

Detailed Description

User implementation for CBoolAlgoBase class doxygen documentation!

Definition at line 26 of file cmalgo.h.

Constructor & Destructor Documentation

cluster::CMAlgo_Class_Name::CMAlgo_Class_Name

(

)

Default constructor.

Definition at line 6 of file cmalgo.cxx.

                                       : CBoolAlgoBase()
  //-------------------------------------------------------
  {

  }

virtual cluster::CMAlgo_Class_Name::~CMAlgo_Class_Name ( )

inlinevirtual

Default destructor.

Definition at line 34 of file cmalgo.h.

{};

Member Function Documentation

bool cluster::CMAlgo_Class_Name::Bool ( const ClusterParamsAlg &  cluster1, const ClusterParamsAlg &  cluster2  )

virtual

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

Definition at line 48 of file cmalgo.cxx.

  {
    return false;
  }

void cluster::CMAlgo_Class_Name::EventBegin ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

virtual

Optional function: called at the beginning of 1st iteration. This is called per event.

Definition at line 20 of file cmalgo.cxx.

  {

  }

void cluster::CMAlgo_Class_Name::EventEnd ( )

virtual

Optional function: called at the end of event ... after the last merging iteration is over.

Definition at line 27 of file cmalgo.cxx.

  {

  }

void cluster::CMAlgo_Class_Name::IterationBegin ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

virtual

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.

Definition at line 34 of file cmalgo.cxx.

  {

  }

void cluster::CMAlgo_Class_Name::IterationEnd ( )

virtual

Optional function: called at the end of each iteration over all pairs of clusters.

Definition at line 41 of file cmalgo.cxx.

  {

  }

void cluster::CMAlgo_Class_Name::Report ( )

virtual

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

Definition at line 56 of file cmalgo.cxx.

  {

  }

void cluster::CMAlgo_Class_Name::Reset ( void  )

virtual

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

Definition at line 13 of file cmalgo.cxx.

  {

  }

---

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

• larreco/larreco/RecoAlg/CMTool/mac/tmp/cmalgo.h
• larreco/larreco/RecoAlg/CMTool/mac/tmp/cmalgo.cxx