DuplicationPlotTool.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file DuplicationPlotTool.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2019 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/EventData/TrackParameters.hpp"
#include "Acts/Utilities/Logger.hpp"
#include "ActsExamples/Utilities/Helpers.hpp"
#include "ActsFatras/EventData/Particle.hpp"

#include <cstddef>
#include <map>
#include <memory>
#include <string>

class TEfficiency;
class TProfile;
namespace ActsFatras {
class Particle;
}  // namespace ActsFatras

namespace ActsExamples {

// Tools to make duplication rate and duplication number plots to show tracking
// duplication.
//
// The duplication is investigated for those truth-matched reco tracks. If there
// are a few reco tracks matched to the same truth particle, the reco track with
// the highest matching probability is tagges as 'real' and the others are
// 'duplicated'.
class DuplicationPlotTool {
 public:
  struct Config {
    std::map<std::string, PlotHelpers::Binning> varBinning = {
        {"Eta", PlotHelpers::Binning("#eta", 40, -4, 4)},
        {"Phi", PlotHelpers::Binning("#phi", 100, -3.15, 3.15)},
        {"Pt", PlotHelpers::Binning("pT [GeV/c]", 40, 0, 100)},
        {"Num", PlotHelpers::Binning("N", 30, -0.5, 29.5)}};
  };

  struct DuplicationPlotCache {
    TProfile* nDuplicated_vs_pT;         
    TProfile* nDuplicated_vs_eta;        
    TProfile* nDuplicated_vs_phi;        
    TEfficiency* duplicationRate_vs_pT;  
    TEfficiency* duplicationRate_vs_eta;  
    TEfficiency* duplicationRate_vs_phi;  
  };

  DuplicationPlotTool(const Config& cfg, Acts::Logging::Level lvl);

  void book(DuplicationPlotCache& duplicationPlotCache) const;

  void fill(DuplicationPlotCache& duplicationPlotCache,
            const Acts::BoundTrackParameters& fittedParameters,
            bool status) const;

  void fill(DuplicationPlotCache& duplicationPlotCache,
            const ActsFatras::Particle& truthParticle,
            size_t nDuplicatedTracks) const;

  void write(const DuplicationPlotCache& duplicationPlotCache) const;

  void clear(DuplicationPlotCache& duplicationPlotCache) const;

 private:
  Config m_cfg;                                  
  std::unique_ptr<const Acts::Logger> m_logger;  

  const Acts::Logger& logger() const { return *m_logger; }
};

}  // namespace ActsExamples