FastCaloSimCaloExtrapolation.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef FastCaloSimCaloExtrapolation_H
#define FastCaloSimCaloExtrapolation_H
 
#include "CxxUtils/CachedPointer.h"
 
#include "ISF_FastCaloSimParametrization/IFastCaloSimGeometryHelper.h"
#include "ISF_FastCaloSimParametrization/IFastCaloSimCaloExtrapolation.h"
#include "ISF_FastCaloSimEvent/TFCSExtrapolationState.h"
#include "GeoPrimitives/GeoPrimitives.h"
 
 
#include "ISF_FastCaloSimParametrization/IFastCaloSimCaloTransportation.h"
 
class TFCSTruthState;
class G4FieldTrack;
 
 
struct CylinderIntersections
{
  Amg::Vector3D first;
  Amg::Vector3D second;
  unsigned int number = 0;
 
};
 
 
class FastCaloSimCaloExtrapolation: public extends<AthAlgTool, IFastCaloSimCaloExtrapolation>
{
 
public:
  
  FastCaloSimCaloExtrapolation(const std::string& t, const std::string& n, const IInterface* p);
  ~FastCaloSimCaloExtrapolation() = default;
 
  virtual StatusCode initialize() override final;
  virtual StatusCode finalize() override final;
 
  enum SUBPOS { 
    SUBPOS_MID = TFCSExtrapolationState::SUBPOS_MID, //MID=middle of calo layer
    SUBPOS_ENT = TFCSExtrapolationState::SUBPOS_ENT, //ENT=entrance of calo layer
    SUBPOS_EXT = TFCSExtrapolationState::SUBPOS_EXT  //EXT=exit of calo layer
  }; 
 
  enum HITPOSITION{
    INSIDE,  //hit position is inside cylinder bounds
    OUTSIDE, //hit position is outside cylinder bounds
    ON       //hit position is on cylinder bounds
  };
 
  virtual void extrapolate(TFCSExtrapolationState& result, const TFCSTruthState* truth, const std::vector<G4FieldTrack>& caloSteps) const override final;
  virtual void extrapolate(TFCSExtrapolationState& result, const TFCSTruthState* truth) const override final;
 
protected:
 
 const IFastCaloSimGeometryHelper* GetCaloGeometry() const {return &(*m_CaloGeometryHelper);};
  
  /*Main extrapolation methods*/

  bool extrapolateToCylinder(const std::vector<G4FieldTrack>& caloSteps, float cylR, float cylZ, Amg::Vector3D& extPos, Amg::Vector3D& momDir) const;
  void extrapolateToID(TFCSExtrapolationState& result, const std::vector<G4FieldTrack>& caloSteps, const TFCSTruthState* truth) const;
  void extrapolateToLayers(TFCSExtrapolationState& result, const std::vector<G4FieldTrack>& caloSteps, const TFCSTruthState* truth) const;
  
  /*Extrapolator helper methods*/

  void findPCA(float cylR, float cylZ, Amg::Vector3D& hitPos1, Amg::Vector3D& hitPos2, Amg::Vector3D& PCA) const;
  static double getPointLineSegmentDistance(Amg::Vector3D& point, Amg::Vector3D& hitPos1, Amg::Vector3D& hitPos2) ;
  void getIterativePCA(float cylR, float cylZ, Amg::Vector3D& BoundA, Amg::Vector3D& BoundB, Amg::Vector3D& PCA) const;
  static bool isOnSegment(Amg::Vector3D& point, Amg::Vector3D& hitPos1, Amg::Vector3D& hitPos2) ;
  static bool cylinderEndcapIntersection(float cylR, float cylZ, bool positiveEndcap, Amg::Vector3D& pointA, Amg::Vector3D& pointB, Amg::Vector3D& intersection) ;
  bool extrapolateWithIntersection(const std::vector<G4FieldTrack>& caloSteps, float cylR, float cylZ, Amg::Vector3D& extPos, Amg::Vector3D& momDir) const;
  bool extrapolateWithPCA(const std::vector<G4FieldTrack>& caloSteps, float cylR, float cylZ, Amg::Vector3D& extPos, Amg::Vector3D& momDir) const;
  static bool doesTravelThroughSurface(float cylR, float cylZ, Amg::Vector3D& hitPos1, Amg::Vector3D& hitPos2) ;
  int whichIntersection(float cylR, float cylZ, Amg::Vector3D& hitPos1, Amg::Vector3D& hitPos2, Amg::Vector3D& intersectionA, Amg::Vector3D intersectionB) const;
  int circleLineIntersection2D(float circR, Amg::Vector3D& pointA, Amg::Vector3D& pointB, Amg::Vector3D& intersectA, Amg::Vector3D& intersectB) const;
  int cylinderLineIntersection(float cylR, float cylZ, Amg::Vector3D& pointA, Amg::Vector3D& pointB, Amg::Vector3D& intersectA, Amg::Vector3D& intersectB) const;
  static enum HITPOSITION whereOnCylinder(float cylR, float cylZ, Amg::Vector3D& hitPos) ;
  static Amg::Vector3D projectOnCylinder(float cylR, float cylZ, Amg::Vector3D& hitPos) ;
  CylinderIntersections getCylinderIntersections(float cylR, float cylZ, Amg::Vector3D& hitPos1, Amg::Vector3D& hitPos2) const;
 
  //helper methods for calo geometry
  void   minmaxeta(int sample, double eta, double& mineta, double& maxeta) const;
  bool   isCaloBarrel(int sample) const;
  double deta (int sample, double eta) const;
  double rzmid(int sample, double eta) const;
  double rzent(int sample, double eta) const;
  double rzext(int sample, double eta) const;
  double rmid (int sample, double eta) const;
  double rent (int sample, double eta) const;
  double rext (int sample, double eta) const;
  double zmid (int sample, double eta) const;
  double zent (int sample, double eta) const;
  double zext (int sample, double eta) const;
  double rpos (int sample, double eta, int subpos = CaloSubPos::SUBPOS_MID) const;
  double zpos (int sample, double eta, int subpos = CaloSubPos::SUBPOS_MID) const;
  double rzpos(int sample, double eta, int subpos = CaloSubPos::SUBPOS_MID) const;
 
 
  //uniquely defined ID-Calo surfaces
  FloatArrayProperty m_CaloBoundaryR{this, "CaloBoundaryR", {1148.0,120.0,41.0}};
  FloatArrayProperty m_CaloBoundaryZ{this, "CaloBoundaryZ", {3550.0,4587.0,4587.0}};
 
  // FastCaloSim particle transport with ATLAS tracking tools
  PublicToolHandle<IFastCaloSimCaloTransportation> m_CaloTransportation{this, "CaloTransportation", "FastCaloSimCaloTransportation"};
  // FastCaloSim geometry helper
  PublicToolHandle<IFastCaloSimGeometryHelper> m_CaloGeometryHelper{this, "CaloGeometryHelper", "FastCaloSimGeometryHelper"};
 
};
 
#endif // FastCaloSimCaloExtrapolation_H