Performs digitization of simulated Trigger Scintillator data. More...

#include <TrigScintDigiProducer.h>

Public Types
typedef int	layer

typedef std::pair< double, double >	zboundaries

Public Member Functions
	TrigScintDigiProducer (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.

virtual void	onNewRun (const ldmx::RunHeader &runHeader) override
	Random number generation.

ldmx::TrigScintID	generateRandomID (int module)

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	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::mt19937	rng_
	Random number generator.

std::unique_ptr< ldmx::NoiseGenerator >	noise_generator_ {nullptr}
	Generate noise hits given the number of channels and mean noise.

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.

std::string	sim_particles_coll_name_
	Name of sim particles collection and pass name.

std::string	sim_particles_passname_

int	strips_per_array_ {50}
	Number of strips per array.

int	number_of_arrays_ {3}
	Number of arrays.

double	mean_noise_ {0}
	Mean readout noise.

double	mev_per_mip_ {1.40}
	Total MeV per MIP.

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

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

Performs digitization of simulated Trigger Scintillator data.

Definition at line 33 of file TrigScintDigiProducer.h.

Member Typedef Documentation

◆ layer

int trigscint::TrigScintDigiProducer::layer

Definition at line 35 of file TrigScintDigiProducer.h.

◆ zboundaries

std::pair<double, double> trigscint::TrigScintDigiProducer::zboundaries

Definition at line 37 of file TrigScintDigiProducer.h.

Constructor & Destructor Documentation

◆ TrigScintDigiProducer()

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

Definition at line 10 of file TrigScintDigiProducer.cxx.

12 : Producer(name, process) {}

framework::Producer::Producer

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

Class constructor.

Definition EventProcessor.cxx:53

framework::Producer::process

virtual void process(Event &event) final

Processing an event for a Producer is calling produce.

Definition EventProcessor.h:276

Member Function Documentation

◆ configure()

void trigscint::TrigScintDigiProducer::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 14 of file TrigScintDigiProducer.cxx.

                                                                   {
  // Configure this instance of the producer
  strips_per_array_ = ps.get<int>("number_of_strips");
  number_of_arrays_ = ps.get<int>("number_of_arrays");
  mean_noise_ = ps.get<double>("mean_noise");
  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");
  input_pass_name_ = ps.get<std::string>("input_pass_name");
  output_collection_ = ps.get<std::string>("output_collection");
  sim_particles_coll_name_ = ps.get<std::string>("sim_particles_coll_name");
  sim_particles_passname_ = ps.get<std::string>("sim_particles_passname");
}

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

◆ generateRandomID()

ldmx::TrigScintID trigscint::TrigScintDigiProducer::generateRandomID ( int module )

Definition at line 41 of file TrigScintDigiProducer.cxx.

                                                                  {
  // Uniform distributions for integer generation
  std::uniform_int_distribution<int> strips_dist(0, strips_per_array_ - 1);
  ldmx::TrigScintID temp_id(module, strips_dist(rng_));
  if (module >= TrigScintSection::NUM_SECTIONS) {
    ldmx_log(fatal) << "TrigScintSection is not known";
  }
 
  return temp_id;
}

◆ onNewRun()

void trigscint::TrigScintDigiProducer::onNewRun ( const ldmx::RunHeader & runHeader )

overridevirtual

Random number generation.

Reimplemented from framework::EventProcessor.

Definition at line 28 of file TrigScintDigiProducer.cxx.

                                                         {
  noise_generator_ = std::make_unique<ldmx::NoiseGenerator>(mean_noise_, false);
  noise_generator_->setNoiseThreshold(1);
  // Set up seeds
  const auto& rseed = getCondition<framework::RandomNumberSeedService>(
      framework::RandomNumberSeedService::CONDITIONS_OBJECT_NAME);
 
  noise_generator_->seedGenerator(
      rseed.getSeed("TrigScintDigiProducer::NoiseGenerator"));
  // Random number generator for module id
  rng_.seed(rseed.getSeed("TrigScintDigiProducer"));
}

References framework::RandomNumberSeedService::CONDITIONS_OBJECT_NAME.

◆ produce()

void trigscint::TrigScintDigiProducer::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 52 of file TrigScintDigiProducer.cxx.

                                                         {
  std::map<ldmx::TrigScintID, int> cell_pes, cell_min_p_es;
  std::map<ldmx::TrigScintID, float> xpos, ypos, zpos, edep, time, beam_frac;
  std::set<ldmx::TrigScintID> noise_hit_i_ds;
 
  auto num_rec_hits{0};
 
  // looper over sim hits and aggregate energy depositions for each detID
  const auto sim_hits{event.getCollection<ldmx::SimCalorimeterHit>(
      input_collection_, input_pass_name_)};
  auto particle_map{event.getMap<int, ldmx::SimParticle>(
      sim_particles_coll_name_, sim_particles_passname_)};
 
  int module{-1};
  for (const auto& sim_hit : sim_hits) {
    ldmx::TrigScintID id(sim_hit.getID());
 
    // Just set the module ID to use for noise hits here.  Given that
    // we are currently processing a single module at a time, setting
    // it within the loop shouldn't matter.
    module = id.module();
    std::vector<float> position = sim_hit.getPosition();
    ldmx_log(trace) << " Module ID = " << id.raw();
 
    // check if hits is from beam electron and, if so, add to beamFrac
    for (int i = 0; i < sim_hit.getNumberOfContribs(); i++) {
      auto contrib = sim_hit.getContrib(i);
 
      ldmx_log(trace) << "contrib " << i << " trackID: " << contrib.track_id_
                      << " pdgID: " << contrib.pdg_code_
                      << " edep: " << contrib.edep_;
      ldmx_log(trace) << "\t particle id: "
                      << particle_map[contrib.track_id_].getPdgID()
                      << " particle status: "
                      << particle_map[contrib.track_id_].getGenStatus();
 
      if (particle_map[contrib.track_id_].getPdgID() == 11 &&
          particle_map[contrib.track_id_].getGenStatus() == 1) {
        if (beam_frac.find(id) == beam_frac.end()) {
          beam_frac[id] = contrib.edep_;
        } else {
          beam_frac[id] += contrib.edep_;
        }
      }
    }
 
    // for now, we take an energy weighted average of the hit in each strip to
    // simulate the hit position. AJW: these should be dropped, they are likely
    // to lead to a problem since we can't measure them anyway except roughly y
    // and z, which is encoded in the ids.
    if (edep.find(id) == edep.end()) {
      // first hit, initialize
      edep[id] = sim_hit.getEdep();
      time[id] = sim_hit.getTime() * sim_hit.getEdep();
      xpos[id] = position[0] * sim_hit.getEdep();
      ypos[id] = position[1] * sim_hit.getEdep();
      zpos[id] = position[2] * sim_hit.getEdep();
      num_rec_hits++;
 
    } else {
      // not first hit, aggregate, and store the largest radius hit
      xpos[id] += position[0] * sim_hit.getEdep();
      ypos[id] += position[1] * sim_hit.getEdep();
      zpos[id] += position[2] * sim_hit.getEdep();
      edep[id] += sim_hit.getEdep();
      // AJW: need to figure out a better way to model this...
      time[id] += sim_hit.getTime() * sim_hit.getEdep();
    }
  }
 
  // Create the container to hold the digitized trigger scintillator hits.
  std::vector<ldmx::TrigScintHit> trig_scint_hits;
 
  // loop over detIDs and simulate number of PEs
  for (std::map<ldmx::TrigScintID, float>::iterator it = edep.begin();
       it != edep.end(); ++it) {
    ldmx::TrigScintID id(it->first);
 
    double dep_energy = edep[id];
    time[id] = time[id] / edep[id];
    xpos[id] = xpos[id] / edep[id];
    ypos[id] = ypos[id] / edep[id];
    zpos[id] = zpos[id] / edep[id];
    //  mean number of photoelectrons produced for the given deposited energy
    double mean_pe = dep_energy / mev_per_mip_ * pe_per_mip_;
    std::poisson_distribution<int> poisson_dist(mean_pe + mean_noise_);
    cell_pes[id] = poisson_dist(rng_);
    // energy corresponding to the number of PEs observed
    // the minimum number of PEs is the mean number of PEs minus the noise
    double energy_per_pe = mev_per_mip_ / pe_per_mip_;
    double cell_energy = energy_per_pe * cell_pes[id];
 
    // If a cell has a PE count above threshold, persit the hit.
    // Thresholds are introduced (and configurable) in clustering.
    // the cell PE >=1 suppresses artifical noise that is below one light
    // quantum in the SiPM and unphysical.
    if (cell_pes[id] >= 1) {
      ldmx::TrigScintHit hit;
      hit.setID(id.raw());
      hit.setPE(cell_pes[id]);
      hit.setMinPE(cell_min_p_es[id]);
      hit.setAmplitude(cell_pes[id]);
      hit.setEnergy(cell_energy);
      hit.setTime(time[id]);
      hit.setXPos(xpos[id]);
      hit.setYPos(ypos[id]);
      hit.setZPos(zpos[id]);
      hit.setModuleID(module);
      hit.setBarID(id.bar());  // getFieldValue("bar"));
      hit.setNoise(false);
      hit.setBeamEfrac(beam_frac[id] / dep_energy);
 
      trig_scint_hits.push_back(hit);
    }
 
    ldmx_log(debug) << " ID = " << id.raw() << " Edep: " << edep[id]
                    << " numPEs: " << cell_pes[id] << " time: " << time[id]
                    << " z: " << zpos[id] << "\t X: " << xpos[id]
                    << " Y: " << ypos[id] << " Z: " << zpos[id];
  }  // end of loop over detIDs
 
  // ------------------------------- Noise simulation -----------------------//
  // ------------------------------------------------------------------------//
  // only simulating for single array until
  // all arrays are merged into one collection
  int num_empty_cells = strips_per_array_ - num_rec_hits;
  std::vector<double> noise_hits_pe =
      noise_generator_->generateNoiseHits(num_empty_cells);
 
  ldmx::TrigScintID temp_id;
 
  for (auto& noise_hit_pe : noise_hits_pe) {
    ldmx::TrigScintHit hit;
    // generate random ID from remaining cells
    do {
      temp_id = generateRandomID(module);
    } while (edep.find(temp_id) != edep.end() ||
             noise_hit_i_ds.find(temp_id) != noise_hit_i_ds.end());
 
    ldmx::TrigScintID noise_id = temp_id;
 
    noise_hit_i_ds.insert(noise_id);
    hit.setID(noise_id.raw());
    hit.setPE(noise_hit_pe);
    hit.setMinPE(noise_hit_pe);
    hit.setAmplitude(noise_hit_pe);
    hit.setEnergy(0.);
    hit.setTime(0.);
    hit.setXPos(0.);
    hit.setYPos(0.);
    hit.setZPos(0.);
    hit.setModuleID(module);
    hit.setBarID(noise_id.bar());
    hit.setNoise(true);
    hit.setBeamEfrac(0.);
 
    trig_scint_hits.push_back(hit);
  }
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // - -
 
  event.add(output_collection_, trig_scint_hits);
}

References ldmx::TrigScintID::bar(), ldmx::DetectorID::raw(), ldmx::CalorimeterHit::setAmplitude(), ldmx::TrigScintHit::setBarID(), ldmx::TrigScintHit::setBeamEfrac(), ldmx::CalorimeterHit::setEnergy(), ldmx::CalorimeterHit::setID(), ldmx::HcalHit::setMinPE(), ldmx::TrigScintHit::setModuleID(), ldmx::CalorimeterHit::setNoise(), ldmx::TrigScintHit::setPE(), ldmx::CalorimeterHit::setTime(), ldmx::CalorimeterHit::setXPos(), ldmx::CalorimeterHit::setYPos(), and ldmx::CalorimeterHit::setZPos().

Member Data Documentation

◆ input_collection_

std::string trigscint::TrigScintDigiProducer::input_collection_

private

Name of the input collection containing the sim hits.

Definition at line 68 of file TrigScintDigiProducer.h.

◆ input_pass_name_

std::string trigscint::TrigScintDigiProducer::input_pass_name_

private

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

Definition at line 72 of file TrigScintDigiProducer.h.

◆ mean_noise_

double trigscint::TrigScintDigiProducer::mean_noise_ {0}

private

Mean readout noise.

Definition at line 89 of file TrigScintDigiProducer.h.

89{0};

◆ mev_per_mip_

double trigscint::TrigScintDigiProducer::mev_per_mip_ {1.40}

private

Total MeV per MIP.

Definition at line 92 of file TrigScintDigiProducer.h.

92{1.40};

◆ noise_generator_

std::unique_ptr<ldmx::NoiseGenerator> trigscint::TrigScintDigiProducer::noise_generator_ {nullptr}

private

Generate noise hits given the number of channels and mean noise.

Definition at line 65 of file TrigScintDigiProducer.h.

65{nullptr};

◆ number_of_arrays_

int trigscint::TrigScintDigiProducer::number_of_arrays_ {3}

private

Number of arrays.

Definition at line 86 of file TrigScintDigiProducer.h.

86{3};

◆ output_collection_

std::string trigscint::TrigScintDigiProducer::output_collection_

private

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

Definition at line 76 of file TrigScintDigiProducer.h.

◆ pe_per_mip_

double trigscint::TrigScintDigiProducer::pe_per_mip_ {13.5}

private

Total number of photoelectrons per MIP.

Definition at line 95 of file TrigScintDigiProducer.h.

95{13.5};

◆ rng_

std::mt19937 trigscint::TrigScintDigiProducer::rng_

private

Random number generator.

Definition at line 62 of file TrigScintDigiProducer.h.

◆ sim_particles_coll_name_

std::string trigscint::TrigScintDigiProducer::sim_particles_coll_name_

private

Name of sim particles collection and pass name.

Definition at line 79 of file TrigScintDigiProducer.h.

◆ sim_particles_passname_

std::string trigscint::TrigScintDigiProducer::sim_particles_passname_

private

Definition at line 80 of file TrigScintDigiProducer.h.

◆ strips_per_array_

int trigscint::TrigScintDigiProducer::strips_per_array_ {50}

private

Number of strips per array.

Definition at line 83 of file TrigScintDigiProducer.h.

83{50};

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

TrigScint/include/TrigScint/TrigScintDigiProducer.h
TrigScint/src/TrigScint/TrigScintDigiProducer.cxx

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ layer

◆ zboundaries

Constructor & Destructor Documentation

◆ TrigScintDigiProducer()

Member Function Documentation

◆ configure()

◆ generateRandomID()

◆ onNewRun()

◆ produce()

Member Data Documentation

◆ input_collection_

◆ input_pass_name_

◆ mean_noise_

◆ mev_per_mip_

◆ noise_generator_

◆ number_of_arrays_

◆ output_collection_

◆ pe_per_mip_

◆ rng_

◆ sim_particles_coll_name_

◆ sim_particles_passname_

◆ strips_per_array_