tracking::reco::TrackComparisonProcessor Class Reference

Compares tracking performance between a truth-smeared hit chain and a charge-digitized hit chain on a track-by-track basis. More...

#include <TrackComparisonProcessor.h>

Classes
struct	PairVars

Public Member Functions
	TrackComparisonProcessor (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.
void	onProcessStart () override
	Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.
void	analyze (const framework::Event &event) override
	Process the event and make histograms or summaries.
void	onProcessEnd () override
	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::Analyzer
	Analyzer (const std::string &name, Process &process)
	Class constructor.
virtual void	process (Event &event) final
	Processing an event for an Analyzer is calling analyze.
virtual void	beforeNewRun (ldmx::RunHeader &run_header) final
	Don't allow Analyzers to add parameters to the run header.
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	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.
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	setupTree (TTree *tree, PairVars &v)
void	fillPair (const ldmx::Track &smear, const ldmx::Track &digi, const ldmx::SimParticle &truth, PairVars &v, const std::string &prefix)
void	processTracker (const framework::Event &event, const std::string &coll_smear, const std::string &pass_smear, const std::string &coll_digi, const std::string &pass_digi, TTree *tree, PairVars &vars, const std::string &histo_prefix)

Private Attributes
std::string	trk_collection_smear_ {"TaggerTracks"}
std::string	trk_collection_digi_ {"TaggerDigiTracks"}
std::string	pass_name_smear_ {""}
std::string	pass_name_digi_ {""}
bool	do_tagger_ {true}
bool	do_recoil_ {false}
std::string	recoil_collection_smear_ {"RecoilTracks"}
std::string	recoil_collection_digi_ {"RecoilDigiTracks"}
std::string	recoil_pass_smear_ {""}
std::string	recoil_pass_digi_ {""}
double	min_truth_prob_ {0.5}
std::string	sim_particles_pass_ {""}
std::string	output_file_ {"track_comparison.root"}
TFile *	file_ {nullptr}
TTree *	tagger_tree_ {nullptr}
TTree *	recoil_tree_ {nullptr}
PairVars	tagger_vars_
PairVars	recoil_vars_

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

Compares tracking performance between a truth-smeared hit chain and a charge-digitized hit chain on a track-by-track basis.

Both chains must run upstream in the same job, producing two separate Track collections. Tracks are matched by their truth-matched SimParticle ID (Track::getTrackID()). For each matched pair, a row is written to a flat ROOT TTree and a set of quick-look TH1F histograms is filled via the framework HistogramPool.

Definition at line 28 of file TrackComparisonProcessor.h.

Constructor & Destructor Documentation

TrackComparisonProcessor()

tracking::reco::TrackComparisonProcessor::TrackComparisonProcessor	(	const std::string &	name,
		framework::Process &	process )

Definition at line 12 of file TrackComparisonProcessor.cxx.

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

Member Function Documentation

analyze()

void tracking::reco::TrackComparisonProcessor::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 258 of file TrackComparisonProcessor.cxx.

                                                                  {
  if (do_tagger_) {
    processTracker(event, trk_collection_smear_, pass_name_smear_,
                   trk_collection_digi_, pass_name_digi_, tagger_tree_,
                   tagger_vars_, "tagger_");
  }
  if (do_recoil_) {
    processTracker(event, recoil_collection_smear_, recoil_pass_smear_,
                   recoil_collection_digi_, recoil_pass_digi_, recoil_tree_,
                   recoil_vars_, "recoil_");
  }
}

configure()

void tracking::reco::TrackComparisonProcessor::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 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 16 of file TrackComparisonProcessor.cxx.

                                           {
  trk_collection_smear_ =
      parameters.get<std::string>("trk_collection_smear", "TaggerTracks");
  trk_collection_digi_ =
      parameters.get<std::string>("trk_collection_digi", "TaggerDigiTracks");
  pass_name_smear_ = parameters.get<std::string>("pass_name_smear", "");
  pass_name_digi_ = parameters.get<std::string>("pass_name_digi", "");
  do_tagger_ = parameters.get<bool>("do_tagger", true);
  do_recoil_ = parameters.get<bool>("do_recoil", false);
  recoil_collection_smear_ =
      parameters.get<std::string>("recoil_collection_smear", "RecoilTracks");
  recoil_collection_digi_ =
      parameters.get<std::string>("recoil_collection_digi", "RecoilDigiTracks");
  recoil_pass_smear_ = parameters.get<std::string>("recoil_pass_smear", "");
  recoil_pass_digi_ = parameters.get<std::string>("recoil_pass_digi", "");
  min_truth_prob_ = parameters.get<double>("min_truth_prob", 0.5);
  sim_particles_pass_ = parameters.get<std::string>("sim_particles_pass", "");
  output_file_ =
      parameters.get<std::string>("output_file", "track_comparison.root");
}

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

fillPair()

void tracking::reco::TrackComparisonProcessor::fillPair ( const ldmx::Track & smear, const ldmx::Track & digi, const ldmx::SimParticle & truth, PairVars & v, const std::string & prefix )

private

Definition at line 143 of file TrackComparisonProcessor.cxx.

                                                                 {
  v.track_id = smear.getTrackID();
  v.truth_prob_s = smear.getTruthProb();
  v.truth_prob_d = digi.getTruthProb();
  v.nhits_s = smear.getNhits();
  v.nhits_d = digi.getNhits();
  v.chi2ndf_s = (smear.getNdf() > 0) ? smear.getChi2() / smear.getNdf() : -1;
  v.chi2ndf_d = (digi.getNdf() > 0) ? digi.getChi2() / digi.getNdf() : -1;
  v.d0_s = smear.getD0();
  v.d0_d = digi.getD0();
  v.z0_s = smear.getZ0();
  v.z0_d = digi.getZ0();
  v.phi_s = smear.getPhi();
  v.phi_d = digi.getPhi();
  v.theta_s = smear.getTheta();
  v.theta_d = digi.getTheta();
  v.qop_s = smear.getQoP();
  v.qop_d = digi.getQoP();
  // QoP is in e/GeV (ACTS units); convert to MeV so p_s/p_d match SimParticle
  // units.
  v.p_s = (v.qop_s != 0) ? std::abs(1000.0 / v.qop_s) : -1;
  v.p_d = (v.qop_d != 0) ? std::abs(1000.0 / v.qop_d) : -1;
  v.delta_d0 = v.d0_d - v.d0_s;
  v.delta_z0 = v.z0_d - v.z0_s;
  v.delta_phi = v.phi_d - v.phi_s;
  v.delta_theta = v.theta_d - v.theta_s;
  v.delta_p_over_p = (v.p_s > 0) ? (v.p_d - v.p_s) / v.p_s : -999;
 
  auto mom_s = smear.getMomentumAtTarget();
  if (mom_s.size() == 3) {
    v.px_s = mom_s[0];
    v.py_s = mom_s[1];
    v.pz_s = mom_s[2];
  }
  auto mom_d = digi.getMomentumAtTarget();
  if (mom_d.size() == 3) {
    v.px_d = mom_d[0];
    v.py_d = mom_d[1];
    v.pz_d = mom_d[2];
  }
 
  auto mom_t = truth.getMomentum();
  v.px_t = mom_t[0];
  v.py_t = mom_t[1];
  v.pz_t = mom_t[2];
  v.p_t = std::sqrt(v.px_t * v.px_t + v.py_t * v.py_t + v.pz_t * v.pz_t);
  auto vtx = truth.getVertex();
  v.vx_t = vtx[0];
  v.vy_t = vtx[1];
  v.vz_t = vtx[2];
 
  v.delta_p_over_p_s = (v.p_t > 0) ? (v.p_s - v.p_t) / v.p_t : -999;
  v.delta_p_over_p_d = (v.p_t > 0) ? (v.p_d - v.p_t) / v.p_t : -999;
 
  histograms_.fill(prefix + "delta_d0", v.delta_d0);
  histograms_.fill(prefix + "delta_z0", v.delta_z0);
  histograms_.fill(prefix + "delta_phi", v.delta_phi);
  histograms_.fill(prefix + "delta_theta", v.delta_theta);
  histograms_.fill(prefix + "delta_p_over_p", v.delta_p_over_p);
  histograms_.fill(prefix + "nhits_s", v.nhits_s);
  histograms_.fill(prefix + "nhits_d", v.nhits_d);
  histograms_.fill(prefix + "chi2ndf_s", v.chi2ndf_s);
  histograms_.fill(prefix + "chi2ndf_d", v.chi2ndf_d);
  histograms_.fill(prefix + "p_s", v.p_s);
  histograms_.fill(prefix + "p_d", v.p_d);
  histograms_.fill(prefix + "p_t", v.p_t);
  histograms_.fill(prefix + "delta_p_over_p_s", v.delta_p_over_p_s);
  histograms_.fill(prefix + "delta_p_over_p_d", v.delta_p_over_p_d);
}

onProcessEnd()

void tracking::reco::TrackComparisonProcessor::onProcessEnd ( )

overridevirtual

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

                                            {
  file_->cd();
  if (tagger_tree_) tagger_tree_->Write("", TObject::kOverwrite);
  if (recoil_tree_) recoil_tree_->Write("", TObject::kOverwrite);
  file_->Close();
}

onProcessStart()

void tracking::reco::TrackComparisonProcessor::onProcessStart ( )

overridevirtual

Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.

Reimplemented from framework::EventProcessor.

Definition at line 80 of file TrackComparisonProcessor.cxx.

                                              {
  file_ = new TFile(output_file_.c_str(), "RECREATE");
  file_->cd();
 
  if (do_tagger_) {
    tagger_tree_ =
        new TTree("tagger_pairs", "Tagger smear-vs-digi track pairs");
    tagger_tree_->SetDirectory(file_);
    setupTree(tagger_tree_, tagger_vars_);
 
    histograms_.create("tagger_delta_d0", "#Delta d_{0} (digi-smear) [mm]", 200,
                       -0.5, 0.5);
    histograms_.create("tagger_delta_z0", "#Delta z_{0} (digi-smear) [mm]", 200,
                       -2.0, 2.0);
    histograms_.create("tagger_delta_phi", "#Delta #phi (digi-smear) [rad]",
                       200, -0.02, 0.02);
    histograms_.create("tagger_delta_theta", "#Delta #theta (digi-smear) [rad]",
                       200, -0.02, 0.02);
    histograms_.create("tagger_delta_p_over_p", "#Delta p/p (digi-smear)/smear",
                       200, -0.1, 0.1);
    histograms_.create("tagger_nhits_s", "N hits (smear)", 15, 0, 15);
    histograms_.create("tagger_nhits_d", "N hits (digi)", 15, 0, 15);
    histograms_.create("tagger_chi2ndf_s", "#chi^{2}/ndf (smear)", 100, 0, 10);
    histograms_.create("tagger_chi2ndf_d", "#chi^{2}/ndf (digi)", 100, 0, 10);
    histograms_.create("tagger_p_s", "p (smear) [MeV]", 200, 0, 8000);
    histograms_.create("tagger_p_d", "p (digi) [MeV]", 200, 0, 8000);
    histograms_.create("tagger_p_t", "p (truth) [MeV]", 200, 0, 8000);
    histograms_.create("tagger_delta_p_over_p_s",
                       "#Delta p/p (smear-truth)/truth", 200, -0.1, 0.1);
    histograms_.create("tagger_delta_p_over_p_d",
                       "#Delta p/p (digi-truth)/truth", 200, -0.1, 0.1);
  }
 
  if (do_recoil_) {
    recoil_tree_ =
        new TTree("recoil_pairs", "Recoil smear-vs-digi track pairs");
    recoil_tree_->SetDirectory(file_);
    setupTree(recoil_tree_, recoil_vars_);
 
    histograms_.create("recoil_delta_d0", "#Delta d_{0} (digi-smear) [mm]", 200,
                       -2.0, 2.0);
    histograms_.create("recoil_delta_z0", "#Delta z_{0} (digi-smear) [mm]", 200,
                       -5.0, 5.0);
    histograms_.create("recoil_delta_phi", "#Delta #phi (digi-smear) [rad]",
                       200, -0.02, 0.02);
    histograms_.create("recoil_delta_theta", "#Delta #theta (digi-smear) [rad]",
                       200, -0.02, 0.02);
    histograms_.create("recoil_delta_p_over_p", "#Delta p/p (digi-smear)/smear",
                       200, -0.4, 0.4);
    histograms_.create("recoil_nhits_s", "N hits (smear)", 15, 0, 15);
    histograms_.create("recoil_nhits_d", "N hits (digi)", 15, 0, 15);
    histograms_.create("recoil_chi2ndf_s", "#chi^{2}/ndf (smear)", 100, 0, 10);
    histograms_.create("recoil_chi2ndf_d", "#chi^{2}/ndf (digi)", 100, 0, 10);
    histograms_.create("recoil_p_s", "p (smear) [MeV]", 200, 0, 8000);
    histograms_.create("recoil_p_d", "p (digi) [MeV]", 200, 0, 8000);
    histograms_.create("recoil_p_t", "p (truth) [MeV]", 200, 0, 8000);
    histograms_.create("recoil_delta_p_over_p_s",
                       "#Delta p/p (smear-truth)/truth", 200, -0.4, 0.4);
    histograms_.create("recoil_delta_p_over_p_d",
                       "#Delta p/p (digi-truth)/truth", 200, -0.4, 0.4);
  }
}

processTracker()

void tracking::reco::TrackComparisonProcessor::processTracker ( const framework::Event & event, const std::string & coll_smear, const std::string & pass_smear, const std::string & coll_digi, const std::string & pass_digi, TTree * tree, PairVars & vars, const std::string & histo_prefix )

private

Definition at line 217 of file TrackComparisonProcessor.cxx.

                                                                             {
  if (!event.exists(coll_smear, pass_smear)) {
    ldmx_log(warn) << "Smear collection " << coll_smear << " not found";
    return;
  }
  if (!event.exists(coll_digi, pass_digi)) {
    ldmx_log(warn) << "Digi collection " << coll_digi << " not found";
    return;
  }
 
  const auto& tracks_smear =
      event.getCollection<ldmx::Track>(coll_smear, pass_smear);
  const auto& tracks_digi =
      event.getCollection<ldmx::Track>(coll_digi, pass_digi);
 
  const auto& particle_map =
      event.getMap<int, ldmx::SimParticle>("SimParticles", sim_particles_pass_);
 
  std::map<int, const ldmx::Track*> smear_by_id;
  for (const auto& t : tracks_smear) {
    if (t.getTruthProb() >= min_truth_prob_) smear_by_id[t.getTrackID()] = &t;
  }
 
  for (const auto& t : tracks_digi) {
    if (t.getTruthProb() < min_truth_prob_) continue;
    auto it = smear_by_id.find(t.getTrackID());
    if (it == smear_by_id.end()) continue;
    auto pit = particle_map.find(t.getTrackID());
    if (pit == particle_map.end()) continue;
 
    fillPair(*it->second, t, pit->second, vars, histo_prefix);
    tree->Fill();
  }
}

setupTree()

void tracking::reco::TrackComparisonProcessor::setupTree ( TTree * tree, PairVars & v )

private

Definition at line 38 of file TrackComparisonProcessor.cxx.

                                                                 {
  tree->Branch("track_id", &v.track_id);
  tree->Branch("truth_prob_s", &v.truth_prob_s);
  tree->Branch("truth_prob_d", &v.truth_prob_d);
  tree->Branch("nhits_s", &v.nhits_s);
  tree->Branch("nhits_d", &v.nhits_d);
  tree->Branch("chi2ndf_s", &v.chi2ndf_s);
  tree->Branch("chi2ndf_d", &v.chi2ndf_d);
  tree->Branch("d0_s", &v.d0_s);
  tree->Branch("d0_d", &v.d0_d);
  tree->Branch("z0_s", &v.z0_s);
  tree->Branch("z0_d", &v.z0_d);
  tree->Branch("phi_s", &v.phi_s);
  tree->Branch("phi_d", &v.phi_d);
  tree->Branch("theta_s", &v.theta_s);
  tree->Branch("theta_d", &v.theta_d);
  tree->Branch("qop_s", &v.qop_s);
  tree->Branch("qop_d", &v.qop_d);
  tree->Branch("p_s", &v.p_s);
  tree->Branch("p_d", &v.p_d);
  tree->Branch("delta_d0", &v.delta_d0);
  tree->Branch("delta_z0", &v.delta_z0);
  tree->Branch("delta_phi", &v.delta_phi);
  tree->Branch("delta_theta", &v.delta_theta);
  tree->Branch("delta_p_over_p", &v.delta_p_over_p);
  tree->Branch("px_s", &v.px_s);
  tree->Branch("py_s", &v.py_s);
  tree->Branch("pz_s", &v.pz_s);
  tree->Branch("px_d", &v.px_d);
  tree->Branch("py_d", &v.py_d);
  tree->Branch("pz_d", &v.pz_d);
  tree->Branch("px_t", &v.px_t);
  tree->Branch("py_t", &v.py_t);
  tree->Branch("pz_t", &v.pz_t);
  tree->Branch("p_t", &v.p_t);
  tree->Branch("vx_t", &v.vx_t);
  tree->Branch("vy_t", &v.vy_t);
  tree->Branch("vz_t", &v.vz_t);
  tree->Branch("delta_p_over_p_s", &v.delta_p_over_p_s);
  tree->Branch("delta_p_over_p_d", &v.delta_p_over_p_d);
}

Member Data Documentation

do_recoil_

bool tracking::reco::TrackComparisonProcessor::do_recoil_ {false}

private

Definition at line 80 of file TrackComparisonProcessor.h.

{false};

do_tagger_

bool tracking::reco::TrackComparisonProcessor::do_tagger_ {true}

private

Definition at line 79 of file TrackComparisonProcessor.h.

{true};

file_

TFile* tracking::reco::TrackComparisonProcessor::file_ {nullptr}

private

Definition at line 90 of file TrackComparisonProcessor.h.

{nullptr};

min_truth_prob_

double tracking::reco::TrackComparisonProcessor::min_truth_prob_ {0.5}

private

Definition at line 85 of file TrackComparisonProcessor.h.

{0.5};

output_file_

std::string tracking::reco::TrackComparisonProcessor::output_file_ {"track_comparison.root"}

private

Definition at line 87 of file TrackComparisonProcessor.h.

{"track_comparison.root"};

pass_name_digi_

std::string tracking::reco::TrackComparisonProcessor::pass_name_digi_ {""}

private

Definition at line 78 of file TrackComparisonProcessor.h.

{""};

pass_name_smear_

std::string tracking::reco::TrackComparisonProcessor::pass_name_smear_ {""}

private

Definition at line 77 of file TrackComparisonProcessor.h.

{""};

recoil_collection_digi_

std::string tracking::reco::TrackComparisonProcessor::recoil_collection_digi_ {"RecoilDigiTracks"}

private

Definition at line 82 of file TrackComparisonProcessor.h.

{"RecoilDigiTracks"};

recoil_collection_smear_

std::string tracking::reco::TrackComparisonProcessor::recoil_collection_smear_ {"RecoilTracks"}

private

Definition at line 81 of file TrackComparisonProcessor.h.

{"RecoilTracks"};

recoil_pass_digi_

std::string tracking::reco::TrackComparisonProcessor::recoil_pass_digi_ {""}

private

Definition at line 84 of file TrackComparisonProcessor.h.

{""};

recoil_pass_smear_

std::string tracking::reco::TrackComparisonProcessor::recoil_pass_smear_ {""}

private

Definition at line 83 of file TrackComparisonProcessor.h.

{""};

recoil_tree_

TTree* tracking::reco::TrackComparisonProcessor::recoil_tree_ {nullptr}

private

Definition at line 92 of file TrackComparisonProcessor.h.

{nullptr};

recoil_vars_

PairVars tracking::reco::TrackComparisonProcessor::recoil_vars_

private

Definition at line 94 of file TrackComparisonProcessor.h.

sim_particles_pass_

std::string tracking::reco::TrackComparisonProcessor::sim_particles_pass_ {""}

private

Definition at line 86 of file TrackComparisonProcessor.h.

{""};

tagger_tree_

TTree* tracking::reco::TrackComparisonProcessor::tagger_tree_ {nullptr}

private

Definition at line 91 of file TrackComparisonProcessor.h.

{nullptr};

tagger_vars_

PairVars tracking::reco::TrackComparisonProcessor::tagger_vars_

private

Definition at line 93 of file TrackComparisonProcessor.h.

trk_collection_digi_

std::string tracking::reco::TrackComparisonProcessor::trk_collection_digi_ {"TaggerDigiTracks"}

private

Definition at line 76 of file TrackComparisonProcessor.h.

{"TaggerDigiTracks"};

trk_collection_smear_

std::string tracking::reco::TrackComparisonProcessor::trk_collection_smear_ {"TaggerTracks"}

private

Definition at line 75 of file TrackComparisonProcessor.h.

{"TaggerTracks"};

---

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

• Tracking/include/Tracking/Reco/TrackComparisonProcessor.h
• Tracking/src/Tracking/Reco/TrackComparisonProcessor.cxx