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	process (Event &event) final
	Processing an event for a Producer is calling produce.
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	beforeNewRun (ldmx::RunHeader &run_header)
	Callback for Producers to add parameters to the run header before conditions are initialized.
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.

Private Attributes
std::string	ecal_rechits_passname_
	Pass name for the EcalRecHits collection.
std::string	ecal_rec_hits_event_passname_

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

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.get<int>("my_parameter");
 
  ldmx_log(info) << "MyProcessor configured with my_parameter = "
                 << my_parameter;
 
  ecal_rechits_passname_ = parameters.get<std::string>("ecal_rechits_passname");
  ecal_rec_hits_event_passname_ =
      parameters.get<std::string>("ecal_rec_hits_event_passname");
}

References ecal_rechits_passname_, and framework::config::Parameters::get().

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 26 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", ecal_rec_hits_event_passname_)) return;
 
  // Get the collection of digitized ECal hits_ from the event
  const std::vector<ldmx::EcalHit> hits =
      event.getCollection<ldmx::EcalHit>("EcalRecHits", ecal_rechits_passname_);
 
  // Loop over the collection of hits_ and print the hit details
  for (const auto &hit : hits) {
    // Print the hit
    ldmx_log(info) << hit;
  }
}

References ecal_rechits_passname_, and framework::Event::exists().

Member Data Documentation

ecal_rec_hits_event_passname_

std::string recon::MyProcessor::ecal_rec_hits_event_passname_

private

Definition at line 55 of file MyProcessor.h.

ecal_rechits_passname_

std::string recon::MyProcessor::ecal_rechits_passname_

private

Pass name for the EcalRecHits collection.

Definition at line 54 of file MyProcessor.h.

Referenced by configure(), and produce().

---

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

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