CalibPadGainTracksBase.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef ALICEO2_TPC_CALIBPADGAINTRACKSBASE_H
#define ALICEO2_TPC_CALIBPADGAINTRACKSBASE_H
 
// o2 includes
#include "TPCBase/CalDet.h"
#include "TPCCalibration/FastHisto.h"
 
#include <gsl/span>
 
class TCanvas;
 
namespace o2
{
namespace tpc
{
 
class CalibPadGainTracksBase
{
 public:
  enum NormType : unsigned char {
    none,  
    stack, 
    region 
  };
 
  using DataTHisto = FastHisto<unsigned int>;
  using DataTHistos = CalDet<DataTHisto>;
 
  CalibPadGainTracksBase(const bool initCalPad = true);
 
  void initCalPadMemory() { mGainMap = std::make_unique<CalPad>("GainMap"); }
 
  void initCalPadStdDevMemory() { mSigmaMap = std::make_unique<CalPad>("SigmaMap"); }
 
  void initCalPadStat() { mNClMap = std::make_unique<CalPad>("NClustersMap"); }
 
  CalibPadGainTracksBase(const CalibPadGainTracksBase& other) : mPadHistosDet(std::make_unique<DataTHistos>(*other.mPadHistosDet)), mGainMap(std::make_unique<CalPad>(*other.mGainMap)) {}
 
  void fill(const gsl::span<const DataTHistos>& caldets);
 
  void fill(const DataTHistos& caldet) { *mPadHistosDet.get() += caldet; }
 
  void print() const;
 
  void merge(const CalibPadGainTracksBase* other) { *mPadHistosDet.get() += *(other->mPadHistosDet).get(); }
 
  bool hasEnoughData(const int minEntries) const;
 
  void finalize(const int minEntries = 10, const float minRelgain = 0.1f, const float maxRelgain = 2.f, const float low = 0.05f, const float high = 0.6f, const float minStDev = 0.01);
 
  const auto& getHistos() const { return mPadHistosDet; }
 
  const CalPad& getPadGainMap() const { return *mGainMap; }
 
  CalPad& getPadGainMap() { return *mGainMap; }
 
  const CalPad& getSigmaMap() const { return *mSigmaMap; }
 
  const CalPad& getNTracksMap() const { return *mNClMap; }
 
  DataTHisto getHistogram(const int sector, const int region, const int lrow, const int pad) const;
 
  DataTHisto getHistogram(const int sector, const int grow, const int pad) const;
 
  void drawExtractedGainMapSector(const int sector, const std::string filename = "GainMapSector.pdf", const float minZ = 0, const float maxZ = -1) const { drawExtractedGainMapHelper(false, 0, sector, filename, minZ, maxZ); }
 
  void drawExtractedGainMapSide(const o2::tpc::Side side, const std::string filename = "GainMapSide.pdf", const float minZ = 0, const float maxZ = -1) const { drawExtractedGainMapHelper(true, 0, side == Side::A ? Sector(0) : Sector(Sector::MAXSECTOR - 1), filename, minZ, maxZ); }
 
  void drawNClustersMapSide(const o2::tpc::Side side, const std::string filename = "NClustersMapSide.pdf", const float minZ = 0, const float maxZ = -1) const { drawExtractedGainMapHelper(true, 2, side == Side::A ? Sector(0) : Sector(Sector::MAXSECTOR - 1), filename, minZ, maxZ); }
 
  void drawExtractedSigmaMapSector(const int sector, const bool norm = false, const std::string filename = "StdDevMapSector.pdf", const float minZ = 0, const float maxZ = -1) const { drawExtractedGainMapHelper(false, 1, sector, filename, minZ, maxZ, norm); }
 
  void drawExtractedSigmaMapSide(const o2::tpc::Side side, const bool norm = false, const std::string filename = "StdDevMapSide.pdf", const float minZ = 0, const float maxZ = -1) const { drawExtractedGainMapHelper(true, 1, side == Side::A ? Sector(0) : Sector(Sector::MAXSECTOR - 1), filename, minZ, maxZ, norm); }
 
  void drawNClustersMapSector(const int sector, const std::string filename = "NClustersMapSector.pdf", const float minZ = 0, const float maxZ = -1) const { drawExtractedGainMapHelper(false, 2, sector, filename, minZ, maxZ, false); }
 
  TCanvas* drawExtractedGainMapPainter() const;
 
  void divideGainMap(const char* inpFile, const char* mapName);
 
  void dumpGainMap(const char* fileName = "GainMap.root") const;
 
  void dumpToFile(const char* outFileName = "calPadGainTracksBase.root", const char* outName = "calPadGain") const;
 
  void dumpToTree(const std::string filename = "map_debug.root") const;
 
  void setGainMap(const char* inpFile, const char* mapName);
 
  void setGainMap(const CalPad& gainmap) { mGainMap = std::make_unique<CalPad>(gainmap); }
 
  void setRMSMap(const CalPad& rmsMap) { mSigmaMap = std::make_unique<CalPad>(rmsMap); }
 
  void setNClMap(const CalPad& nclMap) { mNClMap = std::make_unique<CalPad>(nclMap); }
 
  void setNormalizationType(const NormType type) { mNormType = type; }
 
  auto getNormalizationType() const { return mNormType; }
 
  bool setLogTransformQ(const bool logTransformQ) { return mLogTransformQ = logTransformQ; }
 
  bool getLogTransformQ() const { return mLogTransformQ; }
 
  void resetHistos();
 
  void init(const unsigned int nBins, const float xmin, const float xmax, const bool useUnderflow, const bool useOverflow);
 
  void fillPadByPadHistogram(const size_t roc, const size_t padInROC, const float val) { mPadHistosDet->getCalArray(roc).getData()[padInROC].fill(val); }
 
 private:
  std::unique_ptr<DataTHistos> mPadHistosDet; 
  std::unique_ptr<CalPad> mGainMap;           
  std::unique_ptr<CalPad> mSigmaMap;          
  std::unique_ptr<CalPad> mNClMap;            
  NormType mNormType = region;                
  bool mLogTransformQ{true};                  
 
  void drawExtractedGainMapHelper(const bool type, const int typeMap, const Sector sector, const std::string filename, const float minZ, const float maxZ, const bool norm = false) const;
 
  void normalize(std::vector<float>& data, const std::vector<int>& nPads);
 
  void normalizeGain(CalPad& calPad);
 
  std::vector<int> getNPadsForNormalization(const bool iroc) const;
 
  void normalizeGainMap() { normalizeGain(*mGainMap.get()); }
};
 
} // namespace tpc
} // namespace o2
 
#endif