SurfaceJsonConverter.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2021-2023 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/Geometry/GeometryContext.hpp"
#include "Acts/Plugins/Json/ActsJson.hpp"
#include "Acts/Plugins/Json/AlgebraJsonConverter.hpp"
#include "Acts/Plugins/Json/SurfaceBoundsJsonConverter.hpp"
#include "Acts/Surfaces/Surface.hpp"

#include <memory>
#include <string>
#include <tuple>
#include <utility>
#include <vector>

#include <nlohmann/json.hpp>

// Custom Json encoder/decoders. Naming is mandated by nlohmann::json and thus
// can not match our naming guidelines.
namespace Acts {
class ISurfaceMaterial;

using SurfaceAndMaterialWithContext =
    std::tuple<std::shared_ptr<const Acts::Surface>,
               std::shared_ptr<const Acts::ISurfaceMaterial>,
               Acts::GeometryContext>;

void to_json(nlohmann::json& j, const SurfaceAndMaterialWithContext& surface);

void to_json(nlohmann::json& j, const Surface& surface);

void to_json(nlohmann::json& j, const std::shared_ptr<const Surface>& surface);

void toJson(nlohmann::json& j, const std::shared_ptr<const Surface>& surface,
            const Acts::GeometryContext& gctx);

std::shared_ptr<Surface> surfaceFromJson(const nlohmann::json& j);

template <typename surface_t, typename bounds_t>
std::shared_ptr<surface_t> surfaceFromJsonT(const nlohmann::json& j) {
  nlohmann::json jTransform = j["transform"];
  Transform3 sTransform = Transform3JsonConverter::fromJson(jTransform);
  if constexpr (std::is_same_v<bounds_t, void>) {
    return Surface::makeShared<surface_t>(sTransform);
  } else {
    nlohmann::json jBounds = j["bounds"];
    auto sBounds = SurfaceBoundsJsonConverter::fromJson<bounds_t>(jBounds);
    return Surface::makeShared<surface_t>(sTransform, std::move(sBounds));
  }
}

namespace SurfaceJsonConverter {

struct Options {
  // The way the transforms are written out
  Transform3JsonConverter::Options transformOptions =
      Transform3JsonConverter::Options{};
  // Write the material
  bool writeMaterial = true;
  // Write surface as a portal
  bool portal = false;
};

nlohmann::json toJson(const GeometryContext& gctx, const Surface& surface,
                      const Options& options = Options{});

nlohmann::json toJsonDetray(const GeometryContext& gctx, const Surface& surface,
                            const Options& options = Options{});

std::shared_ptr<Surface> fromJson(const nlohmann::json& jSurface);

}  // namespace SurfaceJsonConverter

// This macro create a conversion for the surface type
NLOHMANN_JSON_SERIALIZE_ENUM(
    Surface::SurfaceType,
    {{Surface::SurfaceType::Cone, "ConeSurface"},
     {Surface::SurfaceType::Cylinder, "CylinderSurface"},
     {Surface::SurfaceType::Disc, "DiscSurface"},
     {Surface::SurfaceType::Perigee, "PerigeeSurface"},
     {Surface::SurfaceType::Plane, "PlaneSurface"},
     {Surface::SurfaceType::Straw, "StrawSurface"},
     {Surface::SurfaceType::Curvilinear, "CurvilinearSurface"},
     {Surface::SurfaceType::Other, "Other"}})

}  // namespace Acts