History.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef LArSamples_History_H
#define LArSamples_History_H
 
#include "LArCafJobs/Definitions.h"
#include "LArCafJobs/CellInfo.h"//member
#include "LArSamplesMon/Chi2Calc.h" //for defaulted value
#include "LArCafJobs/EventData.h"//implemented method
#include "TVectorD.h" //typedef
#include <vector>
#include <memory>
 
class TString;
 
namespace LArSamples {
  
  class Interface;
  class Data;
  class Averager;
  class GraphShape;
  class AbsShapeErrorGetter;
  class ShapeErrorData;
  class ScaledErrorData;
  class Residual;
  class Residuals;
  class HistoryContainer;
  
  class ATLAS_NOT_THREAD_SAFE History {
  
    public:
   
      History(const HistoryContainer& container, 
              std::vector<std::unique_ptr<const EventData> >&& eventData, unsigned int hash,
              const AbsShapeErrorGetter* shapeErrorGetter = 0);
 
      History(std::vector<std::unique_ptr<const Data> >&& data,
              const CellInfo& info,
              std::vector<std::unique_ptr<const EventData> >&& eventData,
              unsigned int hash, const AbsShapeErrorGetter* shapeErrorGetter = 0);
      
      virtual ~History();
 
      std::unique_ptr<HistoryContainer> dissolve();
 
      unsigned int nData() const { return m_data.size(); }
      const Data* data(unsigned int i) const;
      const Data* data_for_event(int event, int run = -1) const;
      const Data* data_for_event(const EventData& eventData) const;
 
      const CellInfo* cellInfo() const { return &m_cellInfo; }
    
      const std::vector<std::unique_ptr<const EventData> >& eventData() const { return m_eventData; }
      
      bool sum(std::unique_ptr<SimpleShape>& sum,
               std::unique_ptr<SimpleShape>& reference) const;
      bool allShape(std::unique_ptr<GraphShape>& allData,
                    std::unique_ptr<SimpleShape>& allRef) const;
      double allChi2(Chi2Params pars) const;
    
      // helpers
      double chi2(int i, int lwb = -1, int upb = -1, int chi2Params = DefaultChi2, ShapeErrorType shapeErrorType = BestShapeError, unsigned int* nDof = 0) const;
      double chi2_k(int i, double k, int lwb = -1, int upb = -1, int chi2Params = DefaultChi2) const;
      double maxChi2(int lwb = -1, int upb = -1, int chi2Params = DefaultChi2) const;
      
      std::unique_ptr<OFC> ofc(unsigned int i, int lwb = -1, int upb = -1, double time = Definitions::none, bool useCorrs = true) const;
      std::unique_ptr<History> refit(Chi2Params pars = DefaultChi2) const;
      std::unique_ptr<History> adjust() const;
      std::unique_ptr<History> filter(const TString& cuts) const;
      
      bool refVal(unsigned int i, unsigned int sample, double& val, double& err) const;
      bool delta(unsigned int i, unsigned int sample, double& del) const;
      TVectorD deltas(unsigned int i, int lwb = -1, int upb = -1, bool correct = true) const;
      bool isValid() const;
      
      TString description(unsigned int verbosity = 1) const;
      
      std::unique_ptr<SimpleShape> referenceShape(unsigned int k, double adcMax = -1, double time = Definitions::none,
                                  bool samplesOnly = false) const;
                                  
      std::unique_ptr<SimpleShape> deltaShape(unsigned int k, int lwb = -1, int upb = -1) const;
      
      unsigned int hash() const { return m_hash; }
      //cppcheck-suppress danglingLifetime
      void setShapeErrorGetter(const AbsShapeErrorGetter* err) const { m_shapeErrorGetter = err; }
      const AbsShapeErrorGetter* shapeErrorGetter() const { return m_shapeErrorGetter; }
      std::unique_ptr<const ShapeErrorData> shapeErrorData(CaloGain::CaloGain gain, ShapeErrorType shapeErrorType = BestShapeError, const Residual* res = 0) const;
      std::unique_ptr<const ScaledErrorData> scaledErrorData(unsigned int i, double adcMax = -1, double time = Definitions::none, ShapeErrorType shapeErrorType = BestShapeError) const;
 
      bool residualOffset(unsigned int i, short sample, double& offset, double adcMax = -1, double time = Definitions::none) const;
      bool residualError(unsigned int i, short sample1, short sample2, double& offset, double adcMax = -1, double time = Definitions::none) const;
      
      bool drawWithReference(int i, const TString& atlasTitle = "") const;
      bool drawSumWithReference() const;
      bool drawAllWithReference(bool refit = false) const;
      bool drawResiduals(int k = -1, bool errors = true, bool rescale = true) const;
      
      std::unique_ptr<Averager> calculatePedestal(int i) const;
      std::unique_ptr<Residual> residual(unsigned int k, bool correct = true, bool zeroTime = false) const;
      std::unique_ptr<Residuals> residuals(CaloGain::CaloGain gain = CaloGain::LARNGAIN, double absResTrunc = -1, bool correct = true, bool zeroTime = false) const;
 
      double upstreamEnergy(unsigned int k) const;
      double chi2Anomaly(double chi2Cut, unsigned int nDof = 3) const;
      
      void setInterface(const Interface* interface) const { m_interface = interface; }
      
    private:
      
     std::vector<std::unique_ptr<const Data> > m_data;
     CellInfo m_cellInfo;
     std::vector<std::unique_ptr<const EventData> > m_eventData;
     unsigned int m_hash;
     mutable const AbsShapeErrorGetter* m_shapeErrorGetter;
     mutable const Interface* m_interface = nullptr;
  };
}
#endif