DQM analyzer for Geant4 electro-nuclear (EN) interactions. More...

#include <ElectroNuclearDQM.h>

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

void	configure (framework::config::Parameters &parameters) override
	Callback for the EventProcessor to configure itself from the given set of parameters.

void	analyze (const framework::Event &event) override
	Process the event and make histograms or summaries.

Public Member Functions inherited from dqm::NuclearDQM
	NuclearDQM (const std::string &name, framework::Process &process)

void	configure (framework::config::Parameters &parameters) override
	Read common configuration parameters: sim_particles_coll_name, sim_particles_passname, count_light_ions.

Public Member Functions inherited from framework::Analyzer
	Analyzer (const std::string &name, Process &process)
	Class constructor.

virtual void	process (Event &event) final
	Processing an event for an Analyzer is calling analyze.

virtual void	beforeNewRun (ldmx::RunHeader &run_header) final
	Don't allow Analyzers to add parameters to the run header.

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 Member Functions
void	findENElectronProperties (const ldmx::SimParticle en_electron, const std::vector< const ldmx::SimParticle > &en_daughters)
	Fill histograms describing the EN electron and the interaction vertex.

void	findReconstructableKinematics (const std::vector< const ldmx::SimParticle * > &en_daughters)
	Fill "reconstructable" kinematic histograms applying the semi-inclusive acceptance cuts from the analysis definition:

Additional Inherited Members
Public Types inherited from dqm::NuclearDQM
enum class	EventType { nothing_hard = 0 , single_neutron = 1 , two_neutrons = 2 , three_or_more_neutrons = 3 , single_charged_pion = 4 , two_charged_pions = 5 , single_neutral_pion = 6 , single_charged_pion_and_nucleon = 7 , single_charged_pion_and_two_nucleons = 8 , two_charged_pions_and_nucleon = 9 , single_neutral_pion_and_nucleon = 10 , single_neutral_pion_and_two_nucleons = 11 , single_neutral_pion_charged_pion_and_nucleon = 12 , single_proton = 13 , two_protons = 14 , proton_neutron = 15 , klong = 16 , charged_kaon = 17 , kshort = 18 , exotics = 19 , multibody = 20 }
	Classification of PN/EN events by the hard particles produced above a kinetic-energy threshold. More...

enum class	CompactEventType { single_neutron = 0 , single_charged_kaon = 1 , single_neutral_kaon = 2 , two_neutrons = 3 , soft = 4 , other = 5 }
	Compact classification focusing on very-high-energy single particles. More...

Protected Member Functions inherited from dqm::NuclearDQM
std::vector< const ldmx::SimParticle * >	findDaughters (const std::map< int, ldmx::SimParticle > &particleMap, const ldmx::SimParticle *parent, int require_process_type=-1) const
	Return daughters of `parent` that pass PDG-based filtering:

void	findParticleKinematics (const std::vector< const ldmx::SimParticle * > &daughters, const std::string &prefix)
	Fill kinematic histograms for the nuclear interaction products.

void	findExtendedKinematics (const std::vector< const ldmx::SimParticle * > &daughters, const std::string &prefix)
	Fill extended kinematic histograms for EN interactions: hardest_pi_ke/theta (π± only), hardest_pi0_ke/theta, {prefix}_proton_mult, {prefix}_charged_pion_mult, {prefix}_neutral_pion_mult, leading_particle_type.

void	findSubleadingKinematics (const ldmx::SimParticle initiator, const std::vector< const ldmx::SimParticle > &daughters, EventType eventType)
	Fill subleading-kinematics histograms for 1n, 2n, charged-kaon and neutral-kaon event types.

EventType	classifyEvent (const std::vector< const ldmx::SimParticle * > &daughters, double threshold)
	Classify the event by the number and type of hard daughters above `threshold` [MeV] of kinetic energy.

CompactEventType	classifyCompactEvent (const ldmx::SimParticle initiator, const std::vector< const ldmx::SimParticle > &daughters, double threshold)
	Compact classification: looks for a single particle carrying >= 80% of the initiator energy, or two neutrons each above `threshold` [MeV].

constexpr bool	isLightIon (int pdgCode) const
	Return true if `pdgCode` is a light ion (Z <= 4).

Protected Member Functions inherited from framework::EventProcessor
void	abortEvent ()
	Abort the event immediately.

Protected Attributes inherited from dqm::NuclearDQM
std::string	sim_particles_coll_name_

std::string	sim_particles_passname_

bool	count_light_ions_ {true}

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

DQM analyzer for Geant4 electro-nuclear (EN) interactions.

Finds the primary (recoil) electron in the SimParticle map and collects its daughters that were produced by the electronNuclear process. These products are then classified and their kinematics histogrammed using the shared machinery in NuclearDQM.

Definition at line 17 of file ElectroNuclearDQM.h.

Constructor & Destructor Documentation

◆ ElectroNuclearDQM()

dqm::ElectroNuclearDQM::ElectroNuclearDQM	(	const std::string &	name,
		framework::Process &	process )

Definition at line 6 of file ElectroNuclearDQM.cxx.

8 : NuclearDQM(name, process) {}

framework::Analyzer::process

virtual void process(Event &event) final

Processing an event for an Analyzer is calling analyze.

Definition EventProcessor.h:316

Member Function Documentation

◆ analyze()

void dqm::ElectroNuclearDQM::analyze ( const framework::Event & event )

overridevirtual

Process the event and make histograms or summaries.

Parameters

event The Event to analyze

Implements framework::Analyzer.

Definition at line 153 of file ElectroNuclearDQM.cxx.

                                                           {
  auto particle_map{event.getMap<int, ldmx::SimParticle>(
      sim_particles_coll_name_, sim_particles_passname_)};
  if (particle_map.empty()) return;
 
  // The EN electron is the primary beam electron (recoil)
  auto [trackID, en_electron] = analysis::getRecoil(particle_map);
 
  // Collect daughters produced by the electronNuclear process, applying the
  // same PDG filtering as PhotoNuclearDQM (exclude photons, heavy nuclei)
  const auto en_daughters{
      findDaughters(particle_map, en_electron,
                    ldmx::SimParticle::ProcessType::electronNuclear)};
 
  findENElectronProperties(en_electron, en_daughters);
 
  histograms_.fill("en_particle_mult", en_electron->getDaughters().size());
 
  if (en_daughters.empty()) {
    ldmx_log(warn) << "No EN daughters found, skipping kinematics";
    return;
  }
 
  findExtendedKinematics(en_daughters, "en");
  findReconstructableKinematics(en_daughters);
}

◆ configure()

void dqm::ElectroNuclearDQM::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 class_name equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters

parameters Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 10 of file ElectroNuclearDQM.cxx.

                                                                       {
  NuclearDQM::configure(parameters);
}

◆ findENElectronProperties()

void dqm::ElectroNuclearDQM::findENElectronProperties	(	const ldmx::SimParticle *	en_electron,
		const std::vector< const ldmx::SimParticle * > &	en_daughters )

private

Fill histograms describing the EN electron and the interaction vertex.

Uses the EN electron's initial energy and vertex position, and takes the vertex position from the first EN daughter (where the reaction occurred).

Definition at line 14 of file ElectroNuclearDQM.cxx.

                                                           {
  histograms_.fill("en_electron_energy", en_electron->getEnergy());
  histograms_.fill("en_electron_vertex_x", en_electron->getVertex()[0]);
  histograms_.fill("en_electron_vertex_y", en_electron->getVertex()[1]);
  histograms_.fill("en_electron_vertex_z", en_electron->getVertex()[2]);
 
  // The EN interaction vertex is where the first EN daughter was created
  if (!en_daughters.empty()) {
    histograms_.fill("en_vertex_x", en_daughters[0]->getVertex()[0]);
    histograms_.fill("en_vertex_y", en_daughters[0]->getVertex()[1]);
    histograms_.fill("en_vertex_z", en_daughters[0]->getVertex()[2]);
  }
}

References ldmx::SimParticle::getEnergy(), and ldmx::SimParticle::getVertex().

◆ findReconstructableKinematics()

void dqm::ElectroNuclearDQM::findReconstructableKinematics ( const std::vector< const ldmx::SimParticle * > & en_daughters )

private

Fill "reconstructable" kinematic histograms applying the semi-inclusive acceptance cuts from the analysis definition:

theta < 80 deg from beam axis
|p| > 100 MeV/c for charged pions
|p| > 800 MeV/c for protons and kaons
KE > 1000 MeV for neutrons
KE > 2000 MeV for pi0

Fills recon_* and en_recon_* histograms mirroring the extended kinematics set, plus event_type_recon for the reconstructable subset classification.

Definition at line 30 of file ElectroNuclearDQM.cxx.

                                                        {
  // Apply semi-inclusive acceptance cuts (daughters already sorted by KE desc):
  //   theta < 80 deg from beam axis
  //   |p| > 100 MeV/c  for pi±
  //   |p| > 800 MeV/c  for protons and kaons
  //   KE  > 1000 MeV   for neutrons
  //   KE  > 2000 MeV for pi0
  std::vector<const ldmx::SimParticle*> recon;
  for (const auto* d : daughters) {
    std::vector<double> pvec_raw{d->getMomentum()};
    ROOT::Math::XYZVector pvec(pvec_raw[0], pvec_raw[1], pvec_raw[2]);
    if (pvec.Theta() * (180.0 / 3.14159) >= 80.0) continue;
 
    auto pdg_id{std::abs(d->getPdgID())};
    double p_mag{pvec.R()};
    double ke{d->getEnergy() - d->getMass()};
 
    if (pdg_id == 2112) {
      if (ke <= 1000.0) continue;
    } else if (pdg_id == 211) {
      if (p_mag <= 100.0) continue;
    } else if (pdg_id == 2212 || pdg_id == 321 || pdg_id == 130 ||
               pdg_id == 310) {
      if (p_mag <= 800.0) continue;
    } else if (pdg_id == 111) {
      if (ke <= 2000.0) continue;
    } else {
      continue;
    }
    recon.push_back(d);
  }
 
  int recon_neutron_mult{0}, recon_proton_mult{0};
  int recon_charged_pion_mult{0}, recon_neutral_pion_mult{0};
  double recon_total_ke{0}, recon_total_neutron_ke{0};
  double recon_hardest_ke{-1}, recon_hardest_theta{-1};
  double recon_hardest_n_ke{-1}, recon_hardest_n_theta{-1};
  double recon_hardest_p_ke{-1}, recon_hardest_p_theta{-1};
  double recon_hardest_pi_ke{-1}, recon_hardest_pi_theta{-1};
  double recon_hardest_pi0_ke{-1}, recon_hardest_pi0_theta{-1};
 
  for (const auto* d : recon) {
    auto pdg_id{std::abs(d->getPdgID())};
    double ke{d->getEnergy() - d->getMass()};
    recon_total_ke += ke;
 
    std::vector<double> pvec_raw{d->getMomentum()};
    ROOT::Math::XYZVector pvec(pvec_raw[0], pvec_raw[1], pvec_raw[2]);
    auto theta{pvec.Theta() * (180.0 / 3.14159)};
 
    if (recon_hardest_ke < ke) {
      recon_hardest_ke = ke;
      recon_hardest_theta = theta;
    }
 
    if (pdg_id == 2112) {
      recon_neutron_mult++;
      recon_total_neutron_ke += ke;
      if (recon_hardest_n_ke < ke) {
        recon_hardest_n_ke = ke;
        recon_hardest_n_theta = theta;
      }
    } else if (pdg_id == 2212) {
      recon_proton_mult++;
      if (recon_hardest_p_ke < ke) {
        recon_hardest_p_ke = ke;
        recon_hardest_p_theta = theta;
      }
    } else if (pdg_id == 211) {
      recon_charged_pion_mult++;
      if (recon_hardest_pi_ke < ke) {
        recon_hardest_pi_ke = ke;
        recon_hardest_pi_theta = theta;
      }
    } else if (pdg_id == 111) {
      recon_neutral_pion_mult++;
      if (recon_hardest_pi0_ke < ke) {
        recon_hardest_pi0_ke = ke;
        recon_hardest_pi0_theta = theta;
      }
    }
  }
 
  if (!recon.empty()) {
    auto leading_pdg{std::abs(recon[0]->getPdgID())};
    int leading_type{6};
    if (leading_pdg == 211)
      leading_type = 0;
    else if (leading_pdg == 111)
      leading_type = 1;
    else if (leading_pdg == 321)
      leading_type = 2;
    else if (leading_pdg == 130 || leading_pdg == 310)
      leading_type = 3;
    else if (leading_pdg == 2212)
      leading_type = 4;
    else if (leading_pdg == 2112)
      leading_type = 5;
    histograms_.fill("recon_leading_particle_type", leading_type);
  }
 
  auto recon_event_type{classifyEvent(recon, 0)};
  histograms_.fill("event_type_recon", static_cast<int>(recon_event_type));
 
  histograms_.fill("recon_hardest_ke", recon_hardest_ke);
  histograms_.fill("recon_hardest_theta", recon_hardest_theta);
  histograms_.fill("recon_hardest_n_ke", recon_hardest_n_ke);
  histograms_.fill("recon_hardest_n_theta", recon_hardest_n_theta);
  histograms_.fill("recon_hardest_p_ke", recon_hardest_p_ke);
  histograms_.fill("recon_hardest_p_theta", recon_hardest_p_theta);
  histograms_.fill("recon_hardest_pi_ke", recon_hardest_pi_ke);
  histograms_.fill("recon_hardest_pi_theta", recon_hardest_pi_theta);
  histograms_.fill("recon_hardest_pi0_ke", recon_hardest_pi0_ke);
  histograms_.fill("recon_hardest_pi0_theta", recon_hardest_pi0_theta);
  histograms_.fill("en_recon_neutron_mult", recon_neutron_mult);
  histograms_.fill("en_recon_proton_mult", recon_proton_mult);
  histograms_.fill("en_recon_charged_pion_mult", recon_charged_pion_mult);
  histograms_.fill("en_recon_neutral_pion_mult", recon_neutral_pion_mult);
  histograms_.fill("en_recon_total_ke", recon_total_ke);
  histograms_.fill("en_recon_total_neutron_ke", recon_total_neutron_ke);
}

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

DQM/include/DQM/ElectroNuclearDQM.h
DQM/src/DQM/ElectroNuclearDQM.cxx

Public Member Functions

Private Member Functions

Additional Inherited Members