PlaneSurface.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file PlaneSurface.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/Definitions/Algebra.hpp"
#include "Acts/Definitions/Tolerance.hpp"
#include "Acts/Geometry/GeometryContext.hpp"
#include "Acts/Geometry/Polyhedron.hpp"
#include "Acts/Surfaces/BoundaryCheck.hpp"
#include "Acts/Surfaces/InfiniteBounds.hpp"
#include "Acts/Surfaces/PlanarBounds.hpp"
#include "Acts/Surfaces/Surface.hpp"
#include "Acts/Utilities/BinningType.hpp"
#include "Acts/Utilities/Result.hpp"

#include <cstddef>
#include <limits>
#include <memory>
#include <string>

namespace Acts {

class DetectorElementBase;
class PlanarBounds;
class SurfaceBounds;

class PlaneSurface : public Surface {
#ifndef DOXYGEN
  friend Surface;
#endif

 protected:
  PlaneSurface(const PlaneSurface& other);

  PlaneSurface(const GeometryContext& gctx, const PlaneSurface& other,
               const Transform3& transform);

  PlaneSurface(const Vector3& center, const Vector3& normal);

  PlaneSurface(std::shared_ptr<const PlanarBounds> pbounds,
               const DetectorElementBase& detelement);

  PlaneSurface(const Transform3& transform,
               std::shared_ptr<const PlanarBounds> pbounds = nullptr);

 public:
  ~PlaneSurface() override = default;
  PlaneSurface() = delete;

  PlaneSurface& operator=(const PlaneSurface& other);

  Vector3 normal(const GeometryContext& gctx,
                 const Vector2& lposition) const final;

  using Surface::normal;

  Vector3 binningPosition(const GeometryContext& gctx,
                          BinningValue bValue) const final;

  SurfaceType type() const override;

  const SurfaceBounds& bounds() const override;

  Vector3 localToGlobal(const GeometryContext& gctx, const Vector2& lposition,
                        const Vector3& direction) const override;

  Result<Vector2> globalToLocal(
      const GeometryContext& gctx, const Vector3& position,
      const Vector3& direction,
      double tolerance = s_onSurfaceTolerance) const override;

  double pathCorrection(const GeometryContext& gctx, const Vector3& position,
                        const Vector3& direction) const final;

  SurfaceMultiIntersection intersect(
      const GeometryContext& gctx, const Vector3& position,
      const Vector3& direction, const BoundaryCheck& bcheck = false,
      ActsScalar tolerance = s_onSurfaceTolerance) const final;

  Polyhedron polyhedronRepresentation(const GeometryContext& gctx,
                                      size_t lseg) const override;

  std::string name() const override;

  ActsMatrix<2, 3> localCartesianToBoundLocalDerivative(
      const GeometryContext& gctx, const Vector3& position) const final;

 protected:
  std::shared_ptr<const PlanarBounds> m_bounds;

 private:
};

}  // end of namespace Acts