PHOSEnergyCalibrator.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 O2_CALIBRATION_PHOSENERGY_CALIBRATOR_H
#define O2_CALIBRATION_PHOSENERGY_CALIBRATOR_H
 
 
#include "Framework/Task.h"
#include "Framework/WorkflowSpec.h"
#include "DetectorsCalibration/TimeSlotCalibration.h"
#include "DataFormatsPHOS/TriggerRecord.h"
#include "DataFormatsPHOS/Cluster.h"
#include "PHOSCalibWorkflow/RingBuffer.h"
#include "DataFormatsPHOS/CalibParams.h"
#include "DataFormatsPHOS/BadChannelsMap.h"
#include "PHOSBase/Geometry.h"
#include "PHOSCalibWorkflow/ETCalibHistos.h"
 
#include <TLorentzVector.h>
#include <TVector3.h>
#include <array>
 
using namespace o2::framework;
 
namespace o2
{
namespace phos
{
 
// structure used to store digit info for re-calibration
union CalibDigit {
  uint32_t mDataWord;
  struct {
    uint32_t mAddress : 14; 
    uint32_t mAdcAmp : 10;  
    uint32_t mHgLg : 1;     
    uint32_t mCluster : 7;  
  };
};
// Event header for energy calibraton. Allow accessing external info with vertex position and collision time
union EventHeader {
  uint32_t mDataWord;
  struct {
    uint32_t mMarker : 14; 
    uint32_t mBC : 18;     
  };
};
 
class PHOSEnergySlot
{
 
 public:
  static constexpr short kMaxCluInEvent = 128; 
 
  PHOSEnergySlot();
  PHOSEnergySlot(const PHOSEnergySlot& other);
 
  ~PHOSEnergySlot() = default;
 
  void print() const;
  void fill(const gsl::span<const Cluster>& clusters, const gsl::span<const CluElement>& cluelements, const gsl::span<const TriggerRecord>& cluTR);
  void fill(const gsl::span<const Cluster>& /*c*/){}; // not used
  void merge(const PHOSEnergySlot* /*prev*/) {}       // not used
  void clear();
 
  const ETCalibHistos* getCollectedHistos() const { return mHistos.get(); }
  const std::vector<uint32_t>& getCollectedDigits() const { return mDigits; }
 
  void setRunStartTime(long tf) { mRunStartTime = tf; }
  void setFillDigitsTree(bool toFill) { mFillDigitsTree = toFill; }
  void setCalibration(const CalibParams* c) { mCalibParams = c; }
  void setBadMap(const BadChannelsMap* map) { mBadMap = map; }
  void setCuts(float ptMin, float eminHGTime, float eminLGTime, float eDigMin, float eCluMin)
  {
    mPtMin = ptMin;
    mEminHGTime = eminHGTime;
    mEminLGTime = eminLGTime;
    mDigitEmin = eDigMin;
    mClusterEmin = eCluMin;
  }
 
 private:
  void fillTimeMassHisto(const Cluster& clu, const gsl::span<const CluElement>& cluelements);
  bool checkCluster(const Cluster& clu);
  float Nonlinearity(float en);
 
  long mRunStartTime = 0;                 
  std::unique_ptr<RingBuffer> mBuffer;    
  const CalibParams* mCalibParams;        
  const BadChannelsMap* mBadMap;          
  Geometry* mGeom;                        
  std::unique_ptr<ETCalibHistos> mHistos; 
  uint32_t mEvBC = 0;
  uint32_t mEvOrbit = 0;
  uint32_t mEvent = 0;
  float mPtMin = 2.;        
  float mEminHGTime = 2.;   
  float mEminLGTime = 6.;   
  float mDigitEmin = 0.005; 
  float mClusterEmin = 0.4; 
  bool mFillDigitsTree = false;
  std::vector<uint32_t> mDigits; 
};
 
class PHOSEnergyCalibrator final : public o2::calibration::TimeSlotCalibration<o2::phos::PHOSEnergySlot>
{
  using Slot = o2::calibration::TimeSlot<o2::phos::PHOSEnergySlot>;
 
 public:
  PHOSEnergyCalibrator();
 
  bool hasEnoughData(const Slot& slot) const final { return true; } // no need to merge Slots
  void initOutput() final {}
  void finalizeSlot(Slot& slot) final;
  Slot& emplaceNewSlot(bool front, TFType tstart, TFType tend) final;
  bool process(uint64_t tf, const gsl::span<const Cluster>& clusters, const gsl::span<const CluElement>& cluelements, const gsl::span<const TriggerRecord>& cluTR, std::vector<uint32_t>& outputDigits);
 
  void endOfStream();
 
  const ETCalibHistos* getCollectedHistos() const { return mHistos.get(); }
  void setFillDigitsTree(bool toFill) { mFillDigitsTree = toFill; }
  void setCalibration(const CalibParams* c) { mCalibParams = c; }
  void setBadMap(const BadChannelsMap* map) { mBadMap = map; }
  void setCuts(float ptMin, float eminHGTime, float eminLGTime, float eDigMin, float eCluMin)
  {
    mPtMin = ptMin;
    mEminHGTime = eminHGTime;
    mEminLGTime = eminLGTime;
    mDigitEmin = eDigMin;
    mClusterEmin = eCluMin;
  }
 
 private:
  bool calculateCalibrations();
 
 private:
  long mRunStartTime = 0;                    
  float mPtMin = 2.;                         
  float mEminHGTime = 1.5;                   
  float mEminLGTime = 5.5;                   
  float mDigitEmin = 0.05;                   
  float mClusterEmin = 0.4;                  
  const CalibParams* mCalibParams = nullptr; 
  const BadChannelsMap* mBadMap = nullptr;   
  bool mFillDigitsTree = false;
  std::unique_ptr<ETCalibHistos> mHistos; 
};
 
} // namespace phos
} // namespace o2
 
#endif