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	process (Event &event) final
	Processing an event for a Producer is calling produce.
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	beforeNewRun (ldmx::RunHeader &run_header)
	Callback for Producers to add parameters to the run header before conditions are initialized.
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
double	maxtotal_energy_compare_ {1000.}
double	mintotal_energy_compare_ {0.}
double	maxn_clusters_ {0.}
double	max_mean_hits_per_cluster_ {0.}
double	max_mean_energy_per_cluster_ {0.}
std::string	output_coll_name_
std::string	input_hcal_cluster_coll_name_
std::string	input_hcal_hit_coll_name_
std::string	input_ecal_hit_coll_name_
std::string	hcal_hit_passname_
std::string	ecal_hit_passname_
std::string	hcal_cluster_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

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.

                                           {
  maxtotal_energy_compare_ = parameters.get<double>("max_total_energy_compare");
  mintotal_energy_compare_ = parameters.get<double>("min_total_energy_compare");
  maxn_clusters_ = parameters.get<double>("n_clusters");
  max_mean_hits_per_cluster_ = parameters.get<double>("mean_hits_per_cluster");
  max_mean_energy_per_cluster_ =
      parameters.get<double>("mean_energy_per_cluster");
  output_coll_name_ = parameters.get<std::string>("outputCollName");
  input_hcal_cluster_coll_name_ =
      parameters.get<std::string>("inputHCALClusterCollName");
  input_hcal_hit_coll_name_ =
      parameters.get<std::string>("inputHCALHitCollName");
  input_ecal_hit_coll_name_ =
      parameters.get<std::string>("inputECALHitCollName");
  hcal_hit_passname_ = parameters.get<std::string>("hcal_hit_passname");
  ecal_hit_passname_ = parameters.get<std::string>("ecal_hit_passname");
  hcal_cluster_passname_ = parameters.get<std::string>("hcal_cluster_passname");
}

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

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> hcal_rec_hits =
      event.getCollection<ldmx::HcalHit>(input_hcal_hit_coll_name_,
                                         hcal_hit_passname_);
  // ECAL:
  const std::vector<ldmx::EcalHit> ecal_rec_hits =
      event.getCollection<ldmx::EcalHit>(input_ecal_hit_coll_name_,
                                         ecal_hit_passname_);
 
  // Clusters:
  const std::vector<ldmx::HcalCluster> hcal_clusters =
      event.getCollection<ldmx::HcalCluster>(input_hcal_cluster_coll_name_,
                                             hcal_cluster_passname_);
 
  // Loop over all of the Hcal hits_ and calculate to total photoelectrons
  // in the event.
  float total_hcal_energy{0};
  float total_ecal_energy{0};
  float max_pe{-1000};
  const ldmx::HcalHit *max_pe_hit = nullptr;
  for (const ldmx::HcalHit &hcal_hit : hcal_rec_hits) {
    if (hcal_hit.isNoise() == 0) {
      total_hcal_energy += hcal_hit.getPE();
    }
 
    // Find the maximum PE in the list
    if (max_pe < hcal_hit.getPE()) {
      max_pe = hcal_hit.getPE();
      max_pe_hit = const_cast<ldmx::HcalHit *>(&hcal_hit);
    }
  }
 
  for (const ldmx::EcalHit &ecal_hit : ecal_rec_hits) {
    if (ecal_hit.isNoise() == 0) {
      total_ecal_energy += ecal_hit.getEnergy();
    }
  }
  std::vector<double> nhits;
  std::vector<double> energies;
  unsigned int n_clusters = 0;
  for (const ldmx::HcalCluster &hcal_cluster : hcal_clusters) {
    n_clusters += 1;
    energies.push_back(hcal_cluster.getEnergy());
    nhits.push_back(hcal_cluster.getNHits());
  }
 
  double mean_energy =
      std::accumulate(energies.begin(), energies.end(), 0.0) / energies.size();
  double mean_nhits =
      std::accumulate(nhits.begin(), nhits.end(), 0.0) / nhits.size();
  bool passes_energy_combo =
      (((total_ecal_energy + total_hcal_energy) < maxtotal_energy_compare_));
  bool passesn_clusters = (n_clusters < maxn_clusters_);
  bool passes_n_hits =
      ((mean_nhits < max_mean_hits_per_cluster_) or isnan(mean_nhits));
  bool passes_energy =
      ((mean_energy < max_mean_energy_per_cluster_) or isnan(mean_energy));
 
  // total veto:
  bool passes_veto = (passes_energy_combo and passesn_clusters and
                      passes_n_hits and passes_energy);
  // set result:
  ldmx::HcalVetoResult result;
  result.setVetoResult(passes_veto);
  result.setMaxPEHit(*max_pe_hit);
  if (passes_veto) {
    setStorageHint(framework::HINT_SHOULD_KEEP);
 
  } else {
    setStorageHint(framework::HINT_SHOULD_DROP);
  }
 
  event.add(output_coll_name_, result);
}

References framework::HINT_SHOULD_DROP, framework::HINT_SHOULD_KEEP, ldmx::HcalVetoResult::setMaxPEHit(), framework::EventProcessor::setStorageHint(), and ldmx::HcalVetoResult::setVetoResult().

Member Data Documentation

ecal_hit_passname_

std::string hcal::HcalWABVetoProcessor::ecal_hit_passname_

private

Definition at line 66 of file HcalWABVetoProcessor.h.

hcal_cluster_passname_

std::string hcal::HcalWABVetoProcessor::hcal_cluster_passname_

private

Definition at line 67 of file HcalWABVetoProcessor.h.

hcal_hit_passname_

std::string hcal::HcalWABVetoProcessor::hcal_hit_passname_

private

Definition at line 65 of file HcalWABVetoProcessor.h.

input_ecal_hit_coll_name_

std::string hcal::HcalWABVetoProcessor::input_ecal_hit_coll_name_

private

Definition at line 64 of file HcalWABVetoProcessor.h.

input_hcal_cluster_coll_name_

std::string hcal::HcalWABVetoProcessor::input_hcal_cluster_coll_name_

private

Definition at line 62 of file HcalWABVetoProcessor.h.

input_hcal_hit_coll_name_

std::string hcal::HcalWABVetoProcessor::input_hcal_hit_coll_name_

private

Definition at line 63 of file HcalWABVetoProcessor.h.

max_mean_energy_per_cluster_

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

private

Definition at line 60 of file HcalWABVetoProcessor.h.

{0.};

max_mean_hits_per_cluster_

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

private

Definition at line 58 of file HcalWABVetoProcessor.h.

{0.};

maxn_clusters_

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

private

Definition at line 56 of file HcalWABVetoProcessor.h.

{0.};

maxtotal_energy_compare_

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

private

Definition at line 52 of file HcalWABVetoProcessor.h.

{1000.};

mintotal_energy_compare_

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

private

Definition at line 54 of file HcalWABVetoProcessor.h.

{0.};

output_coll_name_

std::string hcal::HcalWABVetoProcessor::output_coll_name_

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