EIC code displayed by LXR |
|
|
|
|||
File indexing completed on 2026-08-29 08:16:49
0001 // This file is part of the ACTS project. 0002 // 0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project 0004 // 0005 // This Source Code Form is subject to the terms of the Mozilla Public 0006 // License, v. 2.0. If a copy of the MPL was not distributed with this 0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/. 0008 0009 #pragma once 0010 0011 #include "Acts/Definitions/Algebra.hpp" 0012 #include "Acts/Definitions/Alignment.hpp" 0013 #include "Acts/Definitions/Tolerance.hpp" 0014 #include "Acts/Geometry/GeometryContext.hpp" 0015 #include "Acts/Geometry/Polyhedron.hpp" 0016 #include "Acts/Surfaces/BoundaryTolerance.hpp" 0017 #include "Acts/Surfaces/CylinderBounds.hpp" 0018 #include "Acts/Surfaces/RegularSurface.hpp" 0019 #include "Acts/Surfaces/Surface.hpp" 0020 #include "Acts/Surfaces/SurfaceConcept.hpp" 0021 #include "Acts/Utilities/AxisDefinitions.hpp" 0022 #include "Acts/Utilities/Logger.hpp" 0023 #include "Acts/Utilities/Result.hpp" 0024 #include "Acts/Utilities/detail/RealQuadraticEquation.hpp" 0025 0026 #include <memory> 0027 #include <numbers> 0028 #include <string> 0029 0030 namespace Acts { 0031 0032 /// @class CylinderSurface 0033 /// 0034 /// Class for a CylinderSurface in the TrackingGeometry. 0035 /// It inherits from Surface. 0036 /// 0037 /// The cylinder surface has a special role in the TrackingGeometry, 0038 /// since it builds the surfaces of all TrackingVolumes at container level 0039 /// for a cylindrical tracking geometry. 0040 /// 0041 /// @image html CylinderSurface.png 0042 0043 class CylinderSurface : public RegularSurface { 0044 friend class Surface; 0045 0046 protected: 0047 /// Constructor from Transform3 and CylinderBounds 0048 /// 0049 /// @param transform The transform to position the surface 0050 /// @param radius The radius of the cylinder 0051 /// @param halfz The half length in z 0052 /// @param halfphi The half opening angle 0053 /// @param avphi The phi value from which the opening angle spans (both sides) 0054 /// @param bevelMinZ (optional) The bevel on the negative z side 0055 /// @param bevelMaxZ (optional) The bevel on the positive z sid The bevel on the positive z side 0056 CylinderSurface(const Transform3& transform, double radius, double halfz, 0057 double halfphi = std::numbers::pi, double avphi = 0., 0058 double bevelMinZ = 0., double bevelMaxZ = 0.); 0059 0060 /// Constructor from Transform3 and CylinderBounds arguments 0061 /// 0062 /// @param transform The transform to position the surface 0063 /// @param cbounds is a shared pointer to a cylindeer bounds object, 0064 /// it must exist (assert test) 0065 CylinderSurface(const Transform3& transform, 0066 std::shared_ptr<const CylinderBounds> cbounds); 0067 0068 /// Constructor from SurfacePlacementBase: Element proxy 0069 /// 0070 /// @param cbounds are the provided cylinder bounds (shared) 0071 /// @param placement Reference to the surface placement 0072 /// @note The Surface does not take any ownership over the 0073 /// `SurfacePlacementBase` it is expected that the user 0074 /// ensures the life-time of the `SurfacePlacementBase` 0075 /// and that the `Surface` is actually owned by 0076 /// the `SurfacePlacementBase` instance 0077 CylinderSurface(std::shared_ptr<const CylinderBounds> cbounds, 0078 const SurfacePlacementBase& placement); 0079 0080 /// Copy constructor 0081 /// 0082 /// @param other is the source cylinder for the copy 0083 CylinderSurface(const CylinderSurface& other); 0084 0085 /// Copy constructor - with shift 0086 /// 0087 /// @param gctx The current geometry context object, e.g. alignment 0088 /// @param other is the source cone surface 0089 /// @param shift is the additional transform applied after copying 0090 CylinderSurface(const GeometryContext& gctx, const CylinderSurface& other, 0091 const Transform3& shift); 0092 0093 public: 0094 ~CylinderSurface() override = default; 0095 0096 /// Assignment operator 0097 /// 0098 /// @param other is the source cylinder for the copy 0099 /// @return Reference to this CylinderSurface after assignment 0100 CylinderSurface& operator=(const CylinderSurface& other); 0101 0102 /// The binning position method - is overloaded for r-type binning 0103 /// 0104 /// @param gctx The current geometry context object, e.g. alignment 0105 /// @param aDir is the axis Direction of global binning to be done 0106 /// 0107 /// @return is the global position to be used for binning 0108 Vector3 referencePosition(const GeometryContext& gctx, 0109 AxisDirection aDir) const final; 0110 0111 /// Return the measurement frame - this is needed for alignment, in particular 0112 /// The measurement frame of a cylinder is the tangential plane at a given 0113 /// position 0114 /// 0115 /// @param gctx The current geometry context object, e.g. alignment 0116 /// @param position is the position where the measurement frame is defined 0117 /// @param direction is the momentum direction vector (ignored) 0118 /// @return rotation matrix that defines the measurement frame 0119 RotationMatrix3 referenceFrame(const GeometryContext& gctx, 0120 const Vector3& position, 0121 const Vector3& direction) const final; 0122 0123 /// Return the surface type 0124 /// @return Surface type identifier 0125 SurfaceType type() const override; 0126 0127 /// Return method for surface normal information 0128 /// @note for a Cylinder a local position is always required for the normal 0129 /// vector 0130 /// 0131 /// @param gctx The current geometry context object, e.g. alignment 0132 /// @param lposition is the local position for which the normal vector is 0133 /// requested 0134 /// 0135 /// @return normal vector at the local position by value 0136 Vector3 normal(const GeometryContext& gctx, 0137 const Vector2& lposition) const final; 0138 0139 /// Return method for surface normal information 0140 /// @note for a Cylinder a local position is always required for the normal 0141 /// vector 0142 /// 0143 /// @param gctx The current geometry context object, e.g. alignment 0144 /// @param position is the global position for which the normal vector is 0145 /// requested 0146 /// 0147 /// @return normal vector at the global position by value 0148 Vector3 normal(const GeometryContext& gctx, 0149 const Vector3& position) const final; 0150 0151 // Use overloads from `RegularSurface` 0152 using RegularSurface::globalToLocal; 0153 using RegularSurface::localToGlobal; 0154 using RegularSurface::normal; 0155 0156 /// Return method for the rotational symmetry axis 0157 /// 0158 /// @param gctx The current geometry context object, e.g. alignment 0159 /// 0160 /// @return the z-Axis of transform 0161 virtual Vector3 rotSymmetryAxis(const GeometryContext& gctx) const; 0162 0163 /// This method returns the CylinderBounds by reference 0164 /// @return Reference to the cylinder bounds 0165 const CylinderBounds& bounds() const final; 0166 0167 /// This method returns the shared_ptr to the CylinderBounds 0168 /// @return Shared pointer to the cylinder bounds 0169 const std::shared_ptr<const CylinderBounds>& boundsPtr() const; 0170 0171 /// Overwrite the existing surface bounds with new ones 0172 /// @param newBounds: Pointer to the new bounds 0173 void assignSurfaceBounds(std::shared_ptr<const CylinderBounds> newBounds); 0174 0175 /// Local to global transformation 0176 /// 0177 /// @param gctx The current geometry context object, e.g. alignment 0178 /// @param lposition is the local position to be transformed 0179 /// 0180 /// @return The global position by value 0181 Vector3 localToGlobal(const GeometryContext& gctx, 0182 const Vector2& lposition) const final; 0183 0184 /// Global to local transformation 0185 /// 0186 /// @param gctx The current geometry context object, e.g. alignment 0187 /// @param position is the global position to be transformed 0188 /// @param tolerance optional tolerance within which a point is considered 0189 /// valid on surface 0190 /// 0191 /// @return a Result<Vector2> which can be !ok() if the operation fails 0192 Result<Vector2> globalToLocal( 0193 const GeometryContext& gctx, const Vector3& position, 0194 double tolerance = s_onSurfaceTolerance) const final; 0195 0196 /// Straight line intersection schema from position/direction 0197 /// 0198 /// @param gctx The current geometry context object, e.g. alignment 0199 /// @param position The position to start from 0200 /// @param direction The direction at start 0201 /// @param boundaryTolerance the Boundary Check Tolerance 0202 /// @param tolerance the tolerance used for the intersection 0203 /// 0204 /// If possible returns both solutions for the cylinder 0205 /// 0206 /// @return SurfaceIntersection object (contains intersection & surface) 0207 MultiIntersection3D intersect( 0208 const GeometryContext& gctx, const Vector3& position, 0209 const Vector3& direction, 0210 const BoundaryTolerance& boundaryTolerance = 0211 BoundaryTolerance::Infinite(), 0212 double tolerance = s_onSurfaceTolerance) const final; 0213 0214 /// Path correction due to incident of the track 0215 /// 0216 /// @param gctx The current geometry context object, e.g. alignment 0217 /// @param position is the global position as a starting point 0218 /// @param direction is the global momentum direction at the starting point 0219 /// 0220 /// @return is the correction factor due to incident 0221 double pathCorrection(const GeometryContext& gctx, const Vector3& position, 0222 const Vector3& direction) const final; 0223 0224 /// Return method for properly formatted output string 0225 /// @return String representation of the class name 0226 std::string name() const override; 0227 0228 /// Return a Polyhedron for a cylinder 0229 /// 0230 /// This method represents the cylinder as a polyhedron with a given number 0231 /// of segments to represent a quarter of a full circle. The polyedron will 0232 /// consist of the vertices of the cylinder on both sides, and faces between 0233 /// them, both as rectangular faces and as triangular faces. 0234 /// 0235 /// @param gctx The current geometry context object, e.g. alignment 0236 /// @param quarterSegments The number of segments to approximate a quarter of the 0237 /// full circle; it's chosen to be 1, only the extrema points (-pi, -0.5pi, 0238 /// 0., 0.5pi) are inserted to capture the correct extent in the x-y plane 0239 /// 0240 /// @return A list of vertices and a face/facett description of it 0241 Polyhedron polyhedronRepresentation( 0242 const GeometryContext& gctx, 0243 unsigned int quarterSegments = 2u) const override; 0244 0245 /// Calculate the derivative of path length at the geometry constraint or 0246 /// point-of-closest-approach w.r.t. alignment parameters of the surface (i.e. 0247 /// local frame origin in global 3D Cartesian coordinates and its rotation 0248 /// represented with extrinsic Euler angles) 0249 /// 0250 /// @param gctx The current geometry context object, e.g. alignment 0251 /// @param position global 3D position 0252 /// @param direction global 3D momentum direction 0253 /// 0254 /// @return Derivative of path length w.r.t. the alignment parameters 0255 AlignmentToPathMatrix alignmentToPathDerivative( 0256 const GeometryContext& gctx, const Vector3& position, 0257 const Vector3& direction) const final; 0258 0259 /// Calculate the derivative of bound track parameters local position w.r.t. 0260 /// position in local 3D Cartesian coordinates 0261 /// 0262 /// @param gctx The current geometry context object, e.g. alignment 0263 /// @param position The position of the parameters in global 0264 /// 0265 /// @return Derivative of bound local position w.r.t. position in local 3D 0266 /// cartesian coordinates 0267 Matrix<2, 3> localCartesianToBoundLocalDerivative( 0268 const GeometryContext& gctx, const Vector3& position) const final; 0269 0270 /// Merge two cylinder surfaces into a single one. 0271 /// @image html Cylinder_Merging.svg 0272 /// @note The surfaces need to be *compatible*, i.e. have cylinder bounds 0273 /// that align, and have the same radius 0274 /// @param other The other cylinder surface to merge with 0275 /// @param direction The axis direction: either @c AxisZ or @c AxisRPhi 0276 /// @param externalRotation If true, any phi rotation is done in the transform 0277 /// @param logger The logger to use 0278 /// @return The merged cylinder surface and a boolean indicating if surfaces are reversed 0279 /// @note The returned boolean is `false` if `this` is *left* or 0280 /// *counter-clockwise* of @p other, and `true` if not. 0281 std::pair<std::shared_ptr<CylinderSurface>, bool> mergedWith( 0282 const CylinderSurface& other, AxisDirection direction, 0283 bool externalRotation, const Logger& logger = getDummyLogger()) const; 0284 0285 /// @copydoc Surface::assignSurfaceMaterial 0286 void assignSurfaceMaterial( 0287 std::shared_ptr<const ISurfaceMaterial> material) override; 0288 0289 protected: 0290 std::shared_ptr<const CylinderBounds> m_bounds; //!< bounds (shared) 0291 0292 /// @copydoc Surface::localAxes 0293 std::array<AxisDirection, 2> localAxes() const override { 0294 return {AxisDirection::AxisRPhi, AxisDirection::AxisZ}; 0295 } 0296 0297 /// @copydoc Surface::transformSurfaceLocalToMaterialLocal 0298 Vector2 transformSurfaceLocalToMaterialLocal( 0299 const Vector2& surfaceLocal) const override; 0300 0301 private: 0302 bool m_scaleMaterialAxis = false; 0303 0304 /// Implementation of the intersection solver 0305 /// 0306 /// <b>mathematical motivation:</b> 0307 /// 0308 /// The cylinder is given by : 0309 /// - cylinder center: ccenter (C) 0310 /// - the direction of the cylinder axis: cdirection (DZ) 0311 /// - the radius r 0312 /// The line is given by : 0313 /// - a reference position : lposition (L0) 0314 /// - the line direction: ldirection (DL) 0315 /// the parametric form for the line is then : L(t) = L0 + t * DL 0316 /// 0317 /// Any point P on infinite cylinder if : 0318 /// ((P - C) x DZ)^2 = r^2 * DZ^2 0319 /// We know that DZ is a unit vector: 0320 /// DZ^2 == 1 0321 /// When expanded with the line equation, this is : 0322 /// ((L0 - C) x DZ + t * (DL x DZ))^2 = r^2 * DZ^2 0323 /// which is a quadratic equation in the form (X + t * Y)^2 = d, where : 0324 /// X = (L0 - C) x DZ 0325 /// Y = DL x DZ 0326 /// d = r^2 * (DZ)^2 0327 /// Now, expand the equation : 0328 /// t^2 * (Y . Y) + t * (2 * (X . Y)) + (X . X) - d = 0 0329 /// => second order equation in the form : a*t^2 + b*t + c = 0 where 0330 /// a = (Y . Y) 0331 /// b = 2 * (X . Y) 0332 /// c = (X . X) - d 0333 /// finally solve the second order equation : a*t^2 + b*t + c = 0 0334 /// reinsertion into the line equation. 0335 /// 0336 /// @return the quadratic equation 0337 detail::RealQuadraticEquation intersectionSolver( 0338 const Transform3& transform, const Vector3& position, 0339 const Vector3& direction) const; 0340 }; 0341 0342 static_assert(RegularSurfaceConcept<CylinderSurface>, 0343 "CylinderSurface does not fulfill RegularSurfaceConcept"); 0344 0345 } // namespace Acts
| [ Source navigation ] | [ Diff markup ] | [ Identifier search ] | [ general search ] |
|
This page was automatically generated by the 2.3.7 LXR engine. The LXR team |
|