framework::Producer Class Reference

Base class for a module which produces a data product. More...

#include <EventProcessor.h>

Public Member Functions
	Producer (const std::string &name, Process &process)
	Class constructor.
virtual void	produce (Event &event)=0
	Process the event and put new data products into it.
virtual void	beforeNewRun (ldmx::RunHeader &header)
	Handle allowing producers to modify run headers before the run begins.
Public Member Functions inherited from framework::EventProcessor
	EventProcessor (const std::string &name, Process &process)
	Class constructor.
virtual	~EventProcessor ()
	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 &runHeader)
	Callback for the EventProcessor to take any necessary action when the run being processed changes.
virtual void	onFileOpen (EventFile &eventFile)
	Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
virtual void	onFileClose (EventFile &eventFile)
	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.

Static Public Attributes
static const int	CLASSTYPE {1}
	Constant used to track EventProcessor types by the PluginFactory.

Additional Inherited Members
Static Public Member Functions inherited from framework::EventProcessor
static void	declare (const std::string &classname, int classtype, EventProcessorMaker *)
	Internal function which is part of the PluginFactory machinery.
Protected Member Functions inherited from framework::EventProcessor
void	abortEvent ()
	Abort the event immediately.
Protected Attributes inherited from framework::EventProcessor
HistogramHelper	histograms_
	Interface class for making and filling histograms.
NtupleManager &	ntuple_ {NtupleManager::getInstance()}
	Manager for any ntuples.
logging::logger	theLog_
	The logger for this EventProcessor.

Detailed Description

Base class for a module which produces a data product.

Note

This class processes a mutable copy of the event so that it can add data to it.

Definition at line 252 of file EventProcessor.h.

Constructor & Destructor Documentation

Producer()

framework::Producer::Producer	(	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 68 of file EventProcessor.cxx.

    : EventProcessor(name, process) {}

Member Function Documentation

beforeNewRun()

virtual void framework::Producer::beforeNewRun ( ldmx::RunHeader &  header )

inlinevirtual

Handle allowing producers to modify run headers before the run begins.

Parameters

header

RunHeader for Producer to add parameters to

Reimplemented in ecal::test::EcalFakeSimHits, framework::test::TestProducer, hcal::test::HcalFakeSimHits, packing::RawIO, simcore::Simulator, hcal::HcalRawDecoder, and packing::SingleSubsystemUnpacker.

Definition at line 283 of file EventProcessor.h.

{}

produce()

virtual void framework::Producer::produce ( Event &  event )

pure virtual

Process the event and put new data products into it.

Parameters

event

The Event to process.

Implemented in framework::test::TestConfig, dqm::DarkBremInteraction, ecal::EcalDigiProducer, ecal::EcalRawDecoder, ecal::EcalRawEncoder, ecal::EcalRecProducer, ecal::EcalTrigPrimDigiProducer, recon::ParticleFlow, recon::PFEcalClusterProducer, recon::PFHcalClusterProducer, recon::PFTrackProducer, recon::PFTruthProducer, recon::RecoilMissesEcalSkimmer, trigger::EcalTPSelector, trigger::NtupleWriter, trigger::PropagationMapWriter, trigger::TrigEcalClusterProducer, trigger::TrigEcalEnergySum, trigger::TrigElectronProducer, trigger::TrigHcalEnergySum, trigscint::TestBeamClusterProducer, recon::EcalPreselectionSkimmer, ecal::test::EcalFakeSimHits, framework::test::TestProducer, hcal::test::HcalFakeSimHits, packing::FiberTrackerRawDecoder, packing::WRRawDecoder, ecal::DNNEcalVetoProcessor, ecal::EcalClusterProducer, ecal::EcalVetoProcessor, hcal::HcalAlignPolarfires, hcal::HcalClusterProducer, hcal::HcalDigiProducer, hcal::HcalDoubleEndRecProducer, hcal::HcalRawDecoder, hcal::HcalRecProducer, hcal::HcalSingleEndRecProducer, hcal::HcalTrigPrimDigiProducer, hcal::HcalVetoProcessor, hcal::HcalWABVetoProcessor, packing::RawIO, packing::SingleSubsystemUnpacker, recon::BeamElectronLocator, recon::ElectronCounter, recon::MyProcessor, recon::OverlayProducer, recon::SequentialTrigger, recon::TriggerProcessor, simcore::ReSimulator, simcore::Simulator, tracking::reco::AlignmentTestProcessor, tracking::reco::CKFProcessor, tracking::reco::DigitizationProcessor, tracking::reco::GSFProcessor, tracking::reco::SeedFinderProcessor, tracking::reco::TruthSeedProcessor, tracking::reco::Vertexer, tracking::reco::VertexProcessor, trigscint::EventReadoutProducer, trigscint::QIEDecoder, trigscint::QIEEncoder, trigscint::TestBeamHitProducer, trigscint::TrigScintClusterProducer, trigscint::TrigScintDigiProducer, trigscint::TrigScintFirmwareHitProducer, trigscint::TrigScintFirmwareTracker, trigscint::TrigScintQIEDigiProducer, trigscint::TrigScintRecHitProducer, trigscint::TrigScintTrackProducer, trigscint::TruthHitProducer, and simcore::SimulatorBase.

Member Data Documentation

CLASSTYPE

const int framework::Producer::CLASSTYPE {1}

static

Constant used to track EventProcessor types by the PluginFactory.

Definition at line 255 of file EventProcessor.h.

{1};

---

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

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