dqm::HCalDQM Class Reference

Public Member Functions
	HCalDQM (const std::string &name, framework::Process &process)
	Constructor.
	~HCalDQM ()
	Destructor.
void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified parameters.
void	analyze (const framework::Event &event) override
	Process the event and make histograms ro summaries.
bool	skipHit (const ldmx::HcalID &id)
void	analyzeRecHits (const std::vector< ldmx::HcalHit > &hits)
void	analyzeSimHits (const std::vector< ldmx::SimCalorimeterHit > &hits)
bool	hitPassesVeto (const ldmx::HcalHit &hit, int section)
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	sim_coll_name_
	Hcal Sim Hits collection name.
std::string	sim_pass_name_
	Hcal Sim Hits pass name.
std::string	rec_coll_name_
	Hcal Rec Hits collection name.
std::string	rec_pass_name_
	Hcal Rec Hits pass name.
std::string	veto_name_
	Hcal Veto name.
std::string	veto_pass_
	Hcal Veto pass name.
float	pe_veto_threshold_
int	section_
double	max_hit_time_

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

Definition at line 30 of file HCalDQM.h.

Constructor & Destructor Documentation

HCalDQM()

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

Constructor.

Definition at line 5 of file HCalDQM.cxx.

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

~HCalDQM()

dqm::HCalDQM::~HCalDQM ( )

inline

Destructor.

Definition at line 36 of file HCalDQM.h.

{}

Member Function Documentation

analyze()

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

overridevirtual

Process the event and make histograms ro summaries.

Parameters

event

The event to analyze.

Implements framework::Analyzer.

Definition at line 18 of file HCalDQM.cxx.

                                                 {
  // Get the collection of HCalDQM digitized hits if the exists
  const auto &hcal_hits{
      event.getCollection<ldmx::HcalHit>(rec_coll_name_, rec_pass_name_)};
 
  const auto &hcal_sim_hits{event.getCollection<ldmx::SimCalorimeterHit>(
      sim_coll_name_, sim_pass_name_)};
  analyzeSimHits(hcal_sim_hits);
  analyzeRecHits(hcal_hits);
}

References rec_coll_name_, rec_pass_name_, sim_coll_name_, and sim_pass_name_.

analyzeRecHits()

void dqm::HCalDQM::analyzeRecHits

(

const std::vector< ldmx::HcalHit > &

hits

)

Definition at line 82 of file HCalDQM.cxx.

                                                               {
  const auto &geometry = getCondition<ldmx::HcalGeometry>(
      ldmx::HcalGeometry::CONDITIONS_OBJECT_NAME);
 
  float total_pe{0};
  float max_pe{-1};
  float max_pe_time{-1};
  float max_pe_adc{-1};
  float max_pe_adc_time{-1};
  float total_e{0};
  int vetoable_hit_multiplicity{0};
  int hit_multiplicity{0};
 
  for (const ldmx::HcalHit &hit : hits) {
    ldmx::HcalID id(hit.getID());
    const auto orientation{geometry.getScintillatorOrientation(id)};
    const auto section{id.section()};
    const auto layer{id.layer()};
    const auto strip{id.strip()};
    if (skipHit(id)) {
      continue;
    }
 
    if (hit.isNoise()) {
      histograms_.fill("noise", 1);
    } else {
      histograms_.fill("noise", 0);
    }
    if (hitPassesVeto(hit, section)) {
      hit_multiplicity++;
    } else {
      hit_multiplicity++;
      vetoable_hit_multiplicity++;
    }
    const auto pe{hit.getPE()};
    const auto t{hit.getTime()};
    const auto e{hit.getEnergy()};
    const auto x{hit.getXPos()};
    const auto y{hit.getYPos()};
    const auto z{hit.getZPos()};
    switch (orientation) {
      case ldmx::HcalGeometry::ScintillatorOrientation::horizontal:
        histograms_.fill("along_x", x);
        break;
      case ldmx::HcalGeometry::ScintillatorOrientation::vertical:
        histograms_.fill("along_y", y);
        break;
      case ldmx::HcalGeometry::ScintillatorOrientation::depth:
        histograms_.fill("along_z", z);
        break;
    }
    total_e += e;
    total_pe += pe;
 
    if (pe > max_pe) {
      max_pe = pe;
      max_pe_time = t;
    }
 
    // Track max PE for ADC mode only
    if (hit.getIsADC()) {
      if (pe > max_pe_adc) {
        max_pe_adc = pe;
        max_pe_adc_time = t;
      }
    }
 
    histograms_.fill("layer:strip", layer, strip);
    histograms_.fill("pe", pe);
    histograms_.fill("hit_time", t);
    histograms_.fill("layer", layer);
    histograms_.fill("noise", hit.isNoise());
    histograms_.fill("energy", e);
    histograms_.fill("hit_z", z);
  }
  histograms_.fill("total_energy", total_e);
  histograms_.fill("total_pe", total_pe);
  histograms_.fill("max_pe", max_pe);
  histograms_.fill("max_pe_time", max_pe_time);
  histograms_.fill("max_pe_adc", max_pe_adc);
  histograms_.fill("max_pe_adc_time", max_pe_adc_time);
  histograms_.fill("hit_multiplicity", hit_multiplicity);
  histograms_.fill("vetoable_hit_multiplicity", vetoable_hit_multiplicity);
}

analyzeSimHits()

void dqm::HCalDQM::analyzeSimHits

(

const std::vector< ldmx::SimCalorimeterHit > &

hits

)

Definition at line 28 of file HCalDQM.cxx.

                                                                         {
  const auto &geometry = getCondition<ldmx::HcalGeometry>(
      ldmx::HcalGeometry::CONDITIONS_OBJECT_NAME);
 
  std::map<ldmx::HcalID, double> sim_energy_per_bar;
  int hit_multiplicity{0};
 
  for (const auto &hit : hits) {
    ldmx::HcalID id(hit.getID());
    if (skipHit(id)) {
      continue;
    }
    const auto energy{hit.getEdep()};
    if (sim_energy_per_bar.count(id) == 0) {
      sim_energy_per_bar[id] = energy;
    } else {
      sim_energy_per_bar[id] += energy;
    }
    const auto orientation{geometry.getScintillatorOrientation(id)};
    const auto layer{id.layer()};
    const auto strip{id.strip()};
    const auto pos{hit.getPosition()};
    const auto x{pos[0]};
    const auto y{pos[1]};
    const auto z{pos[2]};
    const auto t{hit.getTime()};
    hit_multiplicity++;
    histograms_.fill("sim_hit_time", t);
    histograms_.fill("sim_layer", layer);
    histograms_.fill("sim_layer:strip", layer, strip);
    histograms_.fill("sim_energy", energy);
    switch (orientation) {
      case ldmx::HcalGeometry::ScintillatorOrientation::horizontal:
        histograms_.fill("sim_along_x", x);
        break;
      case ldmx::HcalGeometry::ScintillatorOrientation::vertical:
        histograms_.fill("sim_along_y", y);
        break;
      case ldmx::HcalGeometry::ScintillatorOrientation::depth:
        histograms_.fill("sim_along_z", z);
        break;
    }
  }
 
  histograms_.fill("sim_hit_multiplicity", hit_multiplicity);
  histograms_.fill("sim_num_bars_hit", sim_energy_per_bar.size());
 
  double total_energy{0};
  for (const auto [id, energy] : sim_energy_per_bar) {
    histograms_.fill("sim_energy_per_bar", energy);
    total_energy += energy;
  }
  histograms_.fill("sim_total_energy", total_energy);
}

configure()

void dqm::HCalDQM::configure ( framework::config::Parameters & parameters )

overridevirtual

Configure the processor using the given user specified parameters.

Parameters

parameters

Set of parameters used to configure this processor.

Reimplemented from framework::EventProcessor.

Definition at line 8 of file HCalDQM.cxx.

                                                     {
  rec_coll_name_ = ps.get<std::string>("rec_coll_name");
  rec_pass_name_ = ps.get<std::string>("rec_pass_name");
  sim_coll_name_ = ps.get<std::string>("sim_coll_name");
  sim_pass_name_ = ps.get<std::string>("sim_pass_name");
  pe_veto_threshold_ = ps.get<double>("pe_veto_threshold");
  section_ = ps.get<int>("section");
  max_hit_time_ = ps.get<double>("max_hit_time");
}

References framework::config::Parameters::get(), rec_coll_name_, rec_pass_name_, sim_coll_name_, and sim_pass_name_.

hitPassesVeto()

bool dqm::HCalDQM::hitPassesVeto ( const ldmx::HcalHit & hit, int section )

inline

Definition at line 59 of file HCalDQM.h.

                                                          {
    if (hit.getPE() < pe_veto_threshold_ || hit.getTime() > max_hit_time_) {
      return true;
    }
    if (section == ldmx::HcalID::HcalSection::BACK && hit.getMinPE() < 1) {
      return true;
    }
    return false;
  }

skipHit()

bool dqm::HCalDQM::skipHit ( const ldmx::HcalID & id )

inline

Definition at line 52 of file HCalDQM.h.

                                     {
    const auto section{id.section()};
    return (section != section_ && section_ != -1);
  }

Member Data Documentation

max_hit_time_

double dqm::HCalDQM::max_hit_time_

private

Definition at line 90 of file HCalDQM.h.

pe_veto_threshold_

float dqm::HCalDQM::pe_veto_threshold_

private

Definition at line 88 of file HCalDQM.h.

rec_coll_name_

std::string dqm::HCalDQM::rec_coll_name_

private

Hcal Rec Hits collection name.

Definition at line 76 of file HCalDQM.h.

Referenced by analyze(), and configure().

rec_pass_name_

std::string dqm::HCalDQM::rec_pass_name_

private

Hcal Rec Hits pass name.

Definition at line 79 of file HCalDQM.h.

Referenced by analyze(), and configure().

section_

int dqm::HCalDQM::section_

private

Definition at line 89 of file HCalDQM.h.

sim_coll_name_

std::string dqm::HCalDQM::sim_coll_name_

private

Hcal Sim Hits collection name.

Definition at line 71 of file HCalDQM.h.

Referenced by analyze(), and configure().

sim_pass_name_

std::string dqm::HCalDQM::sim_pass_name_

private

Hcal Sim Hits pass name.

Definition at line 74 of file HCalDQM.h.

Referenced by analyze(), and configure().

veto_name_

std::string dqm::HCalDQM::veto_name_

private

Hcal Veto name.

Definition at line 82 of file HCalDQM.h.

veto_pass_

std::string dqm::HCalDQM::veto_pass_

private

Hcal Veto pass name.

Definition at line 85 of file HCalDQM.h.

---

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

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