lar_cluster3d::IClusterModAlg Class Reference

IClusterModAlg interface class definiton. More...

#include <IClusterModAlg.h>

Inheritance diagram for lar_cluster3d::IClusterModAlg:

Public Member Functions
virtual	~IClusterModAlg () noexcept=default
	Virtual Destructor. More...
virtual void	configure (const fhicl::ParameterSet &)=0
	Interface for configuring the particular algorithm tool. More...
virtual void	initializeHistograms (art::TFileDirectory &)=0
	Interface for initializing histograms if they are desired Note that the idea is to put hisgtograms in a subfolder. More...
virtual void	ModifyClusters (reco::ClusterParametersList &) const =0
	Scan an input collection of clusters and modify those according to the specific implementing algorithm. More...
virtual float	getTimeToExecute () const =0
	If monitoring, recover the time to execute a particular function. More...

Detailed Description

IClusterModAlg interface class definiton.

Definition at line 29 of file IClusterModAlg.h.

Constructor & Destructor Documentation

virtual lar_cluster3d::IClusterModAlg::~IClusterModAlg ( )

virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void lar_cluster3d::IClusterModAlg::configure ( const fhicl::ParameterSet &  )

pure virtual

Interface for configuring the particular algorithm tool.

Parameters

ParameterSet

The input set of parameters for configuration

Implemented in lar_cluster3d::MSTPathFinder, lar_cluster3d::VoronoiPathFinder, lar_cluster3d::ConvexHullPathFinder, lar_cluster3d::ClusterPathFinder, and lar_cluster3d::ClusterMergeAlg.

virtual float lar_cluster3d::IClusterModAlg::getTimeToExecute ( ) const

pure virtual

If monitoring, recover the time to execute a particular function.

Implemented in lar_cluster3d::MSTPathFinder, lar_cluster3d::VoronoiPathFinder, lar_cluster3d::ConvexHullPathFinder, lar_cluster3d::ClusterPathFinder, and lar_cluster3d::ClusterMergeAlg.

virtual void lar_cluster3d::IClusterModAlg::initializeHistograms ( art::TFileDirectory &  )

pure virtual

Interface for initializing histograms if they are desired Note that the idea is to put hisgtograms in a subfolder.

Parameters

TFileDirectory

- the folder to store the hists in

Implemented in lar_cluster3d::MSTPathFinder, lar_cluster3d::VoronoiPathFinder, lar_cluster3d::ConvexHullPathFinder, lar_cluster3d::ClusterPathFinder, and lar_cluster3d::ClusterMergeAlg.

virtual void lar_cluster3d::IClusterModAlg::ModifyClusters ( reco::ClusterParametersList &  ) const

pure virtual

Scan an input collection of clusters and modify those according to the specific implementing algorithm.

Parameters

clusterParametersList

A list of cluster objects (parameters from associated hits)

Implemented in lar_cluster3d::MSTPathFinder, lar_cluster3d::VoronoiPathFinder, lar_cluster3d::ConvexHullPathFinder, lar_cluster3d::ClusterPathFinder, and lar_cluster3d::ClusterMergeAlg.

---

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

• IClusterModAlg.h