dqm::SimObjects Class Reference

Generate histograms to check simulation output. More...

#include <SimObjects.h>

Public Member Functions
	SimObjects (const std::string &name, framework::Process &process)
	Constructor.
virtual void	configure (framework::config::Parameters &ps)
	Input python configuration parameters.
virtual void	onProcessStart ()
	Construct histograms depending on which objects are requested.
virtual void	analyze (const framework::Event &event)
	Fills histograms.
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	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	createCalorimeterHists (const std::string &coll_name)
	new calorimeter histograms
void	createTrackerHists (const std::string &coll_name)
	new tracker histograms

Private Attributes
std::string	sim_pass_
	Pass Name for sim objects.
std::string	sim_particles_map_passname_

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

Generate histograms to check simulation output.

Definition at line 14 of file SimObjects.h.

Constructor & Destructor Documentation

SimObjects()

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

inline

Constructor.

Blank Analyzer constructor

Definition at line 21 of file SimObjects.h.

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

Member Function Documentation

analyze()

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

virtual

Fills histograms.

Implements framework::Analyzer.

Definition at line 129 of file SimObjects.cxx.

                                                    {
  static std::vector<framework::ProductTag> sp_maps, calo_colls, track_colls;
  if (sp_maps.empty()) {
    sp_maps = event.searchProducts("SimParticles", "", "");
    if (sp_maps.size() != 1) {
      ldmx_log(warn) << sp_maps.size() << " SimParticle maps which is not one!";
    }
  }
  if (calo_colls.empty()) {
    calo_colls = event.searchProducts("", sim_pass_, ".*SimCalorimeterHit.*");
    for (auto pt : calo_colls) createCalorimeterHists(pt.name());
  }
  if (track_colls.empty()) {
    track_colls = event.searchProducts("", sim_pass_, ".*SimTrackerHit.*");
    for (auto pt : track_colls) createTrackerHists(pt.name());
  }
 
  auto const& particle_map{event.getMap<int, ldmx::SimParticle>(
      "SimParticles", sim_particles_map_passname_)};
  for (auto const& [track_id, particle] : particle_map) {
    auto const& momentum{particle.getMomentum()};
    auto const& vertex{particle.getVertex()};
    histograms_.fill("SimParticles.E", particle.getEnergy());
    histograms_.fill("SimParticles.px", momentum.at(0));
    histograms_.fill("SimParticles.py", momentum.at(1));
    histograms_.fill("SimParticles.pz", momentum.at(2));
    histograms_.fill("SimParticles.time", particle.getTime());
    histograms_.fill("SimParticles.pdg", particle.getPdgID());
    histograms_.fill("SimParticles.x", vertex.at(0));
    histograms_.fill("SimParticles.y", vertex.at(1));
    histograms_.fill("SimParticles.z", vertex.at(2));
    histograms_.fill("SimParticles.process", particle.getProcessType());
    histograms_.fill("SimParticles.track_id", track_id);
    for (auto const& parent : particle.getParents())
      histograms_.fill("SimParticles.parent", parent);
    for (auto const& child : particle.getDaughters())
      histograms_.fill("SimParticles.children", child);
 
    // PN particles are special
    if (particle.getProcessType() ==
        ldmx::SimParticle::ProcessType::photonNuclear) {
      histograms_.fill("pn_child.E", particle.getEnergy());
      histograms_.fill("pn_child.px", momentum.at(0));
      histograms_.fill("pn_child.py", momentum.at(1));
      histograms_.fill("pn_child.pz", momentum.at(2));
      histograms_.fill("pn_child.time", particle.getTime());
      histograms_.fill("pn_child.pdg", particle.getPdgID());
      histograms_.fill("pn_child.x", vertex.at(0));
      histograms_.fill("pn_child.y", vertex.at(1));
      histograms_.fill("pn_child.z", vertex.at(2));
      histograms_.fill("pn_child.track_id", track_id);
      for (auto const& parent : particle.getParents())
        histograms_.fill("pn_child.parent", parent);
      for (auto const& child : particle.getDaughters())
        histograms_.fill("pn_child.children", child);
    }
  }  // loop over sim particle map
 
  for (auto const& pt : calo_colls) {
    auto const& coll{
        event.getCollection<ldmx::SimCalorimeterHit>(pt.name(), sim_pass_)};
    for (auto const& hit : coll) {
      unsigned int n_contribs{hit.getNumberOfContribs()};
      histograms_.fill(pt.name() + ".n_contribs", n_contribs);
      for (unsigned int i_contrib{0}; i_contrib < n_contribs; i_contrib++) {
        ldmx::SimCalorimeterHit::Contrib contrib{hit.getContrib(i_contrib)};
        histograms_.fill(pt.name() + ".incidents", contrib.incident_id_);
        histograms_.fill(pt.name() + ".tracks", contrib.track_id_);
        histograms_.fill(pt.name() + ".pdg", contrib.pdg_code_);
      }
 
      histograms_.fill(pt.name() + ".edep", hit.getEdep());
      auto pos{hit.getPosition()};
      histograms_.fill(pt.name() + ".x", pos.at(0));
      histograms_.fill(pt.name() + ".y", pos.at(1));
      histograms_.fill(pt.name() + ".z", pos.at(2));
      histograms_.fill(pt.name() + ".time", hit.getTime());
    }  // loop over hits in the calorimeter collection
  }  // loop over different calorimeter hit collections
 
  for (auto const& pt : track_colls) {
    auto const& coll{
        event.getCollection<ldmx::SimTrackerHit>(pt.name(), sim_pass_)};
    for (auto const& hit : coll) {
      histograms_.fill(pt.name() + ".particle_E", hit.getEnergy());
      auto momentum{hit.getMomentum()};
      histograms_.fill(pt.name() + ".particle_px", momentum.at(0));
      histograms_.fill(pt.name() + ".particle_py", momentum.at(1));
      histograms_.fill(pt.name() + ".particle_pz", momentum.at(2));
      histograms_.fill(pt.name() + ".edep", hit.getEdep());
      histograms_.fill(pt.name() + ".time", hit.getTime());
      auto pos{hit.getPosition()};
      histograms_.fill(pt.name() + ".x", pos.at(0));
      histograms_.fill(pt.name() + ".y", pos.at(1));
      histograms_.fill(pt.name() + ".z", pos.at(2));
      histograms_.fill(pt.name() + ".track", hit.getTrackID());
      histograms_.fill(pt.name() + ".pdg", hit.getPdgID());
    }  // loop over hits in the tracker collection
  }  // loop over different tracker hit collections
 
  return;
}

References createCalorimeterHists(), createTrackerHists(), framework::HistogramPool::fill(), framework::EventProcessor::histograms_, and sim_pass_.

configure()

void dqm::SimObjects::configure ( framework::config::Parameters & ps )

virtual

Input python configuration parameters.

Reimplemented from framework::EventProcessor.

Definition at line 11 of file SimObjects.cxx.

                                                        {
  sim_pass_ = ps.get<std::string>("sim_pass");
  sim_particles_map_passname_ =
      ps.get<std::string>("sim_particles_map_passname");
  return;
}

References framework::config::Parameters::get(), and sim_pass_.

createCalorimeterHists()

void dqm::SimObjects::createCalorimeterHists ( const std::string & coll_name )

private

new calorimeter histograms

Definition at line 89 of file SimObjects.cxx.

                                                                  {
  getHistoDirectory();
  histograms_.create(coll_name + ".incidents", "Incident Track IDs", 100, 0,
                     1000);
  histograms_.create(coll_name + ".tracks", "Contributing Track IDs", 100, 0,
                     1000);
  histograms_.create(coll_name + ".pdg", "Contributing PDG IDs", 401, -200,
                     200);
  histograms_.create(coll_name + ".edep", "Energy Deposited [MeV]", 100, 0,
                     200);
  histograms_.create(coll_name + ".x", "Hit x-Position [mm]", 401, -200, 200);
  histograms_.create(coll_name + ".y", "Hit y-Position [mm]", 401, -200, 200);
  histograms_.create(coll_name + ".z", "Hit z-Position [mm]", 171, -700, 1000.);
  histograms_.create(coll_name + ".time", "Hit Time [ns]", 50, 0., 10.);
  histograms_.create(coll_name + ".n_contribs", "Number of Contributors", 20,
                     0., 20.);
  return;
}

References framework::HistogramPool::create(), framework::EventProcessor::getHistoDirectory(), and framework::EventProcessor::histograms_.

Referenced by analyze().

createTrackerHists()

void dqm::SimObjects::createTrackerHists ( const std::string & coll_name )

private

new tracker histograms

Definition at line 108 of file SimObjects.cxx.

                                                              {
  getHistoDirectory();
  histograms_.create(coll_name + ".particle_E", "Particle E at Hit [MeV]", 400,
                     0, 4000);
  histograms_.create(coll_name + ".particle_px", "Particle Momentum in x [MeV]",
                     50, 0., 500.);
  histograms_.create(coll_name + ".particle_py", "Particle Momentum in y [MeV]",
                     50, 0., 500.);
  histograms_.create(coll_name + ".particle_pz", "Particle Momentum in z [MeV]",
                     400, 0., 4000.);
  histograms_.create(coll_name + ".edep", "Energy Deposited [MeV]", 100, 0,
                     200);
  histograms_.create(coll_name + ".time", "Hit Time [ns]", 50, 0., 10.);
  histograms_.create(coll_name + ".x", "Hit x-Position [mm]", 401, -200, 200);
  histograms_.create(coll_name + ".y", "Hit y-Position [mm]", 401, -200, 200);
  histograms_.create(coll_name + ".z", "Hit z-Position [mm]", 171, -700, 1000.);
  histograms_.create(coll_name + ".track", "Particle Track ID", 100, 0, 1000);
  histograms_.create(coll_name + ".pdg", "Particle PDG ID", 401, -200, 200);
  return;
}

References framework::HistogramPool::create(), framework::EventProcessor::getHistoDirectory(), and framework::EventProcessor::histograms_.

Referenced by analyze().

onProcessStart()

void dqm::SimObjects::onProcessStart ( )

virtual

Construct histograms depending on which objects are requested.

Reimplemented from framework::EventProcessor.

Definition at line 18 of file SimObjects.cxx.

                                {
  getHistoDirectory();
  std::vector<std::string> creator_process_labels = {
      "Unknown",              // 0: Unknown
      "e+ e- ->  γγ",         // 1: annihil
      "γ e -> γ e",           // 2: compt
      "γ -> e+ e- ",          // 3: conv
      "e Z -> X (eN)",        //  4: electronNuclear
      "e Z -> e Z γ",         //  5: eBrem
      "e- ionization",        // 6: eIoni
      "Multiple scattering",  //  7: msc
      "γ Z -> e Z ",          //   8: phot
      "γ Z -> X (PN)",        //  9: photonNuclear
      "γ -> mumu",            //   10: GammaToMuPair
      "e Z -> e Z A'",        //   11: eDarkBrem
      "Decay",                //   12: Decay
      "Primary",              //  13: Primary
      "mu Z -> X",            //   14: muonNuclear
      "n Z -> X",             //   15: neutronInelastic
      "n Z -> Z*",            //   16: neutronCapture
      "K Z -> X",             //   17: kaonInelastic
      "pi Z -> X",            //  18: pionInelastic
      "p Z -> X",             //  19: protonInelastic
  };
 
  // create sim particles histograms
  histograms_.create("SimParticles.E", "Vertex Total Energy [MeV]", 800, 0.,
                     8000.);
  histograms_.create("SimParticles.px", "Vertex Momentum in x-Direction [MeV]",
                     50, 0., 500.);
  histograms_.create("SimParticles.py", "Vertex Momentum in y-Direction [MeV]",
                     50, 0., 500.);
  histograms_.create("SimParticles.pz", "Vertex Momentum in z-Direction [MeV]",
                     400, 0., 4000.);
  histograms_.create("SimParticles.time", "Global Time of Creation [ns]", 50,
                     0., 10.);
  histograms_.create("SimParticles.pdg", "PDG ID of Particle", 201, -100, 100);
  histograms_.create("SimParticles.x", "Vertex x-Position [mm]", 401, -200,
                     200);
  histograms_.create("SimParticles.y", "Vertex y-Position [mm]", 401, -200,
                     200);
  histograms_.create("SimParticles.z", "Vertex z-Position [mm]", 171, -700,
                     1000.);
  histograms_.create("SimParticles.process", "Creator Process Type",
                     creator_process_labels);
  histograms_.create("SimParticles.track_id", "Track ID of Particle", 100, 0,
                     1000);
  histograms_.create("SimParticles.parent", "Track ID of Parent", 100, 0, 1000);
  histograms_.create("SimParticles.children", "Track IDs of Children", 100, 0,
                     1000);
 
  // create pn children histograms
  histograms_.create("pn_child.E", "Vertex Total Energy [MeV]", 800, 0., 8000.);
  histograms_.create("pn_child.px", "Vertex Momentum in x-Direction [MeV]", 50,
                     0., 500.);
  histograms_.create("pn_child.py", "Vertex Momentum in y-Direction [MeV]", 50,
                     0., 500.);
  histograms_.create("pn_child.pz", "Vertex Momentum in z-Direction [MeV]", 400,
                     0., 4000.);
  histograms_.create("pn_child.time", "Global Time of Creation [ns]", 50, 0.,
                     10.);
  histograms_.create("pn_child.pdg", "PDG ID of Particle", 201, -100, 100);
  histograms_.create("pn_child.x", "Vertex x-Position [mm]", 401, -200, 200);
  histograms_.create("pn_child.y", "Vertex y-Position [mm]", 401, -200, 200);
  histograms_.create("pn_child.z", "Vertex z-Position [mm]", 171, -700, 1000.);
  histograms_.create("pn_child.track_id", "Track ID of Particle", 100, 0, 1000);
  histograms_.create("pn_child.parent", "Track ID of Parent", 100, 0, 1000);
  histograms_.create("pn_child.children", "Track IDs of Children", 100, 0,
                     1000);
}

References framework::HistogramPool::create(), framework::EventProcessor::getHistoDirectory(), and framework::EventProcessor::histograms_.

Member Data Documentation

sim_particles_map_passname_

std::string dqm::SimObjects::sim_particles_map_passname_

private

Definition at line 50 of file SimObjects.h.

sim_pass_

std::string dqm::SimObjects::sim_pass_

private

Pass Name for sim objects.

Definition at line 48 of file SimObjects.h.

Referenced by analyze(), and configure().

---

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

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