All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
reco3d::IHitReader Class Referenceabstract

IHitReader interface class definiton. More...

#include <IHitReader.h>

Inheritance diagram for reco3d::IHitReader:
reco3d::HitsICARUS reco3d::HitsStandard

Public Member Functions

virtual ~IHitReader () noexcept=default
 Virtual Destructor. More...
 
virtual void configure (const fhicl::ParameterSet &)=0
 Interface for configuring the particular algorithm tool. More...
 
virtual bool readHits (const std::vector< art::Ptr< recob::Hit >> &, std::vector< art::Ptr< recob::Hit >> &, std::vector< art::Ptr< recob::Hit >> &, std::vector< art::Ptr< recob::Hit >> &) const =0
 Scan an input collection of clusters and modify those according to the specific implementing algorithm. More...
 

Detailed Description

IHitReader interface class definiton.

Definition at line 24 of file IHitReader.h.

Constructor & Destructor Documentation

virtual reco3d::IHitReader::~IHitReader ( )
virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void reco3d::IHitReader::configure ( const fhicl::ParameterSet &  )
pure virtual

Interface for configuring the particular algorithm tool.

Parameters
ParameterSetThe input set of parameters for configuration

Implemented in reco3d::HitsICARUS, and reco3d::HitsStandard.

virtual bool reco3d::IHitReader::readHits ( const std::vector< art::Ptr< recob::Hit >> &  ,
std::vector< art::Ptr< recob::Hit >> &  ,
std::vector< art::Ptr< recob::Hit >> &  ,
std::vector< art::Ptr< recob::Hit >> &   
) const
pure virtual

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

Parameters
clusterParametersListA list of cluster objects (parameters from associated hits)

Implemented in reco3d::HitsICARUS, and reco3d::HitsStandard.


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