recon::PFTrackProducer Class Reference

Selects the tracks passed to ParticleFlow. More...

#include <PFTrackProducer.h>

Public Member Functions
	PFTrackProducer (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.
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 Member Functions
void	produceTruth (framework::Event &event)
void	produceReco (framework::Event &event)

Private Attributes
bool	truth_tracking_ {false}
std::string	input_track_coll_name_
std::string	input_pass_name_
std::string	output_track_coll_name_
bool	do_electron_tracking_ {}
double	min_electron_momentum_z_ {}
int	max_electron_track_id_ {}
std::string	reco_track_coll_name_
std::string	reco_track_pass_name_
int	min_n_hits_ {}
double	max_chi2_ndf_ {}
double	min_momentum_ {}
double	max_shared_frac_ {}

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

Selects the tracks passed to ParticleFlow.

Outputs ldmx::Track in both modes. In truth mode, Ecal scoring plane hits are wrapped into tracks with a single AtECAL state. In reco mode, tracks are selected from a reconstructed collection and must have an AtECAL state.

Definition at line 25 of file PFTrackProducer.h.

Constructor & Destructor Documentation

PFTrackProducer()

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

inline

Definition at line 27 of file PFTrackProducer.h.

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

Member Function Documentation

configure()

void recon::PFTrackProducer::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 class_name equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters

parameters

Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 12 of file PFTrackProducer.cxx.

                                                             {
  truth_tracking_ = ps.get<bool>("truth_tracking");
  input_track_coll_name_ = ps.get<std::string>("input_track_coll_name");
  input_pass_name_ = ps.get<std::string>("input_pass_name");
  output_track_coll_name_ = ps.get<std::string>("output_track_coll_name");
  do_electron_tracking_ = ps.get<bool>("do_electron_tracking");
  min_electron_momentum_z_ = ps.get<double>("min_electron_momentum_z");
  max_electron_track_id_ = ps.get<int>("max_electron_track_id");
  reco_track_coll_name_ = ps.get<std::string>("reco_track_coll_name");
  reco_track_pass_name_ = ps.get<std::string>("reco_track_pass_name");
  min_n_hits_ = ps.get<int>("min_n_hits");
  max_chi2_ndf_ = ps.get<double>("max_chi2_ndf");
  min_momentum_ = ps.get<double>("min_momentum");
  max_shared_frac_ = ps.get<double>("max_shared_frac");
}

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

produce()

void recon::PFTrackProducer::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 74 of file PFTrackProducer.cxx.

                                                   {
  if (truth_tracking_)
    produceTruth(event);
  else
    produceReco(event);
}

produceReco()

void recon::PFTrackProducer::produceReco ( framework::Event & event )

private

Definition at line 130 of file PFTrackProducer.cxx.

                                                       {
  if (!event.exists(reco_track_coll_name_, reco_track_pass_name_)) {
    ldmx_log(fatal) << "Couldn't find input collection "
                    << reco_track_coll_name_ << "_" << reco_track_pass_name_;
    return;
  }
  const auto tracks = event.getCollection<ldmx::Track>(reco_track_coll_name_,
                                                       reco_track_pass_name_);
 
  // best tracks first: more hits, then lower chi2/ndf
  std::vector<const ldmx::Track*> ranked;
  for (const auto& tk : tracks) ranked.push_back(&tk);
  auto chi2ndf = [](const ldmx::Track* t) {
    return t->getNdf() > 0 ? t->getChi2() / t->getNdf() : 9e9;
  };
  std::stable_sort(ranked.begin(), ranked.end(), [&](auto a, auto b) {
    if (a->getNhits() != b->getNhits()) return a->getNhits() > b->getNhits();
    return chi2ndf(a) < chi2ndf(b);
  });
 
  std::vector<ldmx::Track> pf_tracks;
  std::vector<std::set<unsigned int>> used_hits;
  for (const auto* tk_ptr : ranked) {
    const auto& tk = *tk_ptr;
    // need the Ecal face state for linking
    auto mom = tk.getMomentum(ldmx::AtECAL);
    if (mom.empty()) {
      ldmx_log(debug) << "Dropping track without AtECAL state";
      continue;
    }
    if (mom[2] <= 0) continue;
    if (tk.getNhits() < min_n_hits_) continue;
    if (max_chi2_ndf_ >= 0 &&
        (tk.getNdf() <= 0 || tk.getChi2() / tk.getNdf() > max_chi2_ndf_))
      continue;
    if (getP(mom) < min_momentum_) continue;
    // drop duplicates sharing most hits with a better track
    auto idxs = tk.getMeasurementsIdxs();
    std::set<unsigned int> hits(idxs.begin(), idxs.end());
    bool duplicate = false;
    for (const auto& prev : used_hits) {
      int n_shared = 0;
      for (auto h : hits) n_shared += prev.count(h);
      if (!hits.empty() && n_shared > max_shared_frac_ * hits.size()) {
        duplicate = true;
        break;
      }
    }
    if (duplicate) continue;
    used_hits.push_back(hits);
    pf_tracks.push_back(tk);
    ldmx_log(debug) << "Adding track: nhits=" << tk.getNhits()
                    << ", p = " << getP(mom) << ", trackID=" << tk.getTrackID();
  }
  std::sort(pf_tracks.begin(), pf_tracks.end(),
            [](const ldmx::Track& a, const ldmx::Track& b) {
              return getP(a) > getP(b);
            });
  event.add(output_track_coll_name_, pf_tracks);
}

produceTruth()

void recon::PFTrackProducer::produceTruth ( framework::Event & event )

private

Definition at line 81 of file PFTrackProducer.cxx.

                                                        {
  if (!event.exists(input_track_coll_name_, input_pass_name_)) {
    ldmx_log(fatal) << "Couldn't find input collection "
                    << input_track_coll_name_ << "_" << input_pass_name_;
    return;
  }
  const auto ecal_sp_hits = event.getCollection<ldmx::SimTrackerHit>(
      input_track_coll_name_, input_pass_name_);
 
  std::vector<ldmx::Track> pf_tracks;
  for (const auto& sp_hit : ecal_sp_hits) {
    if (sp_hit.getPdgID() == 22 || sp_hit.getPdgID() == 2112) continue;
    if (fabs(240 - sp_hit.getPosition()[2]) > 0.1) continue;
    if (do_electron_tracking_) {  // only select electron SP hits_
      if (sp_hit.getPdgID() != 11) continue;
      if (sp_hit.getTrackID() < 2 &&
          sp_hit.getMomentum()[2] > min_electron_momentum_z_) {
        // this is almost guaranteed to be a pileup beam electron! keep it
        pf_tracks.push_back(trackFromSPHit(sp_hit));
        ldmx_log(debug) << "Added beam electron SP hit: trackID="
                        << sp_hit.getTrackID()
                        << ", pz = " << sp_hit.getMomentum()[2];
      } else if (sp_hit.getTrackID() <= max_electron_track_id_ &&
                 sp_hit.getMomentum()[2] > 5) {
        // require more than minimum forward momentum to catch recoil electron
        // candidates
        pf_tracks.push_back(trackFromSPHit(sp_hit));
        ldmx_log(debug) << "Adding SP hit: trackID=" << sp_hit.getTrackID()
                        << ", pdgID= " << sp_hit.getPdgID()
                        << ", pz = " << sp_hit.getMomentum()[2];
        continue;
      }
    }  // if electron tracking
    else {
      if (sp_hit.getTrackID() != 1 || sp_hit.getMomentum()[2] < 0) continue;
      pf_tracks.push_back(trackFromSPHit(sp_hit));
      ldmx_log(debug) << "Adding SP hit: trackID=" << sp_hit.getTrackID()
                      << ", pdgID= " << sp_hit.getPdgID()
                      << ", pz = " << sp_hit.getMomentum()[2];
      break;
    }
  }  // over SP hits_
  std::sort(pf_tracks.begin(), pf_tracks.end(),
            [](const ldmx::Track& a, const ldmx::Track& b) {
              return getP(a) > getP(b);
            });
  event.add(output_track_coll_name_, pf_tracks);
}

Member Data Documentation

do_electron_tracking_

bool recon::PFTrackProducer::do_electron_tracking_ {}

private

Definition at line 51 of file PFTrackProducer.h.

{};

input_pass_name_

std::string recon::PFTrackProducer::input_pass_name_

private

Definition at line 44 of file PFTrackProducer.h.

input_track_coll_name_

std::string recon::PFTrackProducer::input_track_coll_name_

private

Definition at line 42 of file PFTrackProducer.h.

max_chi2_ndf_

double recon::PFTrackProducer::max_chi2_ndf_ {}

private

Definition at line 64 of file PFTrackProducer.h.

{};

max_electron_track_id_

int recon::PFTrackProducer::max_electron_track_id_ {}

private

Definition at line 55 of file PFTrackProducer.h.

{};

max_shared_frac_

double recon::PFTrackProducer::max_shared_frac_ {}

private

Definition at line 68 of file PFTrackProducer.h.

{};

min_electron_momentum_z_

double recon::PFTrackProducer::min_electron_momentum_z_ {}

private

Definition at line 53 of file PFTrackProducer.h.

{};

min_momentum_

double recon::PFTrackProducer::min_momentum_ {}

private

Definition at line 66 of file PFTrackProducer.h.

{};

min_n_hits_

int recon::PFTrackProducer::min_n_hits_ {}

private

Definition at line 62 of file PFTrackProducer.h.

{};

output_track_coll_name_

std::string recon::PFTrackProducer::output_track_coll_name_

private

Definition at line 46 of file PFTrackProducer.h.

reco_track_coll_name_

std::string recon::PFTrackProducer::reco_track_coll_name_

private

Definition at line 59 of file PFTrackProducer.h.

reco_track_pass_name_

std::string recon::PFTrackProducer::reco_track_pass_name_

private

Definition at line 60 of file PFTrackProducer.h.

truth_tracking_

bool recon::PFTrackProducer::truth_tracking_ {false}

private

Definition at line 39 of file PFTrackProducer.h.

{false};

---

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

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