LDMX Software
framework::RunHeaderAnalyzer Class Reference

Public Member Functions

 RunHeaderAnalyzer (const std::string &name, framework::Process &process)
 Constructor.
 
virtual ~RunHeaderAnalyzer ()=default
 Destructor.
 
virtual void onNewRun (const ldmx::RunHeader &rh) override
 This is used to print out the run header on a new run.
 
virtual void analyze (const framework::Event &event) override
 Not used but necessary for an analyzer.
 
- Public Member Functions inherited from framework::Analyzer
 Analyzer (const std::string &name, Process &process)
 Class constructor.
 
virtual void process (Event &event) final
 Processing an event for an Analyzer is calling analyze.
 
virtual void beforeNewRun (ldmx::RunHeader &run_header) final
 Don't allow Analyzers to add parameters to the run header.
 
- Public Member Functions inherited from framework::EventProcessor
 DECLARE_FACTORY (EventProcessor, EventProcessor *, const std::string &, Process &)
 declare that we have a factory for this class
 
 EventProcessor (const std::string &name, Process &process)
 Class constructor.
 
virtual ~EventProcessor ()=default
 Class destructor.
 
virtual void configure (framework::config::Parameters &parameters)
 Callback for the EventProcessor to configure itself from the given set of parameters.
 
virtual void onFileOpen (EventFile &event_file)
 Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
 
virtual void onFileClose (EventFile &event_file)
 Callback for the EventProcessor to take any necessary action when a event input ROOT file is closed.
 
virtual void onProcessStart ()
 Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.
 
virtual void onProcessEnd ()
 Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.
 
template<class T >
const T & getCondition (const std::string &condition_name)
 Access a conditions object for the current event.
 
TDirectory * getHistoDirectory ()
 Access/create a directory in the histogram file for this event processor to create histograms and analysis tuples.
 
void setStorageHint (framework::StorageControl::Hint hint)
 Mark the current event as having the given storage control hint from this module_.
 
void setStorageHint (framework::StorageControl::Hint hint, const std::string &purposeString)
 Mark the current event as having the given storage control hint from this module and the given purpose string.
 
int getLogFrequency () const
 Get the current logging frequency from the process.
 
int getRunNumber () const
 Get the run number from the process.
 
std::string getName () const
 Get the processor name.
 
void createHistograms (const std::vector< framework::config::Parameters > &histos)
 Internal function which is used to create histograms passed from the python configuration @parma histos vector of Parameters that configure histograms to create.
 

Additional Inherited Members

- Protected Member Functions inherited from framework::EventProcessor
void abortEvent ()
 Abort the event immediately.
 
- Protected Attributes inherited from framework::EventProcessor
HistogramPool histograms_
 helper object for making and filling histograms
 
NtupleManagerntuple_ {NtupleManager::getInstance()}
 Manager for any ntuples.
 
logging::logger the_log_
 The logger for this EventProcessor.
 

Detailed Description

Definition at line 11 of file RunHeaderAnalyzer.h.

Constructor & Destructor Documentation

◆ RunHeaderAnalyzer()

framework::RunHeaderAnalyzer::RunHeaderAnalyzer ( const std::string & name,
framework::Process & process )
inline

Constructor.

Definition at line 16 of file RunHeaderAnalyzer.h.

Base class for a module which does not produce a data product.
virtual void process(Event &event) final
Processing an event for an Analyzer is calling analyze.

Member Function Documentation

◆ analyze()

void framework::RunHeaderAnalyzer::analyze ( const framework::Event & event)
overridevirtual

Not used but necessary for an analyzer.

Implements framework::Analyzer.

Definition at line 7 of file RunHeaderAnalyzer.cxx.

7{ return; }

◆ onNewRun()

void framework::RunHeaderAnalyzer::onNewRun ( const ldmx::RunHeader & rh)
overridevirtual

This is used to print out the run header on a new run.

Reimplemented from framework::EventProcessor.

Definition at line 5 of file RunHeaderAnalyzer.cxx.

5{ rh.print(); }
void print() const
Print a string desciption of this object.
Definition RunHeader.cxx:31

References ldmx::RunHeader::print().


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