cmtool::CPAlgoArray Class Reference

#include "CPAlgoArray.h"

Inheritance diagram for cmtool::CPAlgoArray:

Public Types
enum	EvaluationMode_t { kPositiveAddition, kSimpleAddition, kMultiplication, kLastAlgo }

Public Member Functions
	CPAlgoArray ()
	Default constructor. More...
virtual	~CPAlgoArray ()
	Default destructor. More...
void	AddAlgo (CPriorityAlgoBase *algo)
	Setter to add a new algorithm. More...
void	SetMode (EvaluationMode_t mode)
	Setter for an evaluation. More...
virtual float	Priority (const ::cluster::ClusterParamsAlg &cluster)
virtual void	Report ()
virtual void	Reset ()
	Function to reset the algorithm instance, called together with manager's Reset() 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 float	Priority (const cluster::ClusterParamsAlg &cluster)
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
std::vector< CPriorityAlgoBase * >	_algo_array
	vector of algorithms More...
EvaluationMode_t	_mode
	evaluation mode More...
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 CPriorityAlgoBase class This is an array of priority algorithms. It has multiple modes to compute combined Priority() return value.

Definition at line 26 of file CPAlgoArray.h.

Member Enumeration Documentation

enum cmtool::CPAlgoArray::EvaluationMode_t

Enumerator
kPositiveAddition	DEFAULT: simply add Priority() return values except negative return. If there is a negative return value, it returns that and stop processing the rest of algorithms
kSimpleAddition	Simply add Priority() return values from all algorithms. Note some algorithms are allowed to return negative values.
kMultiplication	Multiply Priority() return values from all algorithms except negative return. If there is a negative return, it returns that and stop processing the rest of algorithms
kLastAlgo	If all algorithms return positive values, return the last algorithm's Priority() return value. If any algorithm returns negative, it returns that and stop processing the rest of algorithms

Definition at line 30 of file CPAlgoArray.h.

                          {
      kPositiveAddition,
      kSimpleAddition,
      kMultiplication,
      kLastAlgo,
    };

Constructor & Destructor Documentation

cmtool::CPAlgoArray::CPAlgoArray

(

)

Default constructor.

Definition at line 9 of file CPAlgoArray.cxx.

References _algo_array, _mode, and kPositiveAddition.

                           : CPriorityAlgoBase()
  //-------------------------------------------------------
  {
    _mode = kPositiveAddition;
    _algo_array.clear();
  }

virtual cmtool::CPAlgoArray::~CPAlgoArray ( )

inlinevirtual

Default destructor.

Definition at line 60 of file CPAlgoArray.h.

{};

Member Function Documentation

void cmtool::CPAlgoArray::AddAlgo ( CPriorityAlgoBase *  algo )

inline

Setter to add a new algorithm.

Definition at line 63 of file CPAlgoArray.h.

References _algo_array.

Referenced by ShowerReco3D::ShowerReco3D().

{ _algo_array.push_back(algo); }

virtual void cmtool::CPAlgoArray::EventBegin ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

inlinevirtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 86 of file CPAlgoArray.h.

References _algo_array.

    { for(auto const& algo : _algo_array) algo->EventBegin(clusters); }

virtual void cmtool::CPAlgoArray::EventEnd ( )

inlinevirtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 92 of file CPAlgoArray.h.

References _algo_array.

    { for(auto const& algo : _algo_array) algo->EventEnd(); }

virtual void cmtool::CPAlgoArray::IterationBegin ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

inlinevirtual

Optional function: called at the beggining of each iterative loop. 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 from cmtool::CMAlgoBase.

Definition at line 100 of file CPAlgoArray.h.

References _algo_array.

    { for(auto const& algo : _algo_array) algo->IterationBegin(clusters); }

virtual void cmtool::CPAlgoArray::IterationEnd ( )

inlinevirtual

Optional function: called at the end of each iterative loop.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 106 of file CPAlgoArray.h.

References _algo_array.

    { for(auto const& algo : _algo_array) algo->IterationEnd(); }

virtual float cmtool::CPriorityAlgoBase::Priority ( const cluster::ClusterParamsAlg &  cluster )

inlinevirtualinherited

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

Definition at line 40 of file CPriorityAlgoBase.h.

References cluster::ClusterParamsAlg::GetNHits().

Referenced by cmtool::CMManagerBase::ComputePriority().

    { 
      if(cluster.GetNHits()) return 1.;
      return 0.1;
    }

float cmtool::CPAlgoArray::Priority ( const ::cluster::ClusterParamsAlg &  cluster )

virtual

Core function: given a set of CPANs, return a float which indicates the compatibility the cluster combination.

Definition at line 17 of file CPAlgoArray.cxx.

References _algo_array, _mode, kLastAlgo, kMultiplication, kPositiveAddition, and kSimpleAddition.

Referenced by SetMode().

  {

    std::vector<float> score_array;
    score_array.reserve(_algo_array.size());

    for(auto const& algo : _algo_array) {

      float score = algo->Priority(cluster);

      if(_mode != kSimpleAddition && score < 0)

        return score;

      score_array.push_back(score);
      
    }

    float score_result = 0;

    switch(_mode) {
      
    case kLastAlgo:
      
      score_result = (*score_array.rbegin());
      break;

    case kSimpleAddition:
    case kPositiveAddition:

      for(auto const& score : score_array) score_result += score;
      break;

    case kMultiplication:

      for(auto const& score : score_array) score_result *= score;
      break;

    }
    
    return score_result;
  }

virtual void cmtool::CPAlgoArray::Report ( )

inlinevirtual

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 78 of file CPAlgoArray.h.

References _algo_array.

{ for(auto const& algo : _algo_array) algo->Report(); }

virtual void cmtool::CPAlgoArray::Reset ( )

inlinevirtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 81 of file CPAlgoArray.h.

References _algo_array.

{ for(auto const& algo : _algo_array) algo->Reset(); }

void cmtool::CMAlgoBase::SetAnaFile ( TFile *  fout )

inlineinherited

Setter function for an output plot TFile pointer.

Definition at line 77 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_fout.

Referenced by cmtool::CMergeManager::EventBegin().

{ _fout = fout; }

void cmtool::CPAlgoArray::SetMode ( EvaluationMode_t  mode )

inline

Setter for an evaluation.

Definition at line 66 of file CPAlgoArray.h.

References _mode, and Priority().

{ _mode = mode; }

virtual void cmtool::CMAlgoBase::SetVerbose ( bool  doit = true )

inlinevirtualinherited

Setter function for verbosity.

Reimplemented in cmtool::CBAlgoArray, cmtool::CFAlgoChargeDistrib, cmtool::CFAlgoVolumeOverlap, cmtool::CFAlgoWireOverlap, cmtool::CFAlgoStartPointCompat, cmtool::CFAlgoStartTimeCompat, cmtool::CFAlgoTimeOverlap, cmtool::CBAlgoStartInCone, cmtool::CBAlgoShortestDistNonEndpoint, and cmtool::CBAlgoTrackSeparate.

Definition at line 80 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_verbose.

Referenced by cmtool::CMatchManager::EventBegin(), cmtool::CMergeManager::EventBegin(), and cluster::SimpleClusterMerger::SimpleClusterMerger().

{ _verbose = doit; }

Member Data Documentation

std::vector<CPriorityAlgoBase*> cmtool::CPAlgoArray::_algo_array

protected

vector of algorithms

Definition at line 112 of file CPAlgoArray.h.

Referenced by AddAlgo(), CPAlgoArray(), EventBegin(), EventEnd(), IterationBegin(), IterationEnd(), Priority(), Report(), and Reset().

TFile* cmtool::CMAlgoBase::_fout

protectedinherited

TFile pointer to an output file.

Definition at line 85 of file CMAlgoBase.h.

Referenced by cmtool::CMAlgoBase::CMAlgoBase(), and cmtool::CMAlgoBase::SetAnaFile().

EvaluationMode_t cmtool::CPAlgoArray::_mode

protected

evaluation mode

Definition at line 115 of file CPAlgoArray.h.

Referenced by CPAlgoArray(), Priority(), and SetMode().

bool cmtool::CMAlgoBase::_verbose

protectedinherited

Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager's verbosity level is >= kPerMerging.

Definition at line 88 of file CMAlgoBase.h.

Referenced by cmtool::CBAlgoAngleAlign::Bool(), cmtool::CBAlgoAngleCompat::Bool(), cmtool::CBAlgoShortestDistSmallCluster::Bool(), cmtool::CBAlgoShortestDist::Bool(), cmtool::CBAlgoOutOfConeSeparate::Bool(), cmtool::CBAlgoPolyOverlap::Bool(), cmtool::CBAlgoAngleSeparate::Bool(), cmtool::CBAlgoCenterOfMassSmall::Bool(), cmtool::CBAlgoCenterOfMass::Bool(), cmtool::CBAlgoStartInPoly::Bool(), cmtool::CBAlgoStartNearEnd::Bool(), cmtool::CBAlgoProhibitAllTracks::Bool(), cmtool::CBAlgoShortestDist::CBAlgoShortestDist(), cmtool::CBAlgoShortestDistSmallCluster::CBAlgoShortestDistSmallCluster(), cmtool::CMAlgoBase::CMAlgoBase(), cmtool::CFAlgoZOverlap::Float(), cmtool::CFAlgoQRatio::Float(), cmtool::CFAlgoStartPointMatch::Float(), cmtool::CMAlgoBase::SetVerbose(), cmtool::CBAlgoShortestDist::ShortestDistanceSquared(), cmtool::CBAlgoShortestDistSmallCluster::ShortestDistanceSquared(), cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared(), and cmtool::CBAlgoCenterOfMassSmall::ShortestDistanceSquared().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgPriority/CPAlgoArray.h
• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgPriority/CPAlgoArray.cxx