IClusterModAlg interface class definiton. More...

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	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 25 of file IClusterModAlg.h.

Constructor & Destructor Documentation

virtual lar_cluster3d::IClusterModAlg::~IClusterModAlg ( )

virtualdefaultnoexcept

Virtual Destructor.

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

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

pure virtual

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

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)

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