dqm::EcalDigiVerifier Class Reference

Generate histograms to check digi pipeline performance. More...

#include <EcalDigiVerifier.h>

Public Member Functions
	EcalDigiVerifier (const std::string &name, framework::Process &process)
	Constructor.
virtual void	configure (framework::config::Parameters &ps)
	Input python configuration parameters.
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	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::string	ecal_sim_hit_coll_
	Collection Name for SimHits.
std::string	ecal_sim_hit_pass_
	Pass Name for SimHits.
std::string	ecal_rec_hit_coll_
	Collection Name for RecHits.
std::string	ecal_rec_hit_pass_
	Pass Name for RecHits.
std::string	ecal_presel_coll_
	Collection Name for Preselection Decision.
std::string	ecal_presel_pass_
	Pass Name for Preselection Decision.
int	num_layers_
	Number of layers in the ECAL.

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 digi pipeline performance.

Definition at line 15 of file EcalDigiVerifier.h.

Constructor & Destructor Documentation

EcalDigiVerifier()

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

inline

Constructor.

Blank Analyzer constructor

Definition at line 22 of file EcalDigiVerifier.h.

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

Member Function Documentation

analyze()

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

virtual

Fills histograms.

Implements framework::Analyzer.

Definition at line 22 of file EcalDigiVerifier.cxx.

                                                          {
  // get truth information sorted into an ID based map
  std::vector<ldmx::SimCalorimeterHit> ecal_sim_hits =
      event.getCollection<ldmx::SimCalorimeterHit>(ecal_sim_hit_coll_,
                                                   ecal_sim_hit_pass_);
 
  // sort sim hits by ID
  std::sort(ecal_sim_hits.begin(), ecal_sim_hits.end(),
            [](const ldmx::SimCalorimeterHit& lhs,
               const ldmx::SimCalorimeterHit& rhs) {
              return lhs.getID() < rhs.getID();
            });
 
  std::vector<ldmx::EcalHit> ecal_rec_hits = event.getCollection<ldmx::EcalHit>(
      ecal_rec_hit_coll_, ecal_rec_hit_pass_);
 
  // sort rec hits by ID
  std::sort(ecal_rec_hits.begin(), ecal_rec_hits.end(),
            [](const ldmx::EcalHit& lhs, const ldmx::EcalHit& rhs) {
              return lhs.getID() < rhs.getID();
            });
 
  int num_rec_hits{0};
  int num_noise_hits{0};
  double total_rec_energy{0.};
  int num_mod_with_0hits{0};
  int num_mod_with_1hits{0};
  int num_mod_with_2hits{0};
  int num_mod_with_more_than_2hits{0};
  std::vector<int> my_costum_mod_ids;
  // I need a set for the case when there are repeated elements
  std::set<int> my_costum_mod_ids_set;
 
  // Loop on the ecal rechits
  for (const ldmx::EcalHit& rec_hit : ecal_rec_hits) {
    num_rec_hits++;
 
    // Building up an ID that has layer + module information
    ldmx::EcalID ecal_id(rec_hit.getID());
    int layer = ecal_id.layer() + 1;
    int module_id = ecal_id.getModuleID() + 1;
    int my_mod_costum_id = layer * 100 + module_id;
 
    my_costum_mod_ids.push_back(my_mod_costum_id);
    my_costum_mod_ids_set.insert(my_mod_costum_id);
 
    // Measure the sum energy of all rechits (inc noise)
    total_rec_energy += rec_hit.getEnergy();
 
    // skip anything that digi flagged as noise
    if (rec_hit.isNoise()) {
      num_noise_hits++;
      histograms_.fill("is_noise_hit", 1.);
      continue;
    }  // end if noise
    histograms_.fill("is_noise_hit", 0.);
 
    int raw_id = rec_hit.getID();
 
    // energy weighted sim hit positions
    double sim_pos_x_weighted = 0.;
    double sim_pos_y_weighted = 0.;
    double sim_pos_z_weighted = 0.;
 
    // get information for this hit
    int num_sim_hits = 0;
    double total_sim_energy_dep = 0.;
    for (const ldmx::SimCalorimeterHit& sim_hit : ecal_sim_hits) {
      if (raw_id == sim_hit.getID()) {
        num_sim_hits += sim_hit.getNumberOfContribs();
        total_sim_energy_dep += sim_hit.getEdep();
        sim_pos_x_weighted += sim_hit.getPosition()[0] * sim_hit.getEdep();
        sim_pos_y_weighted += sim_hit.getPosition()[1] * sim_hit.getEdep();
        sim_pos_z_weighted += sim_hit.getPosition()[2] * sim_hit.getEdep();
 
      } else if (raw_id < sim_hit.getID()) {
        // later sim hits - all done
        break;
      }
    }  // end loop on sim hits
 
    sim_pos_x_weighted /= total_sim_energy_dep;
    sim_pos_y_weighted /= total_sim_energy_dep;
    sim_pos_z_weighted /= total_sim_energy_dep;
    auto residual_x = rec_hit.getXPos() - sim_pos_x_weighted;
    auto residual_y = rec_hit.getYPos() - sim_pos_y_weighted;
    auto residual_z = rec_hit.getZPos() - sim_pos_z_weighted;
    histograms_.fill("rec_sim_hit_residual_x", residual_x);
    histograms_.fill("rec_sim_hit_residual_y", residual_y);
    histograms_.fill("rec_sim_hit_residual_z", residual_z);
    histograms_.fill("rec_sim_hit_residual_x:layer", residual_x, layer);
    histograms_.fill("rec_sim_hit_residual_y:layer", residual_y, layer);
    histograms_.fill("rec_sim_hit_residual_z:layer", residual_z, layer);
    histograms_.fill("num_sim_hits_per_cell", num_sim_hits);
    histograms_.fill("sim_edep:rec_amplitude", total_sim_energy_dep,
                     rec_hit.getAmplitude());
    histograms_.fill("sim_edep:rec_energy", total_sim_energy_dep,
                     rec_hit.getEnergy());
  }  // end loop on rec hits
 
  std::map<int, int> module_hits;
  for (const int& my_costum_mod_id : my_costum_mod_ids) {
    module_hits[my_costum_mod_id]++;
  }
 
  // all modules is 34*7 = 238
  // this would be nice if not hardcoded...
  num_mod_with_0hits = num_layers_ * 7 - my_costum_mod_ids_set.size();
 
  for (const auto& module_hit : module_hits) {
    if (module_hit.second == 1) {
      num_mod_with_1hits++;
    } else if (module_hit.second == 2) {
      num_mod_with_2hits++;
    } else if (module_hit.second > 2) {
      histograms_.fill("num_hit_if_more_than_2hits", module_hit.second);
      num_mod_with_more_than_2hits++;
    }
  }
 
  histograms_.fill("num_rec_hits", num_rec_hits);
  histograms_.fill("num_noise_hits", num_noise_hits);
  histograms_.fill("total_rec_energy", total_rec_energy);
 
  histograms_.fill("num_mod_with_0hits", num_mod_with_0hits);
  // only fill the histograms in the case there are hits, otherwise it goes to
  // the other categories
  if (num_mod_with_1hits > 0)
    histograms_.fill("num_mod_with_1hits", num_mod_with_1hits);
  if (num_mod_with_2hits > 0)
    histograms_.fill("num_mod_with_2hits", num_mod_with_2hits);
  if (num_mod_with_more_than_2hits > 0)
    histograms_.fill("num_mod_with_more_than_2hits",
                     num_mod_with_more_than_2hits);
 
  // Check if preselection decision exists and fill histogram
  if (event.exists(ecal_presel_coll_, ecal_presel_pass_)) {
    bool presel_passed =
        event.getObject<bool>(ecal_presel_coll_, ecal_presel_pass_);
    histograms_.fill("preselection_passed", presel_passed ? 1. : 0.);
  }
 
  if (total_rec_energy > 6000.) {
    setStorageHint(framework::HINT_SHOULD_KEEP);
  } else {
    setStorageHint(framework::HINT_SHOULD_DROP);
  }
 
  return;
}

References ecal_presel_coll_, ecal_presel_pass_, ecal_rec_hit_coll_, ecal_rec_hit_pass_, ecal_sim_hit_coll_, ecal_sim_hit_pass_, framework::Event::exists(), framework::HistogramPool::fill(), ldmx::EcalID::getModuleID(), framework::HINT_SHOULD_DROP, framework::HINT_SHOULD_KEEP, framework::EventProcessor::histograms_, ldmx::EcalID::layer(), num_layers_, and framework::EventProcessor::setStorageHint().

configure()

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

virtual

Input python configuration parameters.

Reimplemented from framework::EventProcessor.

Definition at line 10 of file EcalDigiVerifier.cxx.

                                                              {
  ecal_sim_hit_coll_ = ps.get<std::string>("ecal_sim_hit_coll");
  ecal_sim_hit_pass_ = ps.get<std::string>("ecal_sim_hit_pass");
  ecal_rec_hit_coll_ = ps.get<std::string>("ecal_rec_hit_coll");
  ecal_rec_hit_pass_ = ps.get<std::string>("ecal_rec_hit_pass");
  ecal_presel_coll_ = ps.get<std::string>("ecal_presel_coll");
  ecal_presel_pass_ = ps.get<std::string>("ecal_presel_pass");
  num_layers_ = ps.get<int>("num_layers");
 
  return;
}

References ecal_presel_coll_, ecal_presel_pass_, ecal_rec_hit_coll_, ecal_rec_hit_pass_, ecal_sim_hit_coll_, ecal_sim_hit_pass_, framework::config::Parameters::get(), and num_layers_.

Member Data Documentation

ecal_presel_coll_

std::string dqm::EcalDigiVerifier::ecal_presel_coll_

private

Collection Name for Preselection Decision.

Definition at line 49 of file EcalDigiVerifier.h.

Referenced by analyze(), and configure().

ecal_presel_pass_

std::string dqm::EcalDigiVerifier::ecal_presel_pass_

private

Pass Name for Preselection Decision.

Definition at line 52 of file EcalDigiVerifier.h.

Referenced by analyze(), and configure().

ecal_rec_hit_coll_

std::string dqm::EcalDigiVerifier::ecal_rec_hit_coll_

private

Collection Name for RecHits.

Definition at line 43 of file EcalDigiVerifier.h.

Referenced by analyze(), and configure().

ecal_rec_hit_pass_

std::string dqm::EcalDigiVerifier::ecal_rec_hit_pass_

private

Pass Name for RecHits.

Definition at line 46 of file EcalDigiVerifier.h.

Referenced by analyze(), and configure().

ecal_sim_hit_coll_

std::string dqm::EcalDigiVerifier::ecal_sim_hit_coll_

private

Collection Name for SimHits.

Definition at line 37 of file EcalDigiVerifier.h.

Referenced by analyze(), and configure().

ecal_sim_hit_pass_

std::string dqm::EcalDigiVerifier::ecal_sim_hit_pass_

private

Pass Name for SimHits.

Definition at line 40 of file EcalDigiVerifier.h.

Referenced by analyze(), and configure().

num_layers_

int dqm::EcalDigiVerifier::num_layers_

private

Number of layers in the ECAL.

Definition at line 55 of file EcalDigiVerifier.h.

Referenced by analyze(), and configure().

---

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

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