hcal::HcalAlignPolarfires Class Reference

Align the two polarfires with drop/keep hints signalling successful merge. More...

#include <HcalAlignPolarfires.h>

Classes
struct	PolarfireQueueEntry

Public Member Functions
	HcalAlignPolarfires (const std::string &n, framework::Process &p)
void	configure (framework::config::Parameters &ps) override
	Callback for the EventProcessor to configure itself from the given set of 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.

Public Attributes
std::queue< PolarfireQueueEntry >	pf0_queue_
	queue of unmatched digis
std::queue< PolarfireQueueEntry >	pf1_queue_
std::pair< int, int >	pf0_spill_counter_ {0, -1}
	spill counter
std::pair< int, int >	pf1_spill_counter_ {0, -1}

Private Attributes
std::vector< std::string >	input_names_
	input decoded objects (vector index == polarfire index_)
std::string	input_pass_
	pass name for decoded objects
std::string	output_name_
	output object name

Static Private Attributes
static int	max_tick_diff = 10
	number of 5MHz ticks difference to consider polarfires aligned

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

Align the two polarfires with drop/keep hints signalling successful merge.

• Only checking for /dropped/ events
• assuming that ticks and spills are already in correct ORDER
• assuming spill numbering is NOT the same between the two DPMs

Definition at line 16 of file HcalAlignPolarfires.h.

Constructor & Destructor Documentation

HcalAlignPolarfires()

hcal::HcalAlignPolarfires::HcalAlignPolarfires ( const std::string & n, framework::Process & p )

inline

Definition at line 52 of file HcalAlignPolarfires.h.

      : framework::Producer(n, p) {}

Member Function Documentation

configure()

void hcal::HcalAlignPolarfires::configure ( framework::config::Parameters & parameters )

overridevirtual

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 18 of file HcalAlignPolarfires.cxx.

                                                                 {
  input_names_ = ps.get<std::vector<std::string>>("input_names");
  input_pass_ = ps.get<std::string>("input_pass");
  output_name_ = ps.get<std::string>("output_name");
  max_tick_diff = ps.get<int>("max_tick_diff");
}  // configure

References framework::config::Parameters::get(), input_names_, input_pass_, max_tick_diff, and output_name_.

produce()

void hcal::HcalAlignPolarfires::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 25 of file HcalAlignPolarfires.cxx.

                                                       {
  // put next package of decoding into the queues
  pf0_queue_.emplace(event, input_names_[0], input_pass_, pf0_spill_counter_);
  pf1_queue_.emplace(event, input_names_[1], input_pass_, pf1_spill_counter_);
 
  // remove empty events from front of queues for end-of-file condition
  while (pf0_queue_.size() > 0 and pf0_queue_.front().digis_.getNumDigis() == 0)
    pf0_queue_.pop();
  while (pf1_queue_.size() > 0 and pf1_queue_.front().digis_.getNumDigis() == 0)
    pf1_queue_.pop();
 
  bool aligned{false};
  ldmx::HgcrocDigiCollection merged;
  if (pf0_queue_.size() > 0 and pf1_queue_.size() > 0) {
    // we have non-empty events in the queues, start alignment procedure
    if (pf0_queue_.front().sameEvent(pf1_queue_.front())) {
      // same spill and ticks within max_tick_diff_ of each other
      // add them together and put them into same object
      merged = pf0_queue_.front().digis_;
      const auto& unmerged{pf1_queue_.front().digis_};
      for (int i{0}; i < unmerged.getNumDigis(); i++) {
        auto digi{unmerged.getDigi(i)};
        std::vector<ldmx::HgcrocDigiCollection::Sample> samples;
        for (int j{0}; j < unmerged.getNumSamplesPerDigi(); j++) {
          samples.push_back(digi.at(i));
        }
        merged.addDigi(digi.id(), samples);
      }
      aligned = true;
      pf0_queue_.pop();
      pf1_queue_.pop();
      setStorageHint(framework::HINT_SHOULD_KEEP);
    } else if (pf0_queue_.front().earlierEvent(pf1_queue_.front())) {
      // should add pf0 but signal event is unmerged
      merged = pf0_queue_.front().digis_;
      pf0_queue_.pop();
      setStorageHint(framework::HINT_SHOULD_DROP);
    } else {
      // should add pf1 but signal event is unmerged
      merged = pf1_queue_.front().digis_;
      pf1_queue_.pop();
      setStorageHint(framework::HINT_SHOULD_DROP);
    }
  } else if (pf0_queue_.size() > 0) {
    // only pf0 has non-empty events left
    // should add pf0 but signal event is unmerged
    merged = pf0_queue_.front().digis_;
    pf0_queue_.pop();
    setStorageHint(framework::HINT_SHOULD_DROP);
  } else if (pf1_queue_.size() > 0) {
    // only pf1 has non-empty events left
    // should add pf1 but signal event is unmerged
    merged = pf1_queue_.front().digis_;
    pf1_queue_.pop();
    setStorageHint(framework::HINT_SHOULD_DROP);
  } else {
    // no more events, both decoders are returning empty events
    abortEvent();
  }
 
  event.add(output_name_, merged);
  event.add(output_name_ + "Aligned", aligned);
}  // produce

References framework::EventProcessor::abortEvent(), ldmx::HgcrocDigiCollection::addDigi(), framework::HINT_SHOULD_DROP, framework::HINT_SHOULD_KEEP, input_names_, input_pass_, output_name_, pf0_queue_, pf0_spill_counter_, and framework::EventProcessor::setStorageHint().

Member Data Documentation

input_names_

std::vector<std::string> hcal::HcalAlignPolarfires::input_names_

private

input decoded objects (vector index == polarfire index_)

Definition at line 18 of file HcalAlignPolarfires.h.

Referenced by configure(), and produce().

input_pass_

std::string hcal::HcalAlignPolarfires::input_pass_

private

pass name for decoded objects

Definition at line 20 of file HcalAlignPolarfires.h.

Referenced by configure(), and produce().

max_tick_diff

int hcal::HcalAlignPolarfires::max_tick_diff = 10

staticprivate

number of 5MHz ticks difference to consider polarfires aligned

Definition at line 24 of file HcalAlignPolarfires.h.

Referenced by configure().

output_name_

std::string hcal::HcalAlignPolarfires::output_name_

private

output object name

Definition at line 22 of file HcalAlignPolarfires.h.

Referenced by configure(), and produce().

pf0_queue_

std::queue<PolarfireQueueEntry> hcal::HcalAlignPolarfires::pf0_queue_

queue of unmatched digis

Definition at line 47 of file HcalAlignPolarfires.h.

Referenced by produce().

pf0_spill_counter_

std::pair<int, int> hcal::HcalAlignPolarfires::pf0_spill_counter_ {0, -1}

spill counter

Definition at line 49 of file HcalAlignPolarfires.h.

{0, -1}, pf1_spill_counter_{0, -1};

Referenced by produce().

pf1_queue_

std::queue<PolarfireQueueEntry> hcal::HcalAlignPolarfires::pf1_queue_

Definition at line 47 of file HcalAlignPolarfires.h.

pf1_spill_counter_

std::pair<int, int> hcal::HcalAlignPolarfires::pf1_spill_counter_ {0, -1}

Definition at line 49 of file HcalAlignPolarfires.h.

{0, -1}, pf1_spill_counter_{0, -1};

---

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

• Hcal/include/Hcal/HcalAlignPolarfires.h
• Hcal/src/Hcal/HcalAlignPolarfires.cxx