Navigator.h

Go to the documentation of this file.

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

// Navigator.h, (c) ATLAS Detector software
 
#ifndef TRKEXTOOLS_NAVIGATOR_H
#define TRKEXTOOLS_NAVIGATOR_H
 
// Gaudi
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ServiceHandle.h"
// Trk
#include "TrkExInterfaces/INavigator.h"
#include "TrkEventPrimitives/PropDirection.h"
#include "TrkEventPrimitives/ParticleHypothesis.h"
#include "TrkVolumes/BoundarySurface.h"
#include "TrkGeometry/MagneticFieldProperties.h"
#include "TrkParameters/TrackParameters.h"
#include "StoreGate/ReadCondHandleKey.h"
#include "TrkGeometry/TrackingGeometry.h"
#include "TrkDetDescrInterfaces/ITrackingGeometrySvc.h"
 
#include <cstring>
#include <Gaudi/Accumulators.h>
 
namespace Trk {
 
  class IGeometryBuilder;
  class IPropagator;
  class Surface;
  class Track;
  class TrackingVolume;
  typedef std::pair<const NavigationCell*,const NavigationCell*> NavigationPair;

 
  class Navigator final : public AthAlgTool, virtual public INavigator {
   public:
    Navigator(const std::string&, const std::string&, const IInterface*);
    virtual ~Navigator() = default;

    virtual StatusCode initialize() override;

    virtual const TrackingGeometry* trackingGeometry(
        const EventContext& ctx) const override final;

    virtual const TrackingVolume* volume(
        const EventContext& ctx, const Amg::Vector3D& gp) const override final;

    virtual const TrackingVolume* highestVolume(
        const EventContext& ctx) const override final;

    virtual const TrackParameters* closestParameters(
        const Track& trk, const Surface& sf) const override final;

    virtual bool atVolumeBoundary(const Trk::TrackParameters* parms,
                                  const Trk::TrackingVolume* vol,
                                  Trk::PropDirection dir,
                                  const Trk::TrackingVolume*& nextVol,
                                  double tol) const override final;

    virtual const BoundarySurface<TrackingVolume>* nextBoundarySurface(
        const EventContext& ctx, const IPropagator& prop,
        const TrackParameters& parms, PropDirection dir) const override final;

    virtual const BoundarySurface<TrackingVolume>* nextBoundarySurface(
        const EventContext& ctx, const IPropagator& prop,
        const TrackParameters& parms, PropDirection dir,
        const TrackingVolume& vol) const override final;

    virtual NavigationCell nextTrackingVolume(
        const EventContext& ctx, const IPropagator& prop,
        const TrackParameters& parms, PropDirection dir,
        const TrackingVolume& vol) const override final;
 
   private:
    SG::ReadCondHandleKey<TrackingGeometry> m_trackingGeometryReadKey{
        this, "TrackingGeometryKey", "AtlasTrackingGeometry",
        "Key of output of TrackingGeometry for ID"};

    ServiceHandle<Trk::ITrackingGeometrySvc> m_trackingGeometrySvc{
        this, "TrackingGeometrySvc", ""};

    std::string m_trackingGeometryName = "AtlasTrackingGeometry";
 
    /******************************************************************/
    DoubleProperty m_insideVolumeTolerance{
      this, "InsideVolumeTolerance", 1. * Gaudi::Units::mm,
      "Tolerance for inside() method of Volumes"};
    DoubleProperty m_isOnSurfaceTolerance{
      this, "IsOnSurfaceTolerance", 0.005 * Gaudi::Units::mm,
      "Tolerance for isOnSurface() method of BoundarySurfaces"};
    bool m_useConditions{};
    Trk::MagneticFieldProperties m_fieldProperties;
    BooleanProperty m_useStraightLineApproximation{
      this, "UseStraightLineApproximation", false,
      "use the straight line approximation for the next boundary sf"};

    BooleanProperty m_searchWithDistance{
      this, "SearchWithDistanceToSurface", true,
      "search with new distanceToSurface() method"};
    BooleanProperty m_fastField{this, "MagneticFieldProperties", false};
  };
 
} // end of namespace
 
 
#endif // TRKEXTOOLS_NAVIGATOR_H