ActsPlugins/Json/SurfaceJsonConverter.hpp

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/Geometry/GeometryContext.hpp"
0013 #include "Acts/Surfaces/Surface.hpp"
0014 #include "ActsPlugins/Json/ActsJson.hpp"
0015 #include "ActsPlugins/Json/AlgebraJsonConverter.hpp"
0016 #include "ActsPlugins/Json/SurfaceBoundsJsonConverter.hpp"
0017
0018 #include <memory>
0019 #include <string>
0020 #include <tuple>
0021 #include <utility>
0022 #include <vector>
0023
0024 #include <nlohmann/json.hpp>
0025
0026 // Custom Json encoder/decoders. Naming is mandated by nlohmann::json and thus
0027 // can not match our naming guidelines.
0028 namespace Acts {
0029 class ISurfaceMaterial;
0030
0031 using SurfaceAndMaterialWithContext =
0032     std::tuple<std::shared_ptr<const Acts::Surface>,
0033                std::shared_ptr<const Acts::ISurfaceMaterial>,
0034                Acts::GeometryContext>;
0035
0036 /// Convert SurfaceAndMaterialWithContext to JSON
0037 /// @param j Destination JSON object
0038 /// @param surface Source SurfaceAndMaterialWithContext to convert
0039 void to_json(nlohmann::json& j, const SurfaceAndMaterialWithContext& surface);
0040
0041 /// Convert Surface to JSON
0042 /// @param j Destination JSON object
0043 /// @param surface Source Surface to convert
0044 /// @note it will take the default context
0045 void to_json(nlohmann::json& j, const Surface& surface);
0046
0047 /// Convert shared_ptr<Surface> to JSON
0048 /// @param j Destination JSON object
0049 /// @param surface Source shared_ptr<Surface> to convert
0050 /// @note it will take the default context
0051 void to_json(nlohmann::json& j, const std::shared_ptr<const Surface>& surface);
0052
0053 /// Contextual conversion of a surface
0054 ///
0055 /// @param j the json to be filled
0056 /// @param surface the surface to be converted
0057 /// @param gctx the geometry context for this
0058 void toJson(nlohmann::json& j, const std::shared_ptr<const Surface>& surface,
0059             const Acts::GeometryContext& gctx);
0060
0061 /// Conversion to Surface from jsonn
0062 ///
0063 /// @param j the read-in json object
0064 ///
0065 /// @return a shared_ptr to a surface object for type polymorphism
0066 std::shared_ptr<Surface> surfaceFromJson(const nlohmann::json& j);
0067
0068 /// Conversion to Surface from json in correct type
0069 ///
0070 /// The type is given as a template argument in order to be able
0071 /// to construct the correct fitting types for surfaces.
0072 ///
0073 /// @param j the read-in json object
0074 ///
0075 /// @return a shared_ptr to a typed surface object for type polymorphism
0076 template <typename surface_t, typename bounds_t>
0077 std::shared_ptr<surface_t> surfaceFromJsonT(const nlohmann::json& j) {
0078   nlohmann::json jTransform = j["transform"];
0079   Transform3 sTransform = Transform3JsonConverter::fromJson(jTransform);
0080   if constexpr (std::is_same_v<bounds_t, void>) {
0081     return Surface::makeShared<surface_t>(sTransform);
0082   } else {
0083     nlohmann::json jBounds = j["bounds"];
0084     auto sBounds = SurfaceBoundsJsonConverter::fromJson<bounds_t>(jBounds);
0085     return Surface::makeShared<surface_t>(sTransform, std::move(sBounds));
0086   }
0087 }
0088
0089 namespace SurfaceJsonConverter {
0090
0091 struct Options {
0092   // The way the transforms are written out
0093   Transform3JsonConverter::Options transformOptions =
0094       Transform3JsonConverter::Options{};
0095   // Write the material
0096   bool writeMaterial = true;
0097   // Write surface as a portal
0098   bool portal = false;
0099 };
0100
0101 /// Contextual conversion of a surface
0102 ///
0103 /// @param gctx the geometry context for this
0104 /// @param surface the surface to be converted
0105 /// @param options the writing options for the surfaces
0106 ///
0107 /// @return a json object representing the surface
0108 nlohmann::json toJson(const GeometryContext& gctx, const Surface& surface,
0109                       const Options& options = Options{});
0110
0111 /// Contextual conversion of a surface - Detray export
0112 ///
0113 /// @param gctx the geometry context for this
0114 /// @param surface the surface to be converted
0115 /// @param options the writing options for the surfaces
0116 ///
0117 /// @note reading back detray json is not supported and will fail
0118 ///
0119 /// @return a json object representing the surface
0120 nlohmann::json toJsonDetray(const GeometryContext& gctx, const Surface& surface,
0121                             const Options& options = Options{});
0122
0123 /// @brief The Surface converter from json
0124 ///
0125 /// @param jSurface the surface json object
0126 ///
0127 /// @return a shared object created from json input
0128 std::shared_ptr<Surface> fromJson(const nlohmann::json& jSurface);
0129
0130 }  // namespace SurfaceJsonConverter
0131
0132 // This macro create a conversion for the surface type
0133 NLOHMANN_JSON_SERIALIZE_ENUM(
0134     Surface::SurfaceType,
0135     {{Surface::SurfaceType::Cone, "ConeSurface"},
0136      {Surface::SurfaceType::Cylinder, "CylinderSurface"},
0137      {Surface::SurfaceType::Disc, "DiscSurface"},
0138      {Surface::SurfaceType::Perigee, "PerigeeSurface"},
0139      {Surface::SurfaceType::Plane, "PlaneSurface"},
0140      {Surface::SurfaceType::Straw, "StrawSurface"},
0141      {Surface::SurfaceType::Curvilinear, "CurvilinearSurface"},
0142      {Surface::SurfaceType::Other, "Other"}})
0143
0144 }  // namespace Acts