FakeRatePlotTool.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file FakeRatePlotTool.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 <map>
#include <memory>
#include <string>

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

namespace FW {

// Tools to make fake rate plots to show tracking fake rate.
class FakeRatePlotTool {
 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]", 20, 0, 100)},
        {"Num", PlotHelpers::Binning("N", 30, -0.5, 29.5)}};
  };

  struct FakeRatePlotCache {
    TH1F* nRecoTracks;             
    TH1F* nTruthMatchedTracks;     
    TH1F* nFakeTracks;             
    TEfficiency* fakerate_vs_eta;  
    TEfficiency* fakerate_vs_phi;  
    TEfficiency* fakerate_vs_pT;   
    //@Todo: make duplication number plots with duplication plot tool
    TProfile* duplicationNum_vs_eta;  
    TProfile* duplicationNum_vs_phi;  
    TProfile* duplicationNum_vs_pT;   
  };

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

  void book(FakeRatePlotCache& fakeRatePlotCache) const;

  void fill(FakeRatePlotCache& fakeRatePlotCache,
            const ActsFatras::Particle& truthParticle, bool status) const;

  void fill(FakeRatePlotCache& fakeRatePlotCache,
            const ActsFatras::Particle& truthParticle,
            size_t nTruthMatchedTracks, size_t nFakeTracks) const;

  void write(const FakeRatePlotCache& fakeRatePlotCache) const;

  void clear(FakeRatePlotCache& fakeRatePlotCache) const;

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

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

}  // namespace FW