dqm::HcalInefficiencyAnalyzer Class Reference

Public Types
enum	vetoCategories {   back = 0 , top = 1 , bottom = 2 , right = 3 ,   left = 4 , any = 5 , both = 6 , back_only = 7 ,   side_only = 8 , neither = 9 }

Public Member Functions
	HcalInefficiencyAnalyzer (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.
bool	hitPassesVeto (const ldmx::HcalHit &hit, int section)
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.
Public Member Functions inherited from framework::EventProcessor
	EventProcessor (const std::string &name, Process &process)
	Class constructor.
virtual	~EventProcessor ()
	Class destructor.
virtual void	onNewRun (const ldmx::RunHeader &runHeader)
	Callback for the EventProcessor to take any necessary action when the run being processed changes.
virtual void	onFileOpen (EventFile &eventFile)
	Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
virtual void	onFileClose (EventFile &eventFile)
	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	hcalSimHitsCollection_ {"HcalSimHits"}
std::string	hcalRecHitsCollection_ {"HcalRecHits"}
std::string	hcalSimHitsPassName_ {""}
std::string	hcalRecHitsPassName_ {""}
float	pe_veto_threshold
double	max_hit_time_

Additional Inherited Members
Static Public Member Functions inherited from framework::EventProcessor
static void	declare (const std::string &classname, int classtype, EventProcessorMaker *)
	Internal function which is part of the PluginFactory machinery.
Static Public Attributes inherited from framework::Analyzer
static const int	CLASSTYPE {2}
	Constant used to track EventProcessor types by the PluginFactory.
Protected Member Functions inherited from framework::EventProcessor
void	abortEvent ()
	Abort the event immediately.
Protected Attributes inherited from framework::EventProcessor
HistogramHelper	histograms_
	Interface class for making and filling histograms.
NtupleManager &	ntuple_ {NtupleManager::getInstance()}
	Manager for any ntuples.
logging::logger	theLog_
	The logger for this EventProcessor.

Detailed Description

Definition at line 15 of file HcalInefficiencyDQM.h.

Member Enumeration Documentation

vetoCategories

enum dqm::HcalInefficiencyAnalyzer::vetoCategories

Definition at line 20 of file HcalInefficiencyDQM.h.

                      {
    back = 0,
    top = 1,
    bottom = 2,
    right = 3,
    left = 4,
    any = 5,
    both = 6,
    back_only = 7,
    side_only = 8,
    neither = 9
  };

Constructor & Destructor Documentation

HcalInefficiencyAnalyzer()

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

inline

Definition at line 17 of file HcalInefficiencyDQM.h.

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

Member Function Documentation

analyze()

void dqm::HcalInefficiencyAnalyzer::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 5 of file HcalInefficiencyDQM.cxx.

                                                                  {
  const auto hcalSimHits = event.getCollection<ldmx::SimCalorimeterHit>(
      hcalSimHitsCollection_, hcalSimHitsPassName_);
  const auto hcalRecHits = event.getCollection<ldmx::HcalHit>(
      hcalRecHitsCollection_, hcalRecHitsPassName_);
 
  const int failedVeto{999};
  // Check veto for each section, combined side hcal veto
  std::vector<int> firstLayersHit{failedVeto, failedVeto, failedVeto,
                                  failedVeto, failedVeto};
 
  const std::vector<std::string> sectionNames{"back", "top", "bottom", "right",
                                              "left"};
  for (const auto &hit : hcalRecHits) {
    const ldmx::HcalID id{static_cast<ldmx::DetectorID::RawValue>(hit.getID())};
    const auto section{id.section()};
    const auto layer{id.layer()};
    if (hitPassesVeto(hit, section)) {
      if (layer < firstLayersHit[section]) {
        firstLayersHit[section] = layer;
      }
    }
  }
 
  bool vetoedByBack{firstLayersHit[ldmx::HcalID::HcalSection::BACK] !=
                    failedVeto};
  bool vetoedByTop{firstLayersHit[ldmx::HcalID::HcalSection::TOP] !=
                   failedVeto};
  bool vetoedByBottom{firstLayersHit[ldmx::HcalID::HcalSection::BOTTOM] !=
                      failedVeto};
  bool vetoedByRight{firstLayersHit[ldmx::HcalID::HcalSection::RIGHT] !=
                     failedVeto};
  bool vetoedByLeft{firstLayersHit[ldmx::HcalID::HcalSection::LEFT] !=
                    failedVeto};
  bool vetoedBySide{vetoedByTop || vetoedByBottom || vetoedByRight ||
                    vetoedByLeft};
 
  for (int section{0}; section < firstLayersHit.size(); ++section) {
    const auto layer{firstLayersHit[section]};
    const auto sectionName{sectionNames[section]};
    if (layer != failedVeto) {
      histograms_.fill("inefficiency_" + sectionName, layer);
      histograms_.fill("efficiency", section);
    }
  }
  if (vetoedByBack || vetoedBySide) {
    histograms_.fill("efficiency", vetoCategories::any);
    if (vetoedByBack && vetoedBySide) {
      histograms_.fill("efficiency", vetoCategories::both);
    } else if (vetoedByBack && !vetoedBySide) {
      histograms_.fill("efficiency", vetoCategories::back_only);
    } else if (vetoedBySide && !vetoedByBack) {
      histograms_.fill("efficiency", vetoCategories::side_only);
    }
  } else {
    histograms_.fill("efficiency", vetoCategories::neither);
  }
}

References framework::HistogramHelper::fill(), and framework::EventProcessor::histograms_.

configure()

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

For an example, look at MyProcessor.

Parameters

parameters

Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 64 of file HcalInefficiencyDQM.cxx.

                                           {
  hcalSimHitsCollection_ =
      parameters.getParameter<std::string>("sim_coll_name");
  hcalRecHitsCollection_ =
      parameters.getParameter<std::string>("rec_coll_name");
  hcalSimHitsPassName_ = parameters.getParameter<std::string>("sim_pass_name");
  hcalRecHitsPassName_ = parameters.getParameter<std::string>("rec_pass_name");
  pe_veto_threshold = parameters.getParameter<double>("pe_veto_threshold");
  max_hit_time_ = parameters.getParameter<double>("max_hit_time");
}

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

hitPassesVeto()

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

inline

Definition at line 34 of file HcalInefficiencyDQM.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;
  }

Member Data Documentation

hcalRecHitsCollection_

std::string dqm::HcalInefficiencyAnalyzer::hcalRecHitsCollection_ {"HcalRecHits"}

private

Definition at line 48 of file HcalInefficiencyDQM.h.

{"HcalRecHits"};

hcalRecHitsPassName_

std::string dqm::HcalInefficiencyAnalyzer::hcalRecHitsPassName_ {""}

private

Definition at line 50 of file HcalInefficiencyDQM.h.

{""};

hcalSimHitsCollection_

std::string dqm::HcalInefficiencyAnalyzer::hcalSimHitsCollection_ {"HcalSimHits"}

private

Definition at line 47 of file HcalInefficiencyDQM.h.

{"HcalSimHits"};

hcalSimHitsPassName_

std::string dqm::HcalInefficiencyAnalyzer::hcalSimHitsPassName_ {""}

private

Definition at line 49 of file HcalInefficiencyDQM.h.

{""};

max_hit_time_

double dqm::HcalInefficiencyAnalyzer::max_hit_time_

private

Definition at line 54 of file HcalInefficiencyDQM.h.

pe_veto_threshold

float dqm::HcalInefficiencyAnalyzer::pe_veto_threshold

private

Definition at line 53 of file HcalInefficiencyDQM.h.

---

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

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