recon::PileupFinder Class Reference

Public Member Functions
	PileupFinder (const std::string &name, framework::Process &process)
virtual void	configure (framework::config::Parameters &ps)
	Callback for the EventProcessor to configure itself from the given set of parameters.
virtual void	produce (framework::Event &event)
	Process the event and put new data products into it.
virtual void	onProcessEnd ()
	Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.
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.
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	rec_hit_coll_name_
std::string	rec_hit_pass_name_
std::string	pf_cand_coll_name_
std::string	pf_cand_pass_name_
std::string	cluster_coll_name_
std::string	cluster_pass_name_
std::string	output_rec_hit_coll_name_
double	min_mom_ {0.}

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 28 of file PileupFinder.h.

Constructor & Destructor Documentation

PileupFinder()

recon::PileupFinder::PileupFinder ( const std::string & name, framework::Process & process )

inline

Definition at line 30 of file PileupFinder.h.

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

Member Function Documentation

configure()

void recon::PileupFinder::configure ( framework::config::Parameters & parameters )

virtual

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 7 of file PileupFinder.cxx.

                                                          {
  // I/O
  rec_hit_coll_name_ = ps.getParameter<std::string>("rec_hit_coll_name");
  rec_hit_pass_name_ = ps.getParameter<std::string>("rec_hit_pass_name");
  pf_cand_coll_name_ = ps.getParameter<std::string>("pf_cand_coll_name");
  pf_cand_pass_name_ = ps.getParameter<std::string>("pf_cand_pass_name");
  cluster_coll_name_ = ps.getParameter<std::string>("cluster_coll_name");
  cluster_pass_name_ = ps.getParameter<std::string>("cluster_pass_name");
  output_rec_hit_coll_name_ =
      ps.getParameter<std::string>("output_rec_hit_coll_name");
  // Algorithm configuration
  min_mom_ = ps.getParameter<double>("min_momentum");
}

onProcessEnd()

void recon::PileupFinder::onProcessEnd ( )

virtual

Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.

Reimplemented from framework::EventProcessor.

Definition at line 96 of file PileupFinder.cxx.

                                {
  ldmx_log(debug) << "Process ends!";
 
  return;
}

produce()

void recon::PileupFinder::produce ( framework::Event & event )

virtual

Process the event and put new data products into it.

Parameters

event

The Event to process.

Implements framework::Producer.

Definition at line 22 of file PileupFinder.cxx.

                                                {
  if (!event.exists(rec_hit_coll_name_, rec_hit_pass_name_)) {  // ecal rechits
    ldmx_log(error) << "Unable to find (one) collection named "
                    << rec_hit_coll_name_ << "_" << rec_hit_pass_name_;
    return;
  }
  if (!event.exists(pf_cand_coll_name_, pf_cand_pass_name_)) {
    ldmx_log(error) << "Unable to find (one) collection named "
                    << pf_cand_coll_name_ << "_" << pf_cand_pass_name_;
    return;
  }
  if (!event.exists(cluster_coll_name_, cluster_pass_name_)) {
    ldmx_log(error) << "Unable to find (one) collection named "
                    << cluster_coll_name_ << "_" << cluster_pass_name_;
    return;
  }
 
  const auto& ecal_hits{event.getCollection<ldmx::EcalHit>(rec_hit_coll_name_,
                                                           rec_hit_pass_name_)};
 
  const auto& pf_cands{event.getCollection<ldmx::PFCandidate>(
      pf_cand_coll_name_, pf_cand_pass_name_)};
 
  const auto& clusters{event.getCollection<ldmx::CaloCluster>(
      cluster_coll_name_, cluster_pass_name_)};
  // get PID 3 and 7 -- the ones with track and ecal matching
  // get the high-momentum track ones from there -- pileup candidate!
  // get the list of hits associated with pileup candidates
  // if a rechit is not on that list, add to output collection.
  std::vector<ldmx::EcalHit> output_hits;
  std::vector<unsigned int> pileup_hit_i_ds;
 
  // this needs to be a two-step procedure: loop over all clusters deemed to be
  // pileup to find all their associated hits
  //  then loop over that list to make a collection of output hits that doesn't
  //  contain them
  for (const auto& pf_cand : pf_cands) {
    if (pf_cand.getPID() == 3 || pf_cand.getPID() == 7) {
      // we have both ecal cluster and track
      std::vector<float> mom_vec = pf_cand.getTrackPxPyPz();
      float mom = mom_vec[0] * mom_vec[0] + mom_vec[1] * mom_vec[1] +
                  mom_vec[2] * mom_vec[2];
      mom = sqrt(mom);
 
      if (mom < min_mom_) continue;
      ldmx_log(trace) << "Got pileup candidate with PID = " << pf_cand.getPID()
                      << " and momentum = " << mom << " MeV.";
 
      // now! use the hit-candidate association to get the associated ecal hits.
      int pf_cl_idx = pf_cand.getEcalIndex();
      ldmx_log(trace) << "Got Ecal cluster with index " << pf_cl_idx
                      << " while cluster array length is " << clusters.size();
      if (pf_cl_idx < 0)  // was never set
        continue;
      auto cl = clusters[pf_cl_idx];
      auto hit_i_ds = cl.getHitIDs();
      // add to collection of pileup hits
      pileup_hit_i_ds.insert(pileup_hit_i_ds.end(), hit_i_ds.begin(),
                             hit_i_ds.end());
    }  // if trk/ecal matched
  }  // over PF objects
 
  for (auto hit : ecal_hits) {
    auto found_index = std::find(std::begin(pileup_hit_i_ds),
                                 std::end(pileup_hit_i_ds), hit.getID());
    // When the element is not found, std::find returns the end of the range
    if (found_index ==
        std::end(pileup_hit_i_ds)) {  // hit not part of any pileup cluster
      output_hits.emplace_back(hit);  // keep it
      ldmx_log(trace) << "Got no-pileup hit! ";
    }
  }
  event.add(output_rec_hit_coll_name_, output_hits);
}

References framework::Event::exists().

Member Data Documentation

cluster_coll_name_

std::string recon::PileupFinder::cluster_coll_name_

private

Definition at line 45 of file PileupFinder.h.

cluster_pass_name_

std::string recon::PileupFinder::cluster_pass_name_

private

Definition at line 46 of file PileupFinder.h.

min_mom_

double recon::PileupFinder::min_mom_ {0.}

private

Definition at line 51 of file PileupFinder.h.

{0.};  // MeV

output_rec_hit_coll_name_

std::string recon::PileupFinder::output_rec_hit_coll_name_

private

Definition at line 48 of file PileupFinder.h.

pf_cand_coll_name_

std::string recon::PileupFinder::pf_cand_coll_name_

private

Definition at line 43 of file PileupFinder.h.

pf_cand_pass_name_

std::string recon::PileupFinder::pf_cand_pass_name_

private

Definition at line 44 of file PileupFinder.h.

rec_hit_coll_name_

std::string recon::PileupFinder::rec_hit_coll_name_

private

Definition at line 41 of file PileupFinder.h.

rec_hit_pass_name_

std::string recon::PileupFinder::rec_hit_pass_name_

private

Definition at line 42 of file PileupFinder.h.

---

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

• Recon/include/Recon/PileupFinder.h
• Recon/src/Recon/PileupFinder.cxx