dqm::CascadeHistoryDQM Class Reference

DQM analyzer for Bertini cascade history data. More...

#include <CascadeHistoryDQM.h>

Public Member Functions
	CascadeHistoryDQM (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 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	analyzeCascade (const ldmx::CascadeHistory &history)
int	getParticleCategory (int pdgId) const
	Get particle category for histogram binning Returns: 0=proton, 1=neutron, 2=pi+, 3=pi-, 4=pi0, 5=kaon, 6=other.

Private Attributes
std::string	cascade_coll_name_
std::string	cascade_pass_name_

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

DQM analyzer for Bertini cascade history data.

Histograms cascade step counts, particle types, generations, energies, interaction/escape rates, and de-excitation products from BertiniWithHistoryModel.

Definition at line 20 of file CascadeHistoryDQM.h.

Constructor & Destructor Documentation

CascadeHistoryDQM()

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

Definition at line 7 of file CascadeHistoryDQM.cxx.

    : framework::Analyzer(name, process) {}

Member Function Documentation

analyze()

void dqm::CascadeHistoryDQM::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 17 of file CascadeHistoryDQM.cxx.

                                                           {
  if (!event.exists(cascade_coll_name_, cascade_pass_name_)) {
    return;
  }
 
  auto cascade_map = event.getMap<int, ldmx::CascadeHistory>(
      cascade_coll_name_, cascade_pass_name_);
  if (cascade_map.empty()) {
    return;
  }
 
  histograms_.fill("n_cascades", cascade_map.size());
 
  for (const auto& [trackId, history] : cascade_map) {
    analyzeCascade(history);
  }
}

References framework::Event::exists().

analyzeCascade()

void dqm::CascadeHistoryDQM::analyzeCascade ( const ldmx::CascadeHistory & history )

private

Definition at line 35 of file CascadeHistoryDQM.cxx.

                                                                        {
  const auto& steps = history.getSteps();
  if (steps.empty()) {
    return;
  }
 
  // Basic cascade properties
  histograms_.fill("cascade_n_steps", steps.size());
  histograms_.fill("cascade_target_A", history.getTargetA());
  histograms_.fill("cascade_target_Z", history.getTargetZ());
 
  double incident_energy = history.getIncidentEnergy();
  if (incident_energy > 0) {
    histograms_.fill("incident_photon_energy", incident_energy);
  }
 
  // Count particles by type and status
  int n_protons = 0, n_neutrons = 0, n_pions = 0, n_kaons = 0, n_other = 0;
  int n_interacted = 0, n_escaped = 0;
  int max_generation = 0;
 
  // Primary reaction analysis
  int primary_n_protons = 0, primary_n_neutrons = 0;
  int primary_n_piplus = 0, primary_n_piminus = 0, primary_n_pizero = 0;
  int primary_n_kaons = 0, primary_n_other = 0;
  double primary_total_ke = 0;
  double primary_max_ke = 0;
 
  // De-excitation analysis
  int n_deexcitation = 0;
  int n_deexcitation_neutrons = 0, n_deexcitation_protons = 0;
  int n_deexcitation_gammas = 0, n_deexcitation_alphas = 0;
  double deexcitation_total_energy = 0;
 
  for (const auto& step : steps) {
    int pdg = step.getPdgId();
    int abs_pdg = std::abs(pdg);
    int category = getParticleCategory(pdg);
    double ke = step.getKineticEnergy();
 
    switch (category) {
      case 0:
        n_protons++;
        break;
      case 1:
        n_neutrons++;
        break;
      case 2:
      case 3:
      case 4:
        n_pions++;
        break;
      case 5:
        n_kaons++;
        break;
      default:
        n_other++;
        break;
    }
 
    histograms_.fill("step_pdg_category", category);
    histograms_.fill("step_generation", step.getGeneration());
    histograms_.fill("step_stage", step.getStageInt());
    histograms_.fill("step_ke", ke);
    histograms_.fill("step_zone", step.getZone());
 
    // Position within nucleus
    double x = step.getX();
    double y = step.getY();
    double z = step.getZ();
    double radius = std::sqrt(x * x + y * y + z * z);
    histograms_.fill("step_radius", radius);
    histograms_.fill("step_x", x);
    histograms_.fill("step_y", y);
    histograms_.fill("step_z", z);
 
    if (step.getGeneration() > max_generation) {
      max_generation = step.getGeneration();
    }
 
    if (step.didInteract()) {
      n_interacted++;
    }
    if (step.didEscape()) {
      n_escaped++;
      histograms_.fill("escaped_pdg_category", category);
      histograms_.fill("escaped_ke", ke);
    }
 
    // Primary reaction products (generation 1, from the initial gamma-nucleon
    // interaction)
    if (step.getStage() == ldmx::CascadeStage::PRIMARY) {
      histograms_.fill("primary_daughter_pdg", category);
      histograms_.fill("primary_daughter_ke", ke);
      primary_total_ke += ke;
      if (ke > primary_max_ke) primary_max_ke = ke;
 
      if (pdg == 2212)
        primary_n_protons++;
      else if (pdg == 2112)
        primary_n_neutrons++;
      else if (pdg == 211)
        primary_n_piplus++;
      else if (pdg == -211)
        primary_n_piminus++;
      else if (pdg == 111)
        primary_n_pizero++;
      else if (abs_pdg == 321 || abs_pdg == 311 || abs_pdg == 310 ||
               abs_pdg == 130)
        primary_n_kaons++;
      else
        primary_n_other++;
    }
 
    // De-excitation products
    if (step.getStage() == ldmx::CascadeStage::DEEXCITATION) {
      n_deexcitation++;
      deexcitation_total_energy += ke;
      histograms_.fill("deexcitation_pdg", category);
      histograms_.fill("deexcitation_ke", ke);
 
      if (pdg == 2112) {
        n_deexcitation_neutrons++;
        histograms_.fill("deexcitation_neutron_ke", ke);
      } else if (pdg == 2212) {
        n_deexcitation_protons++;
        histograms_.fill("deexcitation_proton_ke", ke);
      } else if (pdg == 22) {
        n_deexcitation_gammas++;
        histograms_.fill("deexcitation_gamma_energy", ke);
      } else if (abs_pdg == 1000020040) {  // alpha
        n_deexcitation_alphas++;
        histograms_.fill("deexcitation_alpha_ke", ke);
      }
    }
  }
 
  // Per-cascade summary
  histograms_.fill("cascade_n_protons", n_protons);
  histograms_.fill("cascade_n_neutrons", n_neutrons);
  histograms_.fill("cascade_n_pions", n_pions);
  histograms_.fill("cascade_n_kaons", n_kaons);
  histograms_.fill("cascade_n_other", n_other);
  histograms_.fill("cascade_n_interacted", n_interacted);
  histograms_.fill("cascade_n_escaped", n_escaped);
  histograms_.fill("cascade_max_generation", max_generation);
 
  // Primary reaction summary
  int primary_n_daughters =
      primary_n_protons + primary_n_neutrons + primary_n_piplus +
      primary_n_piminus + primary_n_pizero + primary_n_kaons + primary_n_other;
  int primary_n_pions = primary_n_piplus + primary_n_piminus + primary_n_pizero;
 
  histograms_.fill("primary_n_daughters", primary_n_daughters);
  histograms_.fill("primary_n_protons", primary_n_protons);
  histograms_.fill("primary_n_neutrons", primary_n_neutrons);
  histograms_.fill("primary_n_piplus", primary_n_piplus);
  histograms_.fill("primary_n_piminus", primary_n_piminus);
  histograms_.fill("primary_n_pizero", primary_n_pizero);
  histograms_.fill("primary_n_pions", primary_n_pions);
  histograms_.fill("primary_n_kaons", primary_n_kaons);
  histograms_.fill("primary_n_other", primary_n_other);
  histograms_.fill("primary_total_daughter_ke", primary_total_ke);
  histograms_.fill("primary_max_daughter_ke", primary_max_ke);
 
  // De-excitation summary
  histograms_.fill("n_deexcitation", n_deexcitation);
  histograms_.fill("n_deexcitation_neutrons", n_deexcitation_neutrons);
  histograms_.fill("n_deexcitation_protons", n_deexcitation_protons);
  histograms_.fill("n_deexcitation_gammas", n_deexcitation_gammas);
  histograms_.fill("n_deexcitation_alphas", n_deexcitation_alphas);
  histograms_.fill("deexcitation_total_energy", deexcitation_total_energy);
 
  // Excitation and residual nucleus
  histograms_.fill("excitation_energy", history.getExcitationEnergy());
  histograms_.fill("residual_A", history.getResidualA());
  histograms_.fill("residual_Z", history.getResidualZ());
}

configure()

void dqm::CascadeHistoryDQM::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 11 of file CascadeHistoryDQM.cxx.

                                                                       {
  cascade_coll_name_ = parameters.get<std::string>(
      "cascade_coll_name", "PhotonuclearCascadeHistories");
  cascade_pass_name_ = parameters.get<std::string>("cascade_pass_name", "");
}

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

getParticleCategory()

int dqm::CascadeHistoryDQM::getParticleCategory ( int pdgId ) const

private

Get particle category for histogram binning Returns: 0=proton, 1=neutron, 2=pi+, 3=pi-, 4=pi0, 5=kaon, 6=other.

Definition at line 214 of file CascadeHistoryDQM.cxx.

                                                          {
  int abs_pdg = std::abs(pdgId);
  if (pdgId == 2212) return 0;  // proton
  if (pdgId == 2112) return 1;  // neutron
  if (pdgId == 211) return 2;   // pi+
  if (pdgId == -211) return 3;  // pi-
  if (pdgId == 111) return 4;   // pi0
  if (abs_pdg == 321 || abs_pdg == 311 || abs_pdg == 310 || abs_pdg == 130)
    return 5;  // kaons
  return 6;    // other
}

Member Data Documentation

cascade_coll_name_

std::string dqm::CascadeHistoryDQM::cascade_coll_name_

private

Definition at line 37 of file CascadeHistoryDQM.h.

cascade_pass_name_

std::string dqm::CascadeHistoryDQM::cascade_pass_name_

private

Definition at line 38 of file CascadeHistoryDQM.h.

---

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

• DQM/include/DQM/CascadeHistoryDQM.h
• DQM/src/DQM/CascadeHistoryDQM.cxx