framework::test::TestProducer Class Reference

Bare producer that creates a collection and an object and puts them on the event bus. More...

Public Member Functions
	TestProducer (const std::string &name, Process &p)
void	configure (framework::config::Parameters &p) final override
	Callback for the EventProcessor to configure itself from the given set of parameters.
void	beforeNewRun (ldmx::RunHeader &header) final override
	Callback for Producers to add parameters to the run header before conditions are initialized.
void	produce (framework::Event &event) final 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	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
int	events_
	number of events we've gotten to
bool	create_run_header_
	should we create the run header?

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

Bare producer that creates a collection and an object and puts them on the event bus.

The pattern this producer creates is the following:

• The vector of Calorimeter hits_ has the same number of entries as the event number
• The IDs of the calorimeter hits_ are set to 10*eventNumber+their_index
• The input object is an HcalVetoResult where events with an event index_ pass
• The max PE hit in the HcalVetoResult has an ID equal to the event index_
• If a run header is created, the event count and the run number are equal

Checks

• Event::add function does not throw any errors.
• Writes and adds a run header where the run number and the number of events are the same.
• sets a storage hint

Definition at line 42 of file FunctionalCoreTest.cxx.

Constructor & Destructor Documentation

TestProducer()

framework::test::TestProducer::TestProducer ( const std::string & name, Process & p )

inline

Definition at line 50 of file FunctionalCoreTest.cxx.

: Producer(name, p) {}

~TestProducer()

framework::test::TestProducer::~TestProducer ( )

inline

Definition at line 51 of file FunctionalCoreTest.cxx.

{}

Member Function Documentation

beforeNewRun()

void framework::test::TestProducer::beforeNewRun ( ldmx::RunHeader & run_header )

inlinefinaloverridevirtual

Callback for Producers to add parameters to the run header before conditions are initialized.

Reimplemented from framework::EventProcessor.

Definition at line 57 of file FunctionalCoreTest.cxx.

                                                          {
    if (not create_run_header_) return;
    header.setIntParameter("Should Be Run Number", header.getRunNumber());
    return;
  }

References create_run_header_.

configure()

void framework::test::TestProducer::configure ( framework::config::Parameters & parameters )

inlinefinaloverridevirtual

Callback for the EventProcessor to configure itself from the given set of parameters.

The parameters a processor has access to are the member variables of the python class in the sequence that has className equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters

parameters

Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 53 of file FunctionalCoreTest.cxx.

                                                              {
    create_run_header_ = p.get<bool>("createRunHeader");
  }

References create_run_header_.

produce()

void framework::test::TestProducer::produce ( framework::Event & event )

inlinefinaloverridevirtual

Process the event and put new data products into it.

Parameters

event

The Event to process.

Implements framework::Producer.

Definition at line 63 of file FunctionalCoreTest.cxx.

                                                     {
    int i_event = event.getEventNumber();
 
    REQUIRE(i_event > 0);
 
    std::vector<ldmx::CalorimeterHit> calo_hits;
    for (int i = 0; i < i_event; i++) {
      calo_hits.emplace_back();
      calo_hits.back().setID(i_event * 10 + i);
    }
 
    REQUIRE_NOTHROW(event.add("TestCollection", calo_hits));
 
    ldmx::HcalHit max_pe_hit;
    max_pe_hit.setID(i_event);
 
    ldmx::HcalVetoResult res;
    res.setMaxPEHit(max_pe_hit);
    res.setVetoResult(i_event % 2 == 0);
 
    REQUIRE_NOTHROW(event.add("TestObject", res));
 
    events_ = i_event;
 
    std::vector<int> event_indices = {i_event, i_event};
    REQUIRE_NOTHROW(event.add("EventIndex", event_indices));
 
    float test_float = i_event * 0.1;
    REQUIRE_NOTHROW(event.add("EventTenth", test_float));
 
    if (res.passesVeto()) setStorageHint(StorageControl::Hint::MustKeep);
 
    return;
  }

References events_, ldmx::HcalVetoResult::passesVeto(), ldmx::CalorimeterHit::setID(), ldmx::HcalVetoResult::setMaxPEHit(), framework::EventProcessor::setStorageHint(), and ldmx::HcalVetoResult::setVetoResult().

Member Data Documentation

create_run_header_

bool framework::test::TestProducer::create_run_header_

private

should we create the run header?

Definition at line 47 of file FunctionalCoreTest.cxx.

Referenced by beforeNewRun(), and configure().

events_

int framework::test::TestProducer::events_

private

number of events we've gotten to

Definition at line 44 of file FunctionalCoreTest.cxx.

Referenced by produce().

---

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

• Framework/test/FunctionalCoreTest.cxx