LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
Public Types | Public Member Functions | List of all members
lar_cluster3d::IHit3DBuilder Class Referenceabstract

IHit3DBuilder interface class definiton. More...

#include "IHit3DBuilder.h"

Inheritance diagram for lar_cluster3d::IHit3DBuilder:
lar_cluster3d::SpacePointHit3DBuilder lar_cluster3d::StandardHit3DBuilder

Public Types

enum  TimeValues { COLLECTARTHITS = 0, BUILDTHREEDHITS = 1, NUMTIMEVALUES }
 enumerate the possible values for time checking if monitoring timing More...
 
using RecobHitToPtrMap = std::map< const recob::Hit *, art::Ptr< recob::Hit >>
 Defines a structure mapping art representation to internal. More...
 

Public Member Functions

virtual ~IHit3DBuilder () noexcept=default
 Virtual Destructor. More...
 
virtual void configure (const fhicl::ParameterSet &)=0
 Interface for configuring the particular algorithm tool. More...
 
virtual void Hit3DBuilder (const art::Event &, reco::HitPairList &, RecobHitToPtrMap &) 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

IHit3DBuilder interface class definiton.

Definition at line 26 of file IHit3DBuilder.h.

Member Typedef Documentation

using lar_cluster3d::IHit3DBuilder::RecobHitToPtrMap = std::map<const recob::Hit*, art::Ptr<recob::Hit>>

Defines a structure mapping art representation to internal.

Definition at line 44 of file IHit3DBuilder.h.

Member Enumeration Documentation

enum lar_cluster3d::IHit3DBuilder::TimeValues

enumerate the possible values for time checking if monitoring timing

Enumerator
COLLECTARTHITS 
BUILDTHREEDHITS 
NUMTIMEVALUES 

Definition at line 57 of file IHit3DBuilder.h.

57  {COLLECTARTHITS = 0,
58  BUILDTHREEDHITS = 1,
59  NUMTIMEVALUES
60  };
lar_cluster3d::IHit3DBuilder::NUMTIMEVALUES
Definition: IHit3DBuilder.h:59
lar_cluster3d::IHit3DBuilder::COLLECTARTHITS
Definition: IHit3DBuilder.h:57
lar_cluster3d::IHit3DBuilder::BUILDTHREEDHITS
Definition: IHit3DBuilder.h:58

Constructor & Destructor Documentation

virtual lar_cluster3d::IHit3DBuilder::~IHit3DBuilder ( )
virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void lar_cluster3d::IHit3DBuilder::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::StandardHit3DBuilder, and lar_cluster3d::SpacePointHit3DBuilder.

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

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

Implemented in lar_cluster3d::StandardHit3DBuilder, and lar_cluster3d::SpacePointHit3DBuilder.

virtual void lar_cluster3d::IHit3DBuilder::Hit3DBuilder ( const art::Event &  ,
reco::HitPairList &  ,
RecobHitToPtrMap &   
) 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::StandardHit3DBuilder, and lar_cluster3d::SpacePointHit3DBuilder.

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