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

#include <IRawDigitHistogramTool.h>

Inheritance diagram for IRawDigitHistogramTool:
BasicRawDigitAnalysis::BasicRawDigitAnalysis

Public Types

using RawDigitPtrVec = std::vector< art::Ptr< raw::RawDigit >>
 Interface for filling histograms. More...
 
using SimChannelMap = std::map< raw::ChannelID_t, const sim::SimChannel * >
 

Public Member Functions

virtual ~IRawDigitHistogramTool () noexcept=default
 Virtual Destructor. More...
 
virtual void configure (const fhicl::ParameterSet &)=0
 Interface for configuring the particular algorithm tool. More...
 
virtual void initializeHists (detinfo::DetectorClocksData const &clockData, detinfo::DetectorPropertiesData const &detProp, 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 detinfo::DetectorClocksData &, const detinfo::DetectorPropertiesData &, const RawDigitPtrVec &, const SimChannelMap &) const =0
 

Detailed Description

Definition at line 27 of file IRawDigitHistogramTool.h.

Member Typedef Documentation

using IRawDigitHistogramTool::RawDigitPtrVec = std::vector<art::Ptr<raw::RawDigit>>

Interface for filling histograms.

Definition at line 62 of file IRawDigitHistogramTool.h.

Definition at line 63 of file IRawDigitHistogramTool.h.

Constructor & Destructor Documentation

virtual IRawDigitHistogramTool::~IRawDigitHistogramTool ( )
virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

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

Interface for configuring the particular algorithm tool.

Parameters
ParameterSetThe input set of parameters for configuration

Implemented in BasicRawDigitAnalysis::BasicRawDigitAnalysis.

virtual void IRawDigitHistogramTool::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 BasicRawDigitAnalysis::BasicRawDigitAnalysis.

virtual void IRawDigitHistogramTool::fillHistograms ( const detinfo::DetectorClocksData ,
const detinfo::DetectorPropertiesData ,
const RawDigitPtrVec ,
const SimChannelMap  
) const
pure virtual
virtual void IRawDigitHistogramTool::initializeHists ( detinfo::DetectorClocksData const &  clockData,
detinfo::DetectorPropertiesData const &  detProp,
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 BasicRawDigitAnalysis::BasicRawDigitAnalysis.


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