cmtool::CBAlgoProhibitAllTracks Class Reference

#include "CBAlgoProhibitAllTracks.h"

Inheritance diagram for cmtool::CBAlgoProhibitAllTracks:

Public Member Functions
	CBAlgoProhibitAllTracks ()
	Default constructor. More...
virtual	~CBAlgoProhibitAllTracks ()
	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	SetMinEP (double value)
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
double	_min_EP
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 CBAlgoProhibitAllTracks.h.

Constructor & Destructor Documentation

cmtool::CBAlgoProhibitAllTracks::CBAlgoProhibitAllTracks

(

)

Default constructor.

Definition at line 6 of file CBAlgoProhibitAllTracks.cxx.

References SetMinEP().

                                                   : CBoolAlgoBase()
  //-------------------------------------------------------
  {
    SetMinEP(.990000);
  }

virtual cmtool::CBAlgoProhibitAllTracks::~CBAlgoProhibitAllTracks ( )

inlinevirtual

Default destructor.

Definition at line 33 of file CBAlgoProhibitAllTracks.h.

References Bool(), Report(), and Reset().

{};

Member Function Documentation

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

virtual

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. Core function: given the CPAN input, return whether a cluster should be merged or not.

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 46 of file CBAlgoProhibitAllTracks.cxx.

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

Referenced by ~CBAlgoProhibitAllTracks().

  {
    //return true means don't prohibit these two clusters
    if (cluster1.GetParams().eigenvalue_principal > _min_EP ||
        cluster2.GetParams().eigenvalue_principal > _min_EP) {
      if (_verbose)
        std::cout << "Prohibiting clusters with EP's of "
                  << cluster1.GetParams().eigenvalue_principal << " and "
                  << cluster2.GetParams().eigenvalue_principal << std::endl;
      return true;
    }
    return false;
  }

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

{}

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

{}

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

{}

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

{}

void cmtool::CBAlgoProhibitAllTracks::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 63 of file CBAlgoProhibitAllTracks.cxx.

Referenced by ~CBAlgoProhibitAllTracks().

  {}

void cmtool::CBAlgoProhibitAllTracks::Reset ( )

virtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 13 of file CBAlgoProhibitAllTracks.cxx.

Referenced by ~CBAlgoProhibitAllTracks().

  {}

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

{ _fout = fout; }

void cmtool::CBAlgoProhibitAllTracks::SetMinEP ( double  value )

inline

Definition at line 73 of file CBAlgoProhibitAllTracks.h.

References _min_EP, and value.

Referenced by CBAlgoProhibitAllTracks().

{ _min_EP = value; }

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

{ _verbose = doit; }

Member Data Documentation

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

double cmtool::CBAlgoProhibitAllTracks::_min_EP

protected

Definition at line 76 of file CBAlgoProhibitAllTracks.h.

Referenced by Bool(), and SetMinEP().

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(), 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:

• larreco/v09_25_00/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoProhibitAllTracks.h
• larreco/v09_25_00/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoProhibitAllTracks.cxx