framework::Analyzer Class Reference

Base class for a module which does not produce a data product. More...

#include <EventProcessor.h>

Public Member Functions
	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.
virtual void	analyze (const Event &event)=0
	Process the event and make histograms or summaries.
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	onNewRun (const ldmx::RunHeader &run_header)
	Callback for the EventProcessor to take any necessary action when the run being processed changes.
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
NtupleManager &	ntuple_ {NtupleManager::getInstance()}
	Manager for any ntuples.
logging::logger	the_log_
	The logger for this EventProcessor.

Detailed Description

Base class for a module which does not produce a data product.

Note

This class processes a constant copy of the event which cannot be updated.

Definition at line 294 of file EventProcessor.h.

Constructor & Destructor Documentation

Analyzer()

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

Class constructor.

Parameters

name	Name for this instance of the class.
process	The Process class associated with EventProcessor, provided by the framework

Note

Derived classes must have a constructor of the same interface, which is the only constructor which will be called by the framework

The provided name should not be the class name, but rather a logical label for this instance of the class, as more than one copy of a given class can be loaded into a Process with different parameters. Names should not include whitespace or special characters.

Definition at line 57 of file EventProcessor.cxx.

    : EventProcessor(name, process) {}

Member Function Documentation

analyze()

virtual void framework::Analyzer::analyze ( const Event & event )

pure virtual

Process the event and make histograms or summaries.

Parameters

event

The Event to analyze

Implemented in dqm::EcalClusterAnalyzer, dqm::EcalDigiVerifier, dqm::EcalMipTrackingFeatures, dqm::EcalPnetVetoResults, dqm::EcalShowerFeatures, dqm::EcalVetoResults, dqm::EcalWABRecResults, dqm::GenieTruthDQM, dqm::HCalDQM, dqm::HcalGeometryVerifier, dqm::HcalInefficiencyAnalyzer, dqm::HCalRawDigi, dqm::HcalVetoResults, dqm::HgcrocPulseTruthAnalyzer, dqm::NtuplizeHgcrocDigiCollection, dqm::NtuplizeTrigScintQIEDigis, dqm::PhotoNuclearDQM, dqm::ReSimVerifier, dqm::SampleValidation, dqm::SimObjects, dqm::Trigger, dqm::TrigScintClusterDQM, dqm::TrigScintDigiVerifier, dqm::TrigScintDQM, dqm::TrigScintHitDQM, dqm::TrigScintTrackDQM, dqm::TrkDeDxMassEstFeatures, dqm::VisiblesCutflow, dqm::VisiblesFeatureProducer, ecal::test::EcalCheckEnergyReconstruction, framework::RunHeaderAnalyzer, framework::test::TestAnalyzer, hcal::HcalPedestalAnalyzer, hcal::test::HcalCheckPositionMap, hcal::test::HcalCheckReconstruction, ldmx::ecal::TrigPrimResolutionAnalyzer, packing::SingleSubsystemPacker, tracking::dqm::StraightTracksDQM, tracking::dqm::TrackerDigiDQM, tracking::dqm::TrackingRecoDQM, trigger::DumpFileWriter, trigscint::QIEAnalyzer, trigscint::QualityFlagAnalyzer, trigscint::TestBeamClusterAnalyzer, and trigscint::TestBeamHitAnalyzer.

Referenced by process().

beforeNewRun()

virtual void framework::Analyzer::beforeNewRun ( ldmx::RunHeader & run_header )

inlinefinalvirtual

Don't allow Analyzers to add parameters to the run header.

We make a final override of beforeNewRun to be empty so that any derived Analyzer will not be able to compile an override of the beforeNewRun callback.

Reimplemented from framework::EventProcessor.

Definition at line 325 of file EventProcessor.h.

{}

process()

virtual void framework::Analyzer::process ( Event & event )

inlinefinalvirtual

Processing an event for an Analyzer is calling analyze.

Implements framework::EventProcessor.

Definition at line 316 of file EventProcessor.h.

{ analyze(event); }

References analyze().

---

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

• Framework/include/Framework/EventProcessor.h
• Framework/src/Framework/EventProcessor.cxx