recon::MyProcessor Class Reference

Minimal example of a processor. More...

#include <MyProcessor.h>

Public Member Functions
	MyProcessor (const std::string &name, framework::Process &process)
	Constructor.
virtual	~MyProcessor ()=default
	Destructor.
void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified parameters.
void	produce (framework::Event &event) override
	Process the event and put new data products into it.
Public Member Functions inherited from framework::Producer
	Producer (const std::string &name, Process &process)
	Class constructor.
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	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.

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.
Static Public Attributes inherited from framework::Producer
static const int	CLASSTYPE {1}
	Constant used to track EventProcessor types by the PluginFactory.
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

Minimal example of a processor.

This processor will loop over all of the ECal hits in an event and print out their details.

Definition at line 20 of file MyProcessor.h.

Constructor & Destructor Documentation

MyProcessor()

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

Constructor.

Parameters

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

Definition at line 6 of file MyProcessor.cxx.

    : framework::Producer(name, process) {}

Member Function Documentation

configure()

void recon::MyProcessor::configure ( framework::config::Parameters &  parameters )

overridevirtual

Configure the processor using the given user specified parameters.

The user specified parameters that are availabed are defined in the python configuration class. Look at the my_processor.py module of the EventProc python for the python structure.

Parameters

parameters

Set of parameters used to configure this processor.

You access configuration parameters set in the python by asking for the parameter with the same name as the python member variable.

Reimplemented from framework::EventProcessor.

Definition at line 9 of file MyProcessor.cxx.

                                                                 {
  int my_parameter = parameters.getParameter<int>("my_parameter");
 
  std::cout << "MyProcessor has my_parameter = " << my_parameter << std::endl;
}

References framework::config::Parameters::getParameter().

produce()

void recon::MyProcessor::produce ( framework::Event &  event )

overridevirtual

Process the event and put new data products into it.

Parameters

event

The event to process.

Implements framework::Producer.

Definition at line 21 of file MyProcessor.cxx.

                                               {
  // Check if the collection of reconstructed ECal hits exist.  If not,
  // don't bother processing the event.
  if (!event.exists("EcalRecHits")) return;
 
  // Get the collection of digitized ECal hits from the event
  const std::vector<ldmx::EcalHit> hits =
      event.getCollection<ldmx::EcalHit>("EcalRecHits");
 
  // Loop over the collection of hits and print the hit details
  for (const ldmx::EcalHit &hit : hits) {
    // Print the hit
    hit.Print();
  }
}

References framework::Event::exists(), and ldmx::EcalHit::Print().

---

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

• Recon/include/Recon/Examples/MyProcessor.h
• Recon/src/Recon/Examples/MyProcessor.cxx