trigscint::TrigScintRecHitProducer Class Reference

Organizes digis into TrigScintHits, linearizes TDC and ADC info, and converts amplitudes to PEs. More...

#include <TrigScintRecHitProducer.h>

Public Member Functions
	TrigScintRecHitProducer (const std::string &name, framework::Process &process)
void	configure (framework::config::Parameters &parameters) override
	Callback for the processor 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 Member Functions
void	readCalib (const std::string &filename, std::vector< double > *gains, std::vector< double > *pedestals)
	Read per-channel gains and pedestals from a calibration file.

Private Attributes
std::string	input_collection_
	Name of the input collection containing the sim hits.
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.
bool	use_calib_file_ {false}
	If true, read per-channel gains/pedestals from calib_file_.
std::string	calib_file_ {""}
	Path to the per-channel calibration file.
int	integration_window_ {0}
	If > 0: integrate a fixed window starting at sample_of_interest_ If <= 0: integrate all samples.
std::vector< double >	gains_
	Per-channel gains read from the calibration file.
std::vector< double >	pedestals_
	Per-channel pedestals read from the calibration file.

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

Organizes digis into TrigScintHits, linearizes TDC and ADC info, and converts amplitudes to PEs.

Definition at line 37 of file TrigScintRecHitProducer.h.

Constructor & Destructor Documentation

TrigScintRecHitProducer()

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

Definition at line 13 of file TrigScintRecHitProducer.cxx.

    : Producer(name, process) {}

~TrigScintRecHitProducer()

trigscint::TrigScintRecHitProducer::~TrigScintRecHitProducer

(

)

Definition at line 17 of file TrigScintRecHitProducer.cxx.

{}

Member Function Documentation

configure()

void trigscint::TrigScintRecHitProducer::configure ( framework::config::Parameters & parameters )

overridevirtual

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

Parameters

parameters

ParameterSet for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 19 of file TrigScintRecHitProducer.cxx.

                                           {
  pedestal_ = parameters.get<double>("pedestal");
  gain_ = parameters.get<double>("gain");
  mev_per_mip_ = parameters.get<double>("mev_per_mip");
  pe_per_mip_ = parameters.get<double>("pe_per_mip");
  input_collection_ = parameters.get<std::string>("input_collection");
  input_pass_name_ = parameters.get<std::string>("input_pass_name");
  output_collection_ = parameters.get<std::string>("output_collection");
  sample_of_interest_ = parameters.get<int>("sample_of_interest");
 
  use_calib_file_ = parameters.get<bool>("use_calib_file", false);
  calib_file_ = parameters.get<std::string>("calib_file", std::string{""});
 
  // If > 0: integrate [sample_of_interest, sample_of_interest +
  // integration_window) If <= 0: integrate all samples (default)
  integration_window_ = parameters.get<int>("integration_window", 0);
 
  if (use_calib_file_) {
    if (calib_file_.empty()) {
      throw std::runtime_error(
          "TrigScintRecHitProducer: use_calib_file=true but calib_file is "
          "empty.");
    }
    readCalib(calib_file_, &gains_, &pedestals_);
  }
}

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

produce()

void trigscint::TrigScintRecHitProducer::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 47 of file TrigScintRecHitProducer.cxx.

                                                           {
  SimQIE qie;
 
  const auto digis{event.getCollection<trigscint::TrigScintQIEDigis>(
      input_collection_, input_pass_name_)};
 
  std::vector<ldmx::TrigScintHit> trig_scint_hits;
  trig_scint_hits.reserve(digis.size());
 
  for (const auto& digi : digis) {
    ldmx::TrigScintHit hit;
    auto adc{digi.getADC()};
    auto tdc{digi.getTDC()};
 
    hit.setModuleID(0);
    hit.setBarID(digi.getChanID());
    // sim truth from the digi; -1 for data
    hit.setBeamEfrac(digi.getBeamEfrac());
 
    const int soi = sample_of_interest_;
    if (soi < 0 || soi >= int(adc.size()) || soi >= int(tdc.size())) {
      continue;
    }
    if (soi + 1 < int(adc.size())) {
      hit.setAmplitude(qie.adc2Q(adc[soi]) + qie.adc2Q(adc[soi + 1]));
    } else {
      hit.setAmplitude(qie.adc2Q(adc[soi]));
    }
    if (tdc[soi] > 49)
      hit.setTime(-999.);
    else
      hit.setTime(tdc[soi] * 0.5);
 
    int start = soi;
    int end = int(adc.size());
    if (integration_window_ > 0) {
      end = std::min(start + integration_window_, int(adc.size()));
    }
    const int n_samp = std::max(0, end - start);
 
    float integrated_charge = 0.f;
    for (int i = start; i < end; ++i) {
      integrated_charge += qie.adc2Q(adc[i]);
    }
 
    double ped = pedestal_;
    double gain = gain_;
 
    if (use_calib_file_) {
      const int ch = digi.getChanID();
      if (ch >= 0 && ch < int(pedestals_.size())) ped = pedestals_[ch];
      if (ch >= 0 && ch < int(gains_.size())) gain = gains_[ch];
    }
 
    const float ped_subtr_q = integrated_charge - float(n_samp) * float(ped);
 
    hit.setEnergy(ped_subtr_q * 6250.f / float(gain) * float(mev_per_mip_) /
                  float(pe_per_mip_));  // MeV
    hit.setPE(ped_subtr_q * 6250.f / float(gain));
 
    trig_scint_hits.push_back(hit);
  }
  event.add(output_collection_, trig_scint_hits);
}

References trigscint::SimQIE::adc2Q(), ldmx::CalorimeterHit::setAmplitude(), ldmx::TrigScintHit::setBarID(), ldmx::TrigScintHit::setBeamEfrac(), ldmx::CalorimeterHit::setEnergy(), ldmx::TrigScintHit::setModuleID(), ldmx::TrigScintHit::setPE(), and ldmx::CalorimeterHit::setTime().

readCalib()

void trigscint::TrigScintRecHitProducer::readCalib ( const std::string & filename, std::vector< double > * gains, std::vector< double > * pedestals )

private

Read per-channel gains and pedestals from a calibration file.

Definition at line 112 of file TrigScintRecHitProducer.cxx.

                                                                      {
  std::ifstream infile(filename);
  if (!infile) {
    throw std::runtime_error(
        "TrigScintRecHitProducer: Could not open calibration file: " +
        filename);
  }
 
  double ch = 0.;
  double gain = 0.;
  double ped = 0.;
 
  while (infile >> ch >> gain >> ped) {
    const int bar_id = int(ch);
    if (bar_id < 0) continue;
    if (bar_id >= int(gains->size())) {
      gains->resize(bar_id + 1, 0.0);
      pedestals->resize(bar_id + 1, 0.0);
    }
    (*gains)[bar_id] = gain;
    (*pedestals)[bar_id] = ped;
  }
}

Member Data Documentation

calib_file_

std::string trigscint::TrigScintRecHitProducer::calib_file_ {""}

private

Path to the per-channel calibration file.

Definition at line 88 of file TrigScintRecHitProducer.h.

{""};

gain_

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

private

SiPM gain.

Definition at line 70 of file TrigScintRecHitProducer.h.

{1e6};

gains_

std::vector<double> trigscint::TrigScintRecHitProducer::gains_

private

Per-channel gains read from the calibration file.

Definition at line 95 of file TrigScintRecHitProducer.h.

input_collection_

std::string trigscint::TrigScintRecHitProducer::input_collection_

private

Name of the input collection containing the sim hits.

Definition at line 59 of file TrigScintRecHitProducer.h.

input_pass_name_

std::string trigscint::TrigScintRecHitProducer::input_pass_name_

private

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

Definition at line 63 of file TrigScintRecHitProducer.h.

integration_window_

int trigscint::TrigScintRecHitProducer::integration_window_ {0}

private

If > 0: integrate a fixed window starting at sample_of_interest_ If <= 0: integrate all samples.

Definition at line 92 of file TrigScintRecHitProducer.h.

{0};

mev_per_mip_

double trigscint::TrigScintRecHitProducer::mev_per_mip_ {1.40}

private

Total MeV per MIP.

Definition at line 76 of file TrigScintRecHitProducer.h.

{1.40};

output_collection_

std::string trigscint::TrigScintRecHitProducer::output_collection_

private

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

Definition at line 67 of file TrigScintRecHitProducer.h.

pe_per_mip_

double trigscint::TrigScintRecHitProducer::pe_per_mip_ {13.5}

private

Total number of photoelectrons per MIP.

Definition at line 79 of file TrigScintRecHitProducer.h.

{13.5};

pedestal_

double trigscint::TrigScintRecHitProducer::pedestal_ {6.0}

private

QIE pedestal.

Definition at line 73 of file TrigScintRecHitProducer.h.

{6.0};

pedestals_

std::vector<double> trigscint::TrigScintRecHitProducer::pedestals_

private

Per-channel pedestals read from the calibration file.

Definition at line 98 of file TrigScintRecHitProducer.h.

sample_of_interest_

int trigscint::TrigScintRecHitProducer::sample_of_interest_ {2}

private

Total number of photoelectrons per MIP.

Definition at line 82 of file TrigScintRecHitProducer.h.

{2};

use_calib_file_

bool trigscint::TrigScintRecHitProducer::use_calib_file_ {false}

private

If true, read per-channel gains/pedestals from calib_file_.

Definition at line 85 of file TrigScintRecHitProducer.h.

{false};

---

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

• TrigScint/include/TrigScint/TrigScintRecHitProducer.h
• TrigScint/src/TrigScint/TrigScintRecHitProducer.cxx