Public Member Functions
	TrigScintFirmwareHitProducer (const std::string &name, framework::Process &process)

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.

Private Attributes
std::string	input_collection_
	add a hit at index idx to a cluster

std::string	input_pass_name_
	Name of the pass that the input collection is on (empty string means take any pass)

std::string	output_collection_
	Name of the output collection that will be used to stored the digitized trigger scintillator hits.

double	gain_ {1e6}
	SiPM gain.

double	pedestal_ {6.0}
	QIE pedestal.

double	mev_per_mip_ {1.40}
	Total MeV per MIP.

double	pe_per_mip_ {13.5}
	Total number of photoelectrons per MIP.

int	sample_of_interest_ {2}
	Total number of photoelectrons per MIP.

std::string	test_collection_

bool	do_test_ {true}

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

Definition at line 40 of file TrigScintFirmwareHitProducer.h.

Constructor & Destructor Documentation

◆ TrigScintFirmwareHitProducer()

trigscint::TrigScintFirmwareHitProducer::TrigScintFirmwareHitProducer	(	const std::string &	name,
		framework::Process &	process )

inline

Definition at line 42 of file TrigScintFirmwareHitProducer.h.

44 : Producer(name, process) {}

framework::Producer::Producer

Producer(const std::string &name, Process &process)

Class constructor.

Definition EventProcessor.cxx:54

framework::Producer::process

virtual void process(Event &event) final

Processing an event for a Producer is calling produce.

Definition EventProcessor.h:278

Member Function Documentation

◆ configure()

void trigscint::TrigScintFirmwareHitProducer::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 12 of file TrigScintFirmwareHitProducer.cxx.

                                   {
  pedestal_ = ps.get<double>("pedestal");
  gain_ = ps.get<double>("gain");
  mev_per_mip_ = ps.get<double>("mev_per_mip");
  pe_per_mip_ = ps.get<double>("pe_per_mip");
  input_collection_ = ps.get<std::string>("input_collection");
  test_collection_ = ps.get<std::string>("test_collection");
  input_pass_name_ = ps.get<std::string>("input_pass_name");
  output_collection_ = ps.get<std::string>("output_collection");
  sample_of_interest_ = ps.get<int>("sample_of_interest");
  ldmx_log(debug) << "In TrigScintFirmwareHitProducer: configure done!";
  ldmx_log(debug) << "\nPedestal: " << pedestal_ << "\nGain: " << gain_
                  << "\nMEV per MIP: " << mev_per_mip_
                  << "\nPE per MIP: " << pe_per_mip_
                  << "\ninput collection:     " << input_collection_
                  << "\ntest collection:    " << test_collection_
                  << "\nAre we testing:        " << do_test_
                  << "\nInput pass name:     " << input_pass_name_
                  << "\nOutput collection:    " << output_collection_;
  return;
}

References gain_, framework::config::Parameters::get(), input_collection_, input_pass_name_, mev_per_mip_, output_collection_, pe_per_mip_, pedestal_, and sample_of_interest_.

◆ produce()

void trigscint::TrigScintFirmwareHitProducer::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 35 of file TrigScintFirmwareHitProducer.cxx.

                                                                {
  // This processor takes in TS QIE digis and outputs a rec hit collection. It
  // does so using hitproducerHw, which is a validated piece of HLS code whose
  // purpose is to emulate existing reconstruction software in firmware for
  // triggering. I will more fully explain the operation and choices made in
  // hitproducerHw in hitproducerHw
  const auto rechits{event.getCollection<ldmx::TrigScintHit>(test_collection_,
                                                             input_pass_name_)};
  for (const auto &hit : rechits) {
    ldmx_log(debug) << "Analysis barID: " << hit.getBarID()
                    << ", PE Number: " << hit.getPE();
  }
  const auto digis{event.getCollection<trigscint::TrigScintQIEDigis>(
      input_collection_, input_pass_name_)};
  Hit out_hit[NHITS];
  ap_uint<14> fifo[NCHAN][NTIMES];
  ap_uint<8> peds[NCHAN];
  for (int i = 0; i < NCHAN; i++) {
    peds[i] = 0;
    fifo[i][0] = (peds[i] << 6) + 63;
    fifo[i][1] = (peds[i] << 6) + 63;
    fifo[i][2] = (peds[i] << 6) + 63;
    fifo[i][3] = (peds[i] << 6) + 63;
    fifo[i][4] = (peds[i] << 6) + 63;
  }
  for (const auto &digi : digis) {
    std::vector<int> adcs = digi.getADC();
    std::vector<int> tdcs = digi.getTDC();
    for (int i = 0; i < NTIMES; i++) {
      fifo[digi.getChanID()][i] = (ap_uint<14>)((adcs[i] << 6) + (tdcs[i]));
    }
  }
  hitproducerHw(fifo, out_hit, peds);
  std::vector<ldmx::TrigScintHit> trig_scint_hits;
  for (int i = 0; i < NHITS; i++) {
    if (out_hit[i].amp_ >= 3) {
      ldmx_log(debug) << "Firmware barID: " << out_hit[i].b_id_
                      << ", PE Number: " << out_hit[i].amp_;
      ldmx::TrigScintHit hit;
      hit.setModuleID(out_hit[i].m_id_);
      hit.setBarID(out_hit[i].b_id_);
      hit.setTime(out_hit[i].time_);
      hit.setPE(out_hit[i].amp_);
      trig_scint_hits.push_back(hit);
    }
  }
  event.add(output_collection_, trig_scint_hits);
  return;
}

References input_collection_, input_pass_name_, output_collection_, ldmx::TrigScintHit::setBarID(), ldmx::TrigScintHit::setModuleID(), ldmx::TrigScintHit::setPE(), and ldmx::CalorimeterHit::setTime().

Member Data Documentation

◆ do_test_

bool trigscint::TrigScintFirmwareHitProducer::do_test_ {true}

private

Definition at line 83 of file TrigScintFirmwareHitProducer.h.

83{true};

◆ gain_

double trigscint::TrigScintFirmwareHitProducer::gain_ {1e6}

private

SiPM gain.

Definition at line 67 of file TrigScintFirmwareHitProducer.h.

67{1e6};

Referenced by configure().

◆ input_collection_

std::string trigscint::TrigScintFirmwareHitProducer::input_collection_

private

add a hit at index idx to a cluster

Name of the input collection containing the sim hits

Definition at line 56 of file TrigScintFirmwareHitProducer.h.

Referenced by configure(), and produce().

◆ input_pass_name_

std::string trigscint::TrigScintFirmwareHitProducer::input_pass_name_

private

Name of the pass that the input collection is on (empty string means take any pass)

Definition at line 60 of file TrigScintFirmwareHitProducer.h.

Referenced by configure(), and produce().

◆ mev_per_mip_

double trigscint::TrigScintFirmwareHitProducer::mev_per_mip_ {1.40}

private

Total MeV per MIP.

Definition at line 73 of file TrigScintFirmwareHitProducer.h.

73{1.40};

Referenced by configure().

◆ output_collection_

std::string trigscint::TrigScintFirmwareHitProducer::output_collection_

private

Name of the output collection that will be used to stored the digitized trigger scintillator hits.

Definition at line 64 of file TrigScintFirmwareHitProducer.h.

Referenced by configure(), and produce().

◆ pe_per_mip_

double trigscint::TrigScintFirmwareHitProducer::pe_per_mip_ {13.5}

private

Total number of photoelectrons per MIP.

Definition at line 76 of file TrigScintFirmwareHitProducer.h.

76{13.5};

Referenced by configure().

◆ pedestal_

double trigscint::TrigScintFirmwareHitProducer::pedestal_ {6.0}

private

QIE pedestal.

Definition at line 70 of file TrigScintFirmwareHitProducer.h.

70{6.0};

Referenced by configure().

◆ sample_of_interest_

int trigscint::TrigScintFirmwareHitProducer::sample_of_interest_ {2}

private

Total number of photoelectrons per MIP.

Definition at line 79 of file TrigScintFirmwareHitProducer.h.

79{2};

Referenced by configure().

◆ test_collection_

std::string trigscint::TrigScintFirmwareHitProducer::test_collection_

private

Definition at line 81 of file TrigScintFirmwareHitProducer.h.

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

TrigScint/include/TrigScint/TrigScintFirmwareHitProducer.h
TrigScint/src/TrigScint/TrigScintFirmwareHitProducer.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrigScintFirmwareHitProducer()

Member Function Documentation

◆ configure()

◆ produce()

Member Data Documentation

◆ do_test_

◆ gain_

◆ input_collection_

◆ input_pass_name_

◆ mev_per_mip_

◆ output_collection_

◆ pe_per_mip_

◆ pedestal_

◆ sample_of_interest_

◆ test_collection_