Surface.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file Surface.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2016-2020 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Geometry/DetectorElementBase.hpp"
#include "Acts/Geometry/GeometryContext.hpp"
#include "Acts/Geometry/GeometryObject.hpp"
#include "Acts/Geometry/GeometryStatics.hpp"
#include "Acts/Geometry/Polyhedron.hpp"
#include "Acts/Surfaces/BoundaryCheck.hpp"
#include "Acts/Surfaces/SurfaceBounds.hpp"
#include "Acts/Surfaces/SurfaceError.hpp"
#include "Acts/Surfaces/detail/AlignmentHelper.hpp"
#include "Acts/Utilities/AlignmentDefinitions.hpp"
#include "Acts/Utilities/BinnedArray.hpp"
#include "Acts/Utilities/BinningType.hpp"
#include "Acts/Utilities/Definitions.hpp"
#include "Acts/Utilities/Intersection.hpp"
#include "Acts/Utilities/Result.hpp"

#include <memory>

namespace Acts {

class DetectorElementBase;
class SurfaceBounds;
class ISurfaceMaterial;
class Layer;
class TrackingVolume;
class IVisualization3D;

using SurfaceIntersection = ObjectIntersection<Surface>;

class Surface : public virtual GeometryObject,
                public std::enable_shared_from_this<Surface> {
 public:
  enum SurfaceType {
    Cone = 0,
    Cylinder = 1,
    Disc = 2,
    Perigee = 3,
    Plane = 4,
    Straw = 5,
    Curvilinear = 6,
    Other = 7
  };

 protected:
  Surface(const Transform3D& transform = Transform3D::Identity());

  Surface(const Surface& other);

  Surface(const DetectorElementBase& detelement);

  Surface(const GeometryContext& gctx, const Surface& other,
          const Transform3D& shift);

 public:
  virtual ~Surface();

  template <class T, typename... Args>
  static std::shared_ptr<T> makeShared(Args&&... args) {
    return std::shared_ptr<T>(new T(std::forward<Args>(args)...));
  }

  std::shared_ptr<Surface> getSharedPtr();

  std::shared_ptr<const Surface> getSharedPtr() const;

  Surface& operator=(const Surface& other);

  virtual bool operator==(const Surface& other) const;

  virtual bool operator!=(const Surface& sf) const;

 public:
  virtual SurfaceType type() const = 0;

  virtual const Transform3D& transform(const GeometryContext& gctx) const;

  virtual Vector3D center(const GeometryContext& gctx) const;

  virtual Vector3D normal(const GeometryContext& gctx,
                          const Vector2D& lposition) const = 0;


  virtual Vector3D normal(const GeometryContext& gctx,
                          const Vector3D& position) const;

  //
  virtual Vector3D normal(const GeometryContext& gctx) const {
    return normal(gctx, center(gctx));
  }

  virtual const SurfaceBounds& bounds() const = 0;

  const DetectorElementBase* associatedDetectorElement() const;

  const Layer* associatedLayer() const;

  void associateLayer(const Layer& lay);

  const ISurfaceMaterial* surfaceMaterial() const;

  const std::shared_ptr<const ISurfaceMaterial>& surfaceMaterialSharedPtr()
      const;

  void assignSurfaceMaterial(std::shared_ptr<const ISurfaceMaterial> material);

  bool isOnSurface(const GeometryContext& gctx, const Vector3D& position,
                   const Vector3D& momentum,
                   const BoundaryCheck& bcheck = true) const;

  virtual bool insideBounds(const Vector2D& lposition,
                            const BoundaryCheck& bcheck = true) const;

  virtual Vector3D localToGlobal(const GeometryContext& gctx,
                                 const Vector2D& lposition,
                                 const Vector3D& momentum) const = 0;

  virtual Result<Vector2D> globalToLocal(const GeometryContext& gctx,
                                         const Vector3D& position,
                                         const Vector3D& momentum) const = 0;

  virtual Acts::RotationMatrix3D referenceFrame(const GeometryContext& gctx,
                                                const Vector3D& position,
                                                const Vector3D& momentum) const;

  virtual void initJacobianToGlobal(const GeometryContext& gctx,
                                    BoundToFreeMatrix& jacobian,
                                    const Vector3D& position,
                                    const Vector3D& direction,
                                    const BoundVector& pars) const;

  virtual RotationMatrix3D initJacobianToLocal(const GeometryContext& gctx,
                                               FreeToBoundMatrix& jacobian,
                                               const Vector3D& position,
                                               const Vector3D& direction) const;

  virtual BoundRowVector derivativeFactors(
      const GeometryContext& gctx, const Vector3D& position,
      const Vector3D& direction, const RotationMatrix3D& rft,
      const BoundToFreeMatrix& jacobian) const;

  virtual double pathCorrection(const GeometryContext& gctx,
                                const Vector3D& position,
                                const Vector3D& direction) const = 0;

  virtual SurfaceIntersection intersect(const GeometryContext& gctx,
                                        const Vector3D& position,
                                        const Vector3D& direction,
                                        const BoundaryCheck& bcheck) const = 0;

  virtual std::ostream& toStream(const GeometryContext& gctx,
                                 std::ostream& sl) const;

  virtual std::string name() const = 0;

  virtual Polyhedron polyhedronRepresentation(const GeometryContext& gctx,
                                              size_t lseg) const = 0;

  AlignmentToBoundMatrix alignmentToBoundDerivative(
      const GeometryContext& gctx, const FreeVector& derivatives,
      const Vector3D& position, const Vector3D& direction) const;

  virtual AlignmentRowVector alignmentToPathDerivative(
      const GeometryContext& gctx, const RotationMatrix3D& rotToLocalZAxis,
      const Vector3D& position, const Vector3D& direction) const;

  virtual LocalCartesianToBoundLocalMatrix localCartesianToBoundLocalDerivative(
      const GeometryContext& gctx, const Vector3D& position) const = 0;

 protected:
  Transform3D m_transform = Transform3D::Identity();

  const DetectorElementBase* m_associatedDetElement{nullptr};

  const Layer* m_associatedLayer{nullptr};

  const TrackingVolume* m_associatedTrackingVolume{nullptr};

  std::shared_ptr<const ISurfaceMaterial> m_surfaceMaterial;
};

#include "Acts/Surfaces/detail/Surface.ipp"

}  // namespace Acts