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

#include <IHitHistogramTool.h>

Inheritance diagram for IHitHistogramTool:
BasicHitAnalysis::BasicHitAnalysis

Public Types

using HitPtrVec = std::vector< art::Ptr< recob::Hit >>
 Interface for filling histograms. More...
 

Public Member Functions

virtual ~IHitHistogramTool () noexcept=default
 Virtual Destructor. More...
 
virtual void configure (const fhicl::ParameterSet &)=0
 Interface for configuring the particular algorithm tool. More...
 
virtual void initializeHists (art::ServiceHandle< art::TFileService > &, const std::string &)=0
 Interface for initializing the histograms to be filled. More...
 
virtual void endJob (int numEvents)=0
 Interface for method to executve at the end of run processing. More...
 
virtual void fillHistograms (const HitPtrVec &) const =0
 

Detailed Description

Definition at line 22 of file IHitHistogramTool.h.

Member Typedef Documentation

using IHitHistogramTool::HitPtrVec = std::vector<art::Ptr<recob::Hit>>

Interface for filling histograms.

Definition at line 55 of file IHitHistogramTool.h.

Constructor & Destructor Documentation

virtual IHitHistogramTool::~IHitHistogramTool ( )
virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void IHitHistogramTool::configure ( const fhicl::ParameterSet &  )
pure virtual

Interface for configuring the particular algorithm tool.

Parameters
ParameterSetThe input set of parameters for configuration

Implemented in BasicHitAnalysis::BasicHitAnalysis.

virtual void IHitHistogramTool::endJob ( int  numEvents)
pure virtual

Interface for method to executve at the end of run processing.

Parameters
intnumber of events to use for normalization

Implemented in BasicHitAnalysis::BasicHitAnalysis.

virtual void IHitHistogramTool::fillHistograms ( const HitPtrVec ) const
pure virtual
virtual void IHitHistogramTool::initializeHists ( art::ServiceHandle< art::TFileService > &  ,
const std::string &   
)
pure virtual

Interface for initializing the histograms to be filled.

Parameters
TFileServicehandle to the TFile service
stringsubdirectory to store the hists in

Implemented in BasicHitAnalysis::BasicHitAnalysis.


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