IMdtCalibrationTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MDTCALIBSVC_IMDTCALIBRATIONTOOL_H
#define MDTCALIBSVC_IMDTCALIBRATIONTOOL_H
 
#include <bitset>
#include <GaudiKernel/IAlgTool.h>
#include <GaudiKernel/EventContext.h>
#include <MdtCalibInterfaces/MdtCalibInput.h>
#include <MdtCalibInterfaces/MdtCalibOutput.h>
#include <MdtCalibInterfaces/MdtCalibTwinOutput.h>
 
 
namespace MuonCalib{
    struct MdtFullCalibData;
}

 
class IMdtCalibrationTool : virtual public IAlgTool {
public:
 
  enum timeWindowMode {
      UserDefined = 0,    
      Default = 1,        
      CollisionG4 = 2,    
      CollisionData = 3,  
      CollisionFitT0 = 4, 
  };

  static constexpr double tdcBinSize = 0.78125;  //25/32; exact number: (1000.0/40.079)/32.0

  virtual ~IMdtCalibrationTool() = default;

  DeclareInterfaceID(IMdtCalibrationTool, 1, 0);
 
  virtual MdtCalibOutput calibrate(const EventContext& ctx, 
                                   const MdtCalibInput& hit,
                                   bool resolFromRtrack=false) const = 0;

  virtual MdtCalibTwinOutput calibrateTwinTubes(const EventContext& ctx,
                                                MdtCalibInput&& primHit, 
                                                MdtCalibInput&& twinHit) const = 0;
  
  
  virtual const MuonCalib::MdtFullCalibData* getCalibConstants(const EventContext& ctx,
                                                               const Identifier& channelId) const = 0;
  virtual double getResolutionFromRt(const EventContext& ctx,
                                     const Identifier& module,
                                     const double time) const  = 0;
 
  struct ToolSettings {
      enum class Property: int {
        TofCorrection = 0,
        PropCorrection,
        TempCorrection,
        MagFieldCorrection,
        SlewCorrection,
        BackgroundCorrection,
        NumSettings
      };
   
      void setBit(const Property prop, const bool value){
         m_mask.set(static_cast<unsigned int>(prop), value);
      }
      bool isActive(const Property prop) const {
        return m_mask.test(static_cast<unsigned int>(prop));
      }
      timeWindowMode window{timeWindowMode::UserDefined};
    private:
      using bitmask = std::bitset<static_cast<unsigned>(Property::NumSettings)>;
      bitmask m_mask{0};
 
  };
  virtual ToolSettings getSettings() const = 0;
 
};
 
#endif