LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
lar_cluster3d::IClusterAlg Class Referenceabstract

IClusterAlg interface class definiton. More...

#include "IClusterAlg.h"

Inheritance diagram for lar_cluster3d::IClusterAlg:
lar_cluster3d::DBScanAlg lar_cluster3d::MinSpanTreeAlg

Public Types

enum  TimeValues {
  BUILDTHREEDHITS = 0, BUILDHITTOHITMAP = 1, RUNDBSCAN = 2, BUILDCLUSTERINFO = 3,
  PATHFINDING = 4, NUMTIMEVALUES
}
 enumerate the possible values for time checking if monitoring timing More...
 

Public Member Functions

virtual ~IClusterAlg () noexcept=default
 Virtual Destructor. More...
 
virtual void configure (const fhicl::ParameterSet &)=0
 Interface for configuring the particular algorithm tool. More...
 
virtual void Cluster3DHits (reco::HitPairList &hitPairList, reco::ClusterParametersList &clusterParametersList) const =0
 Given a set of recob hits, run DBscan to form 3D clusters. More...
 
virtual void Cluster3DHits (reco::HitPairListPtr &hitPairList, reco::ClusterParametersList &clusterParametersList) const =0
 Given a set of recob hits, run DBscan to form 3D clusters. More...
 
virtual float getTimeToExecute (TimeValues index) const =0
 If monitoring, recover the time to execute a particular function. More...
 

Detailed Description

IClusterAlg interface class definiton.

Definition at line 26 of file IClusterAlg.h.

Member Enumeration Documentation

enumerate the possible values for time checking if monitoring timing

Enumerator
BUILDTHREEDHITS 
BUILDHITTOHITMAP 
RUNDBSCAN 
BUILDCLUSTERINFO 
PATHFINDING 
NUMTIMEVALUES 

Definition at line 61 of file IClusterAlg.h.

Constructor & Destructor Documentation

virtual lar_cluster3d::IClusterAlg::~IClusterAlg ( )
virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void lar_cluster3d::IClusterAlg::Cluster3DHits ( reco::HitPairList hitPairList,
reco::ClusterParametersList clusterParametersList 
) const
pure virtual

Given a set of recob hits, run DBscan to form 3D clusters.

Parameters
hitPairListThe input list of 3D hits to run clustering on
clusterParametersListA list of cluster objects (parameters from associated hits)

Implemented in lar_cluster3d::MinSpanTreeAlg, and lar_cluster3d::DBScanAlg.

virtual void lar_cluster3d::IClusterAlg::Cluster3DHits ( reco::HitPairListPtr hitPairList,
reco::ClusterParametersList clusterParametersList 
) const
pure virtual

Given a set of recob hits, run DBscan to form 3D clusters.

Parameters
hitPairListPtrThe input list of 3D hits to run clustering on
clusterParametersListA list of cluster objects (parameters from associated hits)

Implemented in lar_cluster3d::MinSpanTreeAlg, and lar_cluster3d::DBScanAlg.

virtual void lar_cluster3d::IClusterAlg::configure ( const fhicl::ParameterSet )
pure virtual

Interface for configuring the particular algorithm tool.

Parameters
ParameterSetThe input set of parameters for configuration

Implemented in lar_cluster3d::DBScanAlg.

virtual float lar_cluster3d::IClusterAlg::getTimeToExecute ( TimeValues  index) const
pure virtual

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

Implemented in lar_cluster3d::MinSpanTreeAlg, and lar_cluster3d::DBScanAlg.


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