ResPlotTool.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file ResPlotTool.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/Geometry/GeometryContext.hpp"
#include "Acts/Utilities/Logger.hpp"
#include "ActsExamples/Utilities/Helpers.hpp"
#include "ActsFatras/EventData/Particle.hpp"

#include <map>
#include <memory>
#include <string>
#include <vector>

class TH1F;
class TH2F;
namespace ActsFatras {
class Particle;
}  // namespace ActsFatras

namespace ActsExamples {

// Tools to make hists to show residual, i.e. smoothed_parameter -
// truth_parameter, and pull, i.e. (smoothed_parameter -
// truth_parameter)/smoothed_paramter_error, of track parameters at perigee
// surface
class ResPlotTool {
 public:
  struct Config {
    std::vector<std::string> paramNames = {"d0",    "z0",  "phi",
                                           "theta", "qop", "t"};

    std::map<std::string, PlotHelpers::Binning> varBinning = {
        {"Eta", PlotHelpers::Binning("#eta", 40, -4, 4)},
        {"Pt", PlotHelpers::Binning("pT [GeV/c]", 40, 0, 100)},
        {"Pull", PlotHelpers::Binning("pull", 100, -5, 5)},
        {"Residual_d0", PlotHelpers::Binning("r_{d0} [mm]", 100, -0.5, 0.5)},
        {"Residual_z0", PlotHelpers::Binning("r_{z0} [mm]", 100, -0.5, 0.5)},
        {"Residual_phi",
         PlotHelpers::Binning("r_{#phi} [rad]", 100, -0.01, 0.01)},
        {"Residual_theta",
         PlotHelpers::Binning("r_{#theta} [rad]", 100, -0.01, 0.01)},
        {"Residual_qop",
         PlotHelpers::Binning("r_{q/p} [c/GeV]", 100, -0.1, 0.1)},
        {"Residual_t", PlotHelpers::Binning("r_{t} [s]", 100, -1000, 1000)}};
  };

  struct ResPlotCache {
    std::map<std::string, TH1F*> res;         
    std::map<std::string, TH2F*> res_vs_eta;  
    std::map<std::string, TH1F*>
        resMean_vs_eta;  
    std::map<std::string, TH1F*>
        resWidth_vs_eta;  
    std::map<std::string, TH2F*> res_vs_pT;  
    std::map<std::string, TH1F*>
        resMean_vs_pT;  
    std::map<std::string, TH1F*>
        resWidth_vs_pT;  

    std::map<std::string, TH1F*> pull;         
    std::map<std::string, TH2F*> pull_vs_eta;  
    std::map<std::string, TH1F*>
        pullMean_vs_eta;  
    std::map<std::string, TH1F*>
        pullWidth_vs_eta;  
    std::map<std::string, TH2F*> pull_vs_pT;  
    std::map<std::string, TH1F*>
        pullMean_vs_pT;  
    std::map<std::string, TH1F*>
        pullWidth_vs_pT;  
  };

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

  void book(ResPlotCache& resPlotCache) const;

  void fill(ResPlotCache& resPlotCache, const Acts::GeometryContext& gctx,
            const ActsFatras::Particle& truthParticle,
            const Acts::BoundTrackParameters& fittedParamters) const;

  void refinement(ResPlotCache& resPlotCache) const;

  void write(const ResPlotCache& resPlotCache) const;

  void clear(ResPlotCache& resPlotCache) const;

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

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

}  // namespace ActsExamples