SiLorentzAngleTool.h

Go to the documentation of this file.

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

#ifndef SiLorentzAngleTool_h
#define SiLorentzAngleTool_h
 
#include "InDetCondTools/ISiLorentzAngleTool.h"
#include "AthenaBaseComps/AthAlgTool.h"
 
#include "GeoPrimitives/GeoPrimitives.h"
#include "InDetReadoutGeometry/SiDetectorElementCollection.h"
#include "MagFieldConditions/AtlasFieldCacheCondObj.h"
#include "SiLorentzAngleTool/SiLorentzAngleCondData.h"
#include "StoreGate/ReadCondHandleKey.h"
 
//Gaudi Includes
#include "GaudiKernel/ServiceHandle.h"
 
class IdentifierHash;
namespace InDetDD {
  class SiDetectorElement;
}

 
class SiLorentzAngleTool: public extends<AthAlgTool, ISiLorentzAngleTool>
{
public:
 
  SiLorentzAngleTool(const std::string& type, const std::string& name, const IInterface* parent);
  virtual ~SiLorentzAngleTool() = default;
 
  virtual StatusCode initialize() override;          
  virtual StatusCode finalize() override;            

  virtual double getLorentzShift(const IdentifierHash& elementHash, const EventContext& ctx) const override;

  virtual double getLorentzShift(const IdentifierHash& elementHash, const Amg::Vector2D& locPos, const EventContext& ctx) const override;

  virtual double getLorentzShiftEta(const IdentifierHash& elementHash, const EventContext& ctx) const override;

  virtual double getLorentzShiftEta(const IdentifierHash& elementHash, const Amg::Vector2D& locPos, const EventContext& ctx) const override;

  virtual double getTanLorentzAngle(const IdentifierHash& elementHash, const EventContext& ctx) const override;

  virtual double getTanLorentzAngle(const IdentifierHash& elementHash, const Amg::Vector2D& locPos, const EventContext& ctx) const override;

  virtual double getTanLorentzAngleEta(const IdentifierHash& elementHash, const EventContext& ctx) const override;

  virtual double getTanLorentzAngleEta(const IdentifierHash& elementHash, const Amg::Vector2D& locPos, const EventContext& ctx) const override;

  virtual double getBiasVoltage(const IdentifierHash& elementHash, const EventContext& ctx) const override;

  virtual double getTemperature(const IdentifierHash& elementHash, const EventContext& ctx) const override;

  virtual double getDepletionVoltage(const IdentifierHash& elementHash, const EventContext& ctx) const override;
 
private:
  enum Variable {LorentzShift, LorentzShiftEta, TanLorentzAngle, TanLorentzAngleEta};
 
  double getValue(const IdentifierHash& elementHash, const Amg::Vector2D& locPos, Variable variable, const EventContext& ctx) const;
  double getCorrectionFactor(const EventContext& ctx) const;
  Amg::Vector3D getMagneticField(const Amg::Vector3D& pointvec, const EventContext& ctx) const;
  const SiLorentzAngleCondData* getCondData(const EventContext& ctx) const;
  const InDetDD::SiDetectorElement* getDetectorElement(const IdentifierHash& waferHash, const EventContext& ctx) const;
 
  // Properties
  std::string              m_detectorName;
  double                   m_nominalField;
  bool                     m_useMagFieldCache;
  bool                     m_ignoreLocalPos;   // Makes methods using localPosition behave as method without passing localPosition.
  SG::ReadCondHandleKey<SiLorentzAngleCondData> m_condData;
  SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> m_detEleCollKey{this, "DetEleCollKey", "SCT_DetectorElementCollection", "Key of SiDetectorElementCollection for SCT or Pixel"};
  SG::ReadCondHandleKey<AtlasFieldCacheCondObj> m_fieldCondObjInputKey{this, "AtlasFieldCacheCondObj", "fieldCondObj", "Name of the Magnetic Field conditions object key"};
 
  static const double s_invalidValue;
};
 
#endif // SiLorentzAngleTool_h