StripSurfaceChargesGenerator.h

Go to the documentation of this file.

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

 
#ifndef STRIPDIGITIZATION_STRIPSURFACECHARGESGENERATOR_H
#define STRIPDIGITIZATION_STRIPSURFACECHARGESGENERATOR_H
 
//Inheritance
#include "AthenaBaseComps/AthAlgTool.h"
#include "SiDigitization/ISurfaceChargesGenerator.h"
 
#include "SiDigitization/InducedChargeModel.h"
 
#include "Identifier/IdentifierHash.h"
#include "InDetConditionsSummaryService/ISiliconConditionsTool.h"
#include "InDetCondTools/ISiLorentzAngleTool.h"
#include "MagFieldConditions/AtlasFieldCacheCondObj.h"
//Eventually we will want an ITk Strip version of these?
#include "SCT_ConditionsTools/ISCT_RadDamageSummaryTool.h"
#include "SiPropertiesTool/ISiPropertiesTool.h"
#include "StoreGate/ReadCondHandle.h"
 
// Gaudi
#include "GaudiKernel/ITHistSvc.h" // for ITHistSvc
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
 
// CLHEP
#include "CLHEP/Units/SystemOfUnits.h"
 
#include <iostream>
 
// Charges and hits
class SiHit;
 
// -- do charge trapping histos
class ITHistSvc;
class TH1F;
class TH2F;
class TProfile;
 
namespace InDetDD {
  class SiDetectorElement;
}
 
namespace CLHEP {
  class HepRandomEngine;
}
 
template <class HIT> class TimedHitPtr;
 
namespace ITk
{
 
class StripSurfaceChargesGenerator : public extends<AthAlgTool, ISurfaceChargesGenerator> {
 public:

  StripSurfaceChargesGenerator(const std::string& type, const std::string& name, const IInterface* parent);

  virtual ~StripSurfaceChargesGenerator() = default;

  virtual StatusCode initialize() override;

  virtual StatusCode finalize() override;
 
 private:
 
  virtual void setFixedTime(float fixedTime) override                {m_tfix = fixedTime;}

  virtual void process(const InDetDD::SiDetectorElement* element, 
               const TimedHitPtr<SiHit>& phit, 
               ISiSurfaceChargesInserter& inserter, 
               CLHEP::HepRandomEngine * rndmEngine, 
               const EventContext& ctx) override;
  void processSiHit(const InDetDD::SiDetectorElement* element, 
            const SiHit& phit, 
            ISiSurfaceChargesInserter& inserter, 
            float eventTime, unsigned short eventID, 
            CLHEP::HepRandomEngine * rndmEngine, 
            const EventContext& ctx) const;
  
  // some diagnostics methods are needed here too
  float driftTime(float zhit, const InDetDD::SiDetectorElement* element, const EventContext& ctx) const; 
  float diffusionSigma(float zhit, const InDetDD::SiDetectorElement* element, const EventContext& ctx) const; 
  float surfaceDriftTime(float ysurf) const; 
  float maxDriftTime(const InDetDD::SiDetectorElement* element, const EventContext& ctx) const; 
  float maxDiffusionSigma(const InDetDD::SiDetectorElement* element, const EventContext& ctx) const; 
 
  // trap_pos and drift_time are updated based on spess.
  bool chargeIsTrapped(double spess, const InDetDD::SiDetectorElement* element, double& trap_pos, double& drift_time) const;
 
  IntegerProperty m_numberOfCharges{this, "NumberOfCharges", 1, "number of charges"};
  FloatProperty m_smallStepLength{this, "SmallStepLength", 5 * CLHEP::micrometer, "max internal step along the larger G4 step"};

  FloatProperty m_tSurfaceDrift{this, "SurfaceDriftTime", 10 * CLHEP::ns, "max surface drift time"};
 
  FloatProperty m_tfix{this, "FixedTime", -999., "fixed time"};
  FloatProperty m_tsubtract{this, "SubtractTime", -999., "subtract drift time from mid gap"};
 
  BooleanProperty m_useSiCondDB{this, "UseSiCondDB", true, "Usage of SiConditions DB values can be disabled to use setable ones"};
  FloatProperty m_vdepl{this, "DepletionVoltage", 70., "depletion voltage, default 70V"};
  FloatProperty m_vbias{this, "BiasVoltage", 150., "bias voltage, default 150V"};
  BooleanProperty m_doTrapping{this, "doTrapping", false, "Flag to set Charge Trapping"};
  BooleanProperty m_doHistoTrap{this, "doHistoTrap", false, "Histogram the charge trapping effect"};
  BooleanProperty m_doRamo{this, "doRamo", false, "Ramo Potential for charge trapping effect"};
  BooleanProperty m_isOverlay{this, "isOverlay", false, "flag for overlay"};
  BooleanProperty m_doInducedChargeModel{this, "doInducedChargeModel", false, "Flag for Induced Charge Model"};
 
  //ToolHandles
  ToolHandle<ISiPropertiesTool> m_siPropertiesTool{this, "SiPropertiesTool", "StripSiPropertiesTool", "Tool to retrieve SCT silicon properties"};
  ToolHandle<ISCT_RadDamageSummaryTool> m_radDamageTool{this, "RadDamageSummaryTool", "StripRadDamageSummaryTool", "Tool to retrieve SCT radiation damages"};
  ToolHandle<ISiliconConditionsTool> m_siConditionsTool{this, "SiConditionsTool", "StripSiliconConditionsTool", "Tool to retrieve SCT silicon information"};
  ToolHandle<ISiLorentzAngleTool> m_lorentzAngleTool{this, "LorentzAngleTool", "SiLorentzAngleTool/ITkStripLorentzAngleTool", "Tool to retreive Lorentz angle"};
 
  ServiceHandle<ITHistSvc> m_thistSvc{this, "THistSvc", "THistSvc"};
 
  SG::ReadCondHandleKey<AtlasFieldCacheCondObj> m_fieldCacheCondObjInputKey{
    this, "AtlasFieldCacheCondObj", "fieldCondObj", "Name of the Magnetic Field conditions object key"};
 
  float m_tHalfwayDrift{0.}; 
  float m_distInterStrip{1.0}; 
  float m_distHalfInterStrip{0.}; 
 
  bool m_SurfaceDriftFlag{false}; 
 
  // -- Histograms
  struct Hists {
    StatusCode book (ITHistSvc& histSvc);
    TProfile* m_h_efieldz{nullptr};
    TH1F* m_h_efield{nullptr};
    TH1F* m_h_spess{nullptr};
    TH1F* m_h_depD{nullptr};
    TH2F* m_h_drift_electrode{nullptr};
    TH1F* m_h_ztrap{nullptr};
    TH1F* m_h_drift_time{nullptr};
    TH1F* m_h_t_electrode{nullptr};
    TH1F* m_h_zhit{nullptr};
    TH1F* m_h_ztrap_tot{nullptr};
    TH1F* m_h_no_ztrap{nullptr};
    TH1F* m_h_trap_drift_t{nullptr};
    TH1F* m_h_notrap_drift_t{nullptr};
    TProfile* m_h_mob_Char{nullptr};
    TProfile* m_h_vel{nullptr};
    TProfile* m_h_drift1{nullptr};
    TProfile* m_h_gen{nullptr};
    TProfile* m_h_gen1{nullptr};
    TProfile* m_h_gen2{nullptr};
    TProfile* m_h_velocity_trap{nullptr};
    TProfile* m_h_mobility_trap{nullptr};
    TH1F* m_h_trap_pos{nullptr};
  };
  std::unique_ptr<Hists> m_h;
 
  // For Induced Charge Module, M.Togawa
  std::unique_ptr<InducedChargeModel> m_InducedChargeModel;
 
  Hists& getHists() const;
};
 
} // namespace ITk
 
#endif // STRIPSURFACECHARGESGENERATOR_H