hcal::HcalWABVetoProcessor Class Reference

Public Member Functions
	HcalWABVetoProcessor (const std::string &name, framework::Process &process)
	Constructor.
virtual	~HcalWABVetoProcessor ()=default
	Destructor.
void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified parameters.
void	produce (framework::Event &event) override
	Run the processor and create a collection of results which indicate if the event passes/fails the Hcal veto.
Public Member Functions inherited from framework::Producer
	Producer (const std::string &name, Process &process)
	Class constructor.
virtual void	beforeNewRun (ldmx::RunHeader &header)
	Handle allowing producers to modify run headers before the run begins.
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
double	maxtotalEnergyCompare_ {1000.}
double	mintotalEnergyCompare_ {0.}
double	maxnClusters_ {0.}
double	maxMeanHitsPerCluster_ {0.}
double	maxMeanEnergyPerCluster_ {0.}
std::string	outputCollName_
std::string	inputHCALClusterCollName_
std::string	inputHCALHitCollName_
std::string	inputECALHitCollName_

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::Producer
static const int	CLASSTYPE {1}
	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 27 of file HcalWABVetoProcessor.h.

Constructor & Destructor Documentation

HcalWABVetoProcessor()

hcal::HcalWABVetoProcessor::HcalWABVetoProcessor	(	const std::string &	name,
		framework::Process &	process
	)

Constructor.

Definition at line 18 of file HcalWABVetoProcessor.cxx.

    : Producer(name, process) {}

Member Function Documentation

configure()

void hcal::HcalWABVetoProcessor::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 22 of file HcalWABVetoProcessor.cxx.

                                           {
  maxtotalEnergyCompare_ =
      parameters.getParameter<double>("max_total_energy_compare");
  mintotalEnergyCompare_ =
      parameters.getParameter<double>("min_total_energy_compare");
  maxnClusters_ = parameters.getParameter<double>("n_clusters");
  maxMeanHitsPerCluster_ =
      parameters.getParameter<double>("mean_hits_per_cluster");
  maxMeanEnergyPerCluster_ =
      parameters.getParameter<double>("mean_energy_per_cluster");
  outputCollName_ = parameters.getParameter<std::string>("outputCollName");
  inputHCALClusterCollName_ =
      parameters.getParameter<std::string>("inputHCALClusterCollName");
  inputHCALHitCollName_ =
      parameters.getParameter<std::string>("inputHCALHitCollName");
  inputECALHitCollName_ =
      parameters.getParameter<std::string>("inputECALHitCollName");
}

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

produce()

void hcal::HcalWABVetoProcessor::produce ( framework::Event &  event )

overridevirtual

Run the processor and create a collection of results which indicate if the event passes/fails the Hcal veto.

Parameters

event

The event to process.

Implements framework::Producer.

Definition at line 42 of file HcalWABVetoProcessor.cxx.

                                                        {
  // Get the collection of sim particles from the event
  // HCAL:
  const std::vector<ldmx::HcalHit> hcalRecHits =
      event.getCollection<ldmx::HcalHit>(inputHCALHitCollName_);
  // ECAL:
  const std::vector<ldmx::EcalHit> ecalRecHits =
      event.getCollection<ldmx::EcalHit>(inputECALHitCollName_);
  // Clusters:
  const std::vector<ldmx::HcalCluster> hcalClusters =
      event.getCollection<ldmx::HcalCluster>(inputHCALClusterCollName_);
 
  // Loop over all of the Hcal hits and calculate to total photoelectrons
  // in the event.
  float totalHCALEnergy{0};
  float totalECALEnergy{0};
  float maxPE{-1000};
  const ldmx::HcalHit *maxPEHit = nullptr;
  for (const ldmx::HcalHit &hcalHit : hcalRecHits) {
    if (hcalHit.isNoise() == 0) {
      totalHCALEnergy += hcalHit.getPE();
    }
 
    // Find the maximum PE in the list
    if (maxPE < hcalHit.getPE()) {
      maxPE = hcalHit.getPE();
      maxPEHit = const_cast<ldmx::HcalHit *>(&hcalHit);
    }
  }
 
  for (const ldmx::EcalHit &ecalHit : ecalRecHits) {
    if (ecalHit.isNoise() == 0) {
      totalECALEnergy += ecalHit.getEnergy();
    }
  }
  std::vector<double> nhits;
  std::vector<double> energies;
  unsigned int nClusters = 0;
  for (const ldmx::HcalCluster &hcalCluster : hcalClusters) {
    nClusters += 1;
    energies.push_back(hcalCluster.getEnergy());
    nhits.push_back(hcalCluster.getNHits());
  }
 
  double meanEnergy =
      std::accumulate(energies.begin(), energies.end(), 0.0) / energies.size();
  double meanNhits =
      std::accumulate(nhits.begin(), nhits.end(), 0.0) / nhits.size();
  bool passesEnergyCombo =
      (((totalECALEnergy + totalHCALEnergy) < maxtotalEnergyCompare_));
  bool passesnClusters = (nClusters < maxnClusters_);
  bool passesNHits = ((meanNhits < maxMeanHitsPerCluster_) or isnan(meanNhits));
  bool passesEnergy =
      ((meanEnergy < maxMeanEnergyPerCluster_) or isnan(meanEnergy));
 
  // total veto:
  bool passesVeto =
      (passesEnergyCombo and passesnClusters and passesNHits and passesEnergy);
  // set result:
  ldmx::HcalVetoResult result;
  result.setVetoResult(passesVeto);
  result.setMaxPEHit(*maxPEHit);
  if (passesVeto) {
    setStorageHint(framework::hint_shouldKeep);
 
  } else {
    setStorageHint(framework::hint_shouldDrop);
  }
 
  event.add(outputCollName_, result);
}

References ldmx::CalorimeterHit::getEnergy(), ldmx::HcalHit::getPE(), framework::hint_shouldDrop, framework::hint_shouldKeep, ldmx::HcalVetoResult::setMaxPEHit(), framework::EventProcessor::setStorageHint(), and ldmx::HcalVetoResult::setVetoResult().

Member Data Documentation

inputECALHitCollName_

std::string hcal::HcalWABVetoProcessor::inputECALHitCollName_

private

Definition at line 64 of file HcalWABVetoProcessor.h.

inputHCALClusterCollName_

std::string hcal::HcalWABVetoProcessor::inputHCALClusterCollName_

private

Definition at line 62 of file HcalWABVetoProcessor.h.

inputHCALHitCollName_

std::string hcal::HcalWABVetoProcessor::inputHCALHitCollName_

private

Definition at line 63 of file HcalWABVetoProcessor.h.

maxMeanEnergyPerCluster_

double hcal::HcalWABVetoProcessor::maxMeanEnergyPerCluster_ {0.}

private

Definition at line 60 of file HcalWABVetoProcessor.h.

{0.};

maxMeanHitsPerCluster_

double hcal::HcalWABVetoProcessor::maxMeanHitsPerCluster_ {0.}

private

Definition at line 58 of file HcalWABVetoProcessor.h.

{0.};

maxnClusters_

double hcal::HcalWABVetoProcessor::maxnClusters_ {0.}

private

Definition at line 56 of file HcalWABVetoProcessor.h.

{0.};

maxtotalEnergyCompare_

double hcal::HcalWABVetoProcessor::maxtotalEnergyCompare_ {1000.}

private

Definition at line 52 of file HcalWABVetoProcessor.h.

{1000.};

mintotalEnergyCompare_

double hcal::HcalWABVetoProcessor::mintotalEnergyCompare_ {0.}

private

Definition at line 54 of file HcalWABVetoProcessor.h.

{0.};

outputCollName_

std::string hcal::HcalWABVetoProcessor::outputCollName_

private

Definition at line 61 of file HcalWABVetoProcessor.h.

---

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

• Hcal/include/Hcal/HcalWABVetoProcessor.h
• Hcal/src/Hcal/HcalWABVetoProcessor.cxx