lar_cluster3d::IHit3DBuilder Class Reference

IHit3DBuilder interface class definiton. More...

#include <IHit3DBuilder.h>

Inheritance diagram for lar_cluster3d::IHit3DBuilder:

Public Types
enum	TimeValues { COLLECTARTHITS = 0, BUILDTHREEDHITS = 1, BUILDNEWHITS = 2, NUMTIMEVALUES }
	enumerate the possible values for time checking if monitoring timing More...
using	RecobHitToPtrMap = std::unordered_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	produces (art::ProducesCollector &)=0
	The space point building should output the hit collection for those hits which combine to form space points - a nice noise filter! More...
virtual void	configure (const fhicl::ParameterSet &)=0
	Interface for configuring the particular algorithm tool. More...
virtual void	Hit3DBuilder (art::Event &, reco::HitPairList &, RecobHitToPtrMap &)=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 32 of file IHit3DBuilder.h.

Member Typedef Documentation

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

Defines a structure mapping art representation to internal.

Definition at line 56 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
BUILDNEWHITS
NUMTIMEVALUES

Definition at line 69 of file IHit3DBuilder.h.

                    {COLLECTARTHITS   = 0,
                     BUILDTHREEDHITS  = 1,
                     BUILDNEWHITS     = 2,
                     NUMTIMEVALUES
    };

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

ParameterSet

The input set of parameters for configuration

Implemented in lar_cluster3d::SnippetHit3DBuilder, 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::SnippetHit3DBuilder, lar_cluster3d::StandardHit3DBuilder, and lar_cluster3d::SpacePointHit3DBuilder.

virtual void lar_cluster3d::IHit3DBuilder::Hit3DBuilder ( art::Event &  , reco::HitPairList &  , RecobHitToPtrMap &    )

pure virtual

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

Parameters

hitPairList	The input list of 3D hits to run clustering on
clusterParametersList	A list of cluster objects (parameters from associated hits)

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

virtual void lar_cluster3d::IHit3DBuilder::produces ( art::ProducesCollector &  )

pure virtual

The space point building should output the hit collection for those hits which combine to form space points - a nice noise filter!

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

---

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

• larreco/larreco/RecoAlg/Cluster3DAlgs/IHit3DBuilder.h