Detailed Description

JSON (de)serialization of geometry, material and configuration.

The file format written by the material converters is documented in Legacy material map JSON format.

The Material map schema describes the versioned material format handled by Acts::TrackingGeometryMaterialJsonConverter. Legacy material converters are deprecated and retain the previous format.

Namespaces
namespace	Acts::DetrayJsonHelper

Classes
class	Acts::GeometryHierarchyMapJsonConverter< value_t, decorator_t >
	Convert a geometry hierarchy map to/from Json. More...
class	Acts::ITrackingGeometryJsonDecorator
	helper class to add extra information to surface or volume json objects More...
class	Acts::IVolumeMaterialJsonDecorator
	helper class to add extra information to surface or volume json objects More...
class	Acts::JsonDetectorElement
	A implementation of a detector element, that is constructed from a JSON description of a surface. More...
struct	Acts::jsonKey
	store in a single place the different key used for the material mapping More...
class	Acts::JsonMaterialDecorator
	Material decorator from Json format. More...
class	Acts::MaterialMapJsonConverter
	read the material from Json More...
struct	Acts::missing_specialization< T, decorator_t >
class	Acts::SurfaceJsonConverter
	Static class performing JSON conversion of the surfaces. More...
struct	Acts::SurfaceJsonConverter::Config
	Configuration struct. More...
struct	Acts::SurfaceJsonConverter::Options
	Options for surface conversion. More...
class	Acts::SurfaceMaterialJsonConverter
	Static class performing the JSON conversion of surface material. More...
class	Acts::TrackingGeometryJsonConverter
	Converter for tracking geometry JSON payloads. More...

Typedefs
using	Acts::ConfigPair
	Type alias for a pair of detector configuration and ambiguity resolution configuration.
using	Acts::DetectorConfig = ScoreBasedAmbiguityResolution::DetectorConfig
	Type alias for detector-specific ambiguity resolution configuration.
using	Acts::SurfaceAndMaterialWithContext
	A tuple containing a surface, its associated material, and geometry context.
using	Acts::SurfaceJsonConverter::SurfaceBoundsDecoder
	Decoder type for the surface bounds.
using	Acts::SurfaceJsonConverter::SurfaceBoundsEncoder = TypeDispatcher<SurfaceBounds, nlohmann::json()>
	Encoder type for the surface bounds.
using	Acts::SurfaceJsonConverter::SurfaceDecoder
	Decoder type for the surfaces.
using	Acts::SurfaceJsonConverter::SurfaceEncoder
	Encoder type for the surfaces.
using	Acts::surfaceMaterialPointer = const Acts::ISurfaceMaterial*
	Pointer to a constant surface material object.
using	Acts::TrackingVolumeAndMaterial
	A pair containing a tracking volume and its associated material.
using	Acts::volumeMaterialPointer = const Acts::IVolumeMaterial*
	Pointer to a constant volume material object.

Functions
	Acts::SurfaceJsonConverter::SurfaceJsonConverter ()=delete
	Delete the default constructor as the class is purely static (for now).
std::size_t	Acts::DetrayJsonHelper::accelerationLink (std::span< const AxisDirection > casts)
	Determine the acceleration link from a grid.
template<class T, class decorator_t>
void	Acts::decorateJson (const decorator_t *decorator, const T &src, nlohmann::json &dest)
	Decorate JSON with additional information from the decorator.
template<class T, class decorator_t>
void	Acts::decorateJson (const decorator_t decorator, const T src, nlohmann::json &dest)
	Decorate JSON with additional information from the decorator (pointer version).
static Config	Acts::SurfaceJsonConverter::Config::defaultConfig ()
	Default configuration construction.
void	Acts::Experimental::from_json (const nlohmann::json &j, GbtsLayerConfig &layer)
	Convert JSON to GbtsLayerConfig.
void	Acts::Experimental::from_json (const nlohmann::json &j, GbtsLayerConnection &connection)
	Convert JSON to GbtsLayerConnection.
void	Acts::Experimental::from_json (const nlohmann::json &j, GbtsTauBounds &bounds)
	Convert JSON to GbtsTauBounds.
void	Acts::from_json (const nlohmann::json &j, BinningData &bd)
	Convert JSON to BinningData.
void	Acts::from_json (const nlohmann::json &j, BinUtility &bu)
	Convert JSON to BinUtility.
void	Acts::from_json (const nlohmann::json &j, BroadTripletSeedFilter::Config &config)
	Convert JSON to BroadTripletSeedFilter::Config.
void	Acts::from_json (const nlohmann::json &j, ConfigPair &p)
	Convert JSON to ConfigPair.
void	Acts::from_json (const nlohmann::json &j, CylindricalSpacePointGrid::Config &config)
	Convert JSON to CylindricalSpacePointGrid::Config.
void	Acts::from_json (const nlohmann::json &j, Direction &direction)
	Convert JSON to Direction.
void	Acts::from_json (const nlohmann::json &j, DoubletSeedFinder::Config &config)
	Convert JSON to DoubletSeedFinder::Config.
void	Acts::from_json (const nlohmann::json &j, DoubletSeedFinder::DerivedConfig &config)
	Convert JSON to DoubletSeedFinder::DerivedConfig.
void	Acts::from_json (const nlohmann::json &j, Extent &e)
	Convert JSON to Extent.
void	Acts::from_json (const nlohmann::json &j, ExtentEnvelope &e)
	Convert JSON to ExtentEnvelope.
void	Acts::from_json (const nlohmann::json &j, GeometryIdentifier &geoId)
	Read from JSON.
void	Acts::from_json (const nlohmann::json &j, Material &t)
	Convert JSON to Material.
void	Acts::from_json (const nlohmann::json &j, MaterialSlab &t)
	Convert JSON to MaterialSlab.
void	Acts::from_json (const nlohmann::json &j, MaterialSlabMatrix &t)
	Convert JSON to MaterialSlabMatrix.
void	Acts::from_json (const nlohmann::json &j, PolynomialBetheHeitlerApprox::PolyData &data)
	Deserialize polynomial component data from JSON.
void	Acts::from_json (const nlohmann::json &j, PolynomialBetheHeitlerApprox::RangeData &data)
	Deserialize a single x/x0 range with its data from JSON.
template<typename Type>
void	Acts::from_json (const nlohmann::json &j, Range1D< Type > &r)
	Convert JSON to Range1D.
void	Acts::from_json (const nlohmann::json &j, SeedConfirmationRangeConfig &config)
	Convert JSON to SeedConfirmationRangeConfig.
void	Acts::from_json (const nlohmann::json &j, surfaceMaterialPointer &material)
	Convert JSON to surfaceMaterialPointer.
void	Acts::from_json (const nlohmann::json &j, Transform3 &t)
	Convert JSON to Transform3.
void	Acts::from_json (const nlohmann::json &j, TripletSeedFinder::Config &config)
	Convert JSON to TripletSeedFinder::Config.
void	Acts::from_json (const nlohmann::json &j, TripletSeedFinder::DerivedConfig &config)
	Convert JSON to TripletSeedFinder::DerivedConfig.
void	Acts::from_json (const nlohmann::json &j, volumeMaterialPointer &material)
	Convert JSON to volumeMaterialPointer.
AxisSpec	Acts::AxisSpecJsonConverter::fromJson (const nlohmann::json &j)
	Create an AxisSpec from a json object.
Container	Acts::GeometryHierarchyMapJsonConverter< value_t, decorator_t >::fromJson (const nlohmann::json &encoded) const
	Decode a Json object into a geometry hierarchy map.
MultiAxisSpec	Acts::MultiAxisSpecJsonConverter::fromJson (const nlohmann::json &j)
	Create a MultiAxisSpec from a json object.
Acts::ProtoAxis	Acts::ProtoAxisJsonConverter::fromJson (const nlohmann::json &j)
	Create a ProtoAxis from a json object.
static std::shared_ptr< Surface >	Acts::SurfaceJsonConverter::fromJson (const nlohmann::json &jSurface)
	The Surface converter from json.
PolynomialBetheHeitlerApprox	Acts::loadBetheHeitlerApproxFromJson (const std::string &filepath, bool clampToRange=false, double noChangeLimit=0.0001, double singleGaussianLimit=0.002)
	Load a Bethe-Heitler approximation from a JSON file.
std::vector< GbtsLayerConnection >	Acts::Experimental::readGbtsConnections (const std::filesystem::path &path)
	Read the layer connections from a connection table file.
std::vector< GbtsLayerConfig >	Acts::Experimental::readGbtsLayers (const std::filesystem::path &path)
	Read the GBTS layers and their surfaces from a layer map file.
GbtsTauLookupTable	Acts::Experimental::readGbtsTauLookupTable (const std::filesystem::path &path)
	Read the tau lookup table of the cluster width cuts.
static void	Acts::SurfaceJsonConverter::setConfig (const Config &cfg)
	Set externally constructed configuration.
void	Acts::Experimental::to_json (nlohmann::json &j, const GbtsLayerConfig &layer)
	Convert GbtsLayerConfig to JSON.
void	Acts::Experimental::to_json (nlohmann::json &j, const GbtsLayerConnection &connection)
	Convert GbtsLayerConnection to JSON.
void	Acts::Experimental::to_json (nlohmann::json &j, const GbtsTauBounds &bounds)
	Convert GbtsTauBounds to JSON.
void	Acts::to_json (nlohmann::json &j, const Acts::TrackingVolume &volume)
	Convert TrackingVolume to JSON.
void	Acts::to_json (nlohmann::json &j, const BinningData &bd)
	Convert BinningData to JSON.
void	Acts::to_json (nlohmann::json &j, const BinUtility &bu)
	Convert BinUtility to JSON.
void	Acts::to_json (nlohmann::json &j, const BroadTripletSeedFilter::Config &config)
	Convert BroadTripletSeedFilter::Config to JSON.
void	Acts::to_json (nlohmann::json &j, const CylindricalSpacePointGrid::Config &config)
	Convert CylindricalSpacePointGrid::Config to JSON.
void	Acts::to_json (nlohmann::json &j, const Direction &direction)
	Convert Direction to JSON.
void	Acts::to_json (nlohmann::json &j, const DoubletSeedFinder::Config &config)
	Convert DoubletSeedFinder::Config to JSON.
void	Acts::to_json (nlohmann::json &j, const DoubletSeedFinder::DerivedConfig &config)
	Convert DoubletSeedFinder::DerivedConfig to JSON.
void	Acts::to_json (nlohmann::json &j, const Extent &e)
	Convert Extent to JSON.
void	Acts::to_json (nlohmann::json &j, const ExtentEnvelope &e)
	Convert ExtentEnvelope to JSON.
void	Acts::to_json (nlohmann::json &j, const GeometryIdentifier &geoId)
	Write to JSON.
void	Acts::to_json (nlohmann::json &j, const Material &t)
	Convert Material to JSON.
void	Acts::to_json (nlohmann::json &j, const MaterialSlab &t)
	Convert MaterialSlab to JSON.
void	Acts::to_json (nlohmann::json &j, const PolynomialBetheHeitlerApprox::PolyData &data)
	Serialize polynomial component data to JSON.
void	Acts::to_json (nlohmann::json &j, const PolynomialBetheHeitlerApprox::RangeData &data)
	Serialize a single x/x0 range with its data to JSON.
template<typename Type>
void	Acts::to_json (nlohmann::json &j, const Range1D< Type > &r)
	Convert Range1D to JSON.
void	Acts::to_json (nlohmann::json &j, const SeedConfirmationRangeConfig &config)
	Convert SeedConfirmationRangeConfig to JSON.
void	Acts::to_json (nlohmann::json &j, const std::pair< const Acts::TrackingVolume *, std::shared_ptr< const Acts::IVolumeMaterial > > &volume)
	Convert tracking volume and material pair to JSON.
void	Acts::to_json (nlohmann::json &j, const std::shared_ptr< const Surface > &surface)
	Convert shared_ptr<Surface> to JSON.
void	Acts::to_json (nlohmann::json &j, const Surface &surface)
	Convert Surface to JSON.
void	Acts::to_json (nlohmann::json &j, const SurfaceAndMaterialWithContext &surface)
	Convert SurfaceAndMaterialWithContext to JSON.
void	Acts::to_json (nlohmann::json &j, const SurfaceBounds &bounds)
	Convert SurfaceBounds to JSON.
void	Acts::to_json (nlohmann::json &j, const surfaceMaterialPointer &material)
	Convert surfaceMaterialPointer to JSON.
void	Acts::to_json (nlohmann::json &j, const Transform3 &t)
	Convert Transform3 to JSON.
void	Acts::to_json (nlohmann::json &j, const TripletSeedFinder::Config &config)
	Convert TripletSeedFinder::Config to JSON.
void	Acts::to_json (nlohmann::json &j, const TripletSeedFinder::DerivedConfig &config)
	Convert TripletSeedFinder::DerivedConfig to JSON.
void	Acts::to_json (nlohmann::json &j, const VolumeBounds &bounds)
	Convert VolumeBounds to JSON.
void	Acts::to_json (nlohmann::json &j, const volumeMaterialPointer &material)
	Convert volumeMaterialPointer to JSON.
nlohmann::json	Acts::AxisSpecJsonConverter::toJson (const AxisSpec &axisSpec)
	Write the AxisSpec to a json object.
nlohmann::json	Acts::GeometryHierarchyMapJsonConverter< value_t, decorator_t >::toJson (const Container &container, const decorator_t *decorator) const
	Encode the geometry hierarchy map into a Json object.
nlohmann::json	Acts::MultiAxisSpecJsonConverter::toJson (const MultiAxisSpec &multiAxisSpec)
	Write the MultiAxisSpec to a json object.
nlohmann::json	Acts::ProtoAxisJsonConverter::toJson (const ProtoAxis &pa)
	Write the ProtoAxis to a json object.
static nlohmann::json	Acts::SurfaceJsonConverter::toJson (const GeometryContext &gctx, const Surface &surface, const Options &options=Options{ .transformOptions=Transform3JsonConverter::Options{},.writeMaterial=true,.portal=false})
	Contextual conversion of a surface.
void	Acts::toJson (nlohmann::json &j, const std::shared_ptr< const Surface > &surface, const Acts::GeometryContext &gctx)
	Contextual conversion of a surface.
void	Acts::Experimental::writeGbtsConnections (const std::filesystem::path &path, const std::vector< GbtsLayerConnection > &connections)
	Write layer connections to a connection table file.

Variables
bool	Acts::SurfaceJsonConverter::Options::portal = false
	Write surface as portal.
SurfaceBoundsDecoder	Acts::SurfaceJsonConverter::Config::surfaceBoundsDecoder {"type", "surface bounds"}
	Decoder for the surface bounds.
SurfaceBoundsEncoder	Acts::SurfaceJsonConverter::Config::surfaceBoundsEncoder {}
	Encoder for the surface bounds.
SurfaceDecoder	Acts::SurfaceJsonConverter::Config::surfaceDecoder {"type", "surface"}
	Decoder for the surfaces.
SurfaceEncoder	Acts::SurfaceJsonConverter::Config::surfaceEncoder {}
	Encoder for the surfaces.
Transform3JsonConverter::Options	Acts::SurfaceJsonConverter::Options::transformOptions
	Transform serialization options.
bool	Acts::SurfaceJsonConverter::Options::writeMaterial = true
	Write material information.

Typedef Documentation

◆ ConfigPair

using Acts::ConfigPair

Initial value:

std::pair<std::map<std::size_t, std::size_t>, std::vector<DetectorConfig>>

Type alias for a pair of detector configuration and ambiguity resolution configuration.

Maps detector IDs to their configurations and stores a vector of detector-specific settings

◆ DetectorConfig

using Acts::DetectorConfig = ScoreBasedAmbiguityResolution::DetectorConfig

Type alias for detector-specific ambiguity resolution configuration.

Configuration parameters for ambiguity resolution in a specific detector component

◆ SurfaceAndMaterialWithContext

typedef std::tuple< std::shared_ptr< const Surface >, std::shared_ptr< const ISurfaceMaterial >, GeometryContext > Acts::SurfaceAndMaterialWithContext

Initial value:

 
    std::tuple<std::shared_ptr<const Acts::Surface>,
               std::shared_ptr<const Acts::ISurfaceMaterial>,
               Acts::GeometryContext>

A tuple containing a surface, its associated material, and geometry context.

Note: Used for material mapping and JSON conversion.

◆ SurfaceBoundsDecoder

using Acts::SurfaceJsonConverter::SurfaceBoundsDecoder

Initial value:

JsonKindDispatcher<std::shared_ptr<const SurfaceBounds>>

Acts::JsonKindDispatcher

JSON-specific dispatcher that routes decoder functions based on a string kind tag found in the encode...

Definition JsonKindDispatcher.hpp:27

Decoder type for the surface bounds.

Keyed on the serialized SurfaceBounds::BoundsType, independently of the surface carrying them. Returns nullptr for boundless surfaces.

◆ SurfaceDecoder

using Acts::SurfaceJsonConverter::SurfaceDecoder

Initial value:

 
      JsonKindDispatcher<std::shared_ptr<Surface>,
                         std::shared_ptr<const SurfaceBounds>>

Decoder type for the surfaces.

Keyed on the serialized Surface::SurfaceType and handed the already decoded bounds, which it narrows to the type it stores.

◆ SurfaceEncoder

using Acts::SurfaceJsonConverter::SurfaceEncoder

Initial value:

 
      TypeDispatcher<Surface,
                     nlohmann::json(const GeometryContext&, const Options&)>

Encoder type for the surfaces.

◆ TrackingVolumeAndMaterial

using Acts::TrackingVolumeAndMaterial

Initial value:

 
    std::pair<const Acts::TrackingVolume*,
              std::shared_ptr<const Acts::IVolumeMaterial>>

A pair containing a tracking volume and its associated material.

Note: Used for material mapping and JSON conversion.

Function Documentation

◆ accelerationLink()

std::size_t Acts::DetrayJsonHelper::accelerationLink ( std::span< const AxisDirection > casts )

Determine the acceleration link from a grid.

brute_force = 0u, // try all cartesian2_grid = 1u, // rectangle, trapezoid, (triangle) grids cuboid3_grid = 2u, // cuboid grid polar2_grid = 3u, // ring/disc, annulus grids cylinder2_grid = 4u, // 2D cylinder grid cylinder3_grid = 5u, // 3D cylinder grid

Parameters

casts are the grid axes cast types

Returns: the acceleration link idnetifier

◆ decorateJson() [1/2]

template<class T, class decorator_t>

void Acts::decorateJson	(	const decorator_t *	decorator,
		const T &	src,
		nlohmann::json &	dest )

Decorate JSON with additional information from the decorator.

Parameters

decorator	The decorator providing additional information
src	The source object to decorate
dest	The destination JSON object

◆ decorateJson() [2/2]

template<class T, class decorator_t>

void Acts::decorateJson	(	const decorator_t *	decorator,
		const T *	src,
		nlohmann::json &	dest )

Decorate JSON with additional information from the decorator (pointer version).

Parameters

decorator	The decorator providing additional information
src	Pointer to the source object to decorate
dest	The destination JSON object

◆ defaultConfig()

Config Acts::SurfaceJsonConverter::Config::defaultConfig ( )

static

Default configuration construction.

Returns: default configuration

◆ from_json() [1/26]

void Acts::Experimental::from_json	(	const nlohmann::json &	j,
		GbtsLayerConfig &	layer )

Convert JSON to GbtsLayerConfig.

Parameters

j	Source JSON object
layer	Destination GbtsLayerConfig to populate

◆ from_json() [2/26]

void Acts::Experimental::from_json	(	const nlohmann::json &	j,
		GbtsLayerConnection &	connection )

Convert JSON to GbtsLayerConnection.

Parameters

j	Source JSON object
connection	Destination GbtsLayerConnection to populate

◆ from_json() [3/26]

void Acts::Experimental::from_json	(	const nlohmann::json &	j,
		GbtsTauBounds &	bounds )

Convert JSON to GbtsTauBounds.

Parameters

j	Source JSON object
bounds	Destination GbtsTauBounds to populate

◆ from_json() [4/26]

void Acts::from_json	(	const nlohmann::json &	j,
		BinningData &	bd )

Convert JSON to BinningData.

Parameters

j	The JSON object to convert from
bd	The BinningData object to populate

◆ from_json() [5/26]

void Acts::from_json	(	const nlohmann::json &	j,
		BinUtility &	bu )

Convert JSON to BinUtility.

Parameters

j	JSON object to convert from
bu	BinUtility to populate

◆ from_json() [6/26]

void Acts::from_json	(	const nlohmann::json &	j,
		BroadTripletSeedFilter::Config &	config )

Convert JSON to BroadTripletSeedFilter::Config.

Parameters

j	Source JSON object
config	Destination BroadTripletSeedFilter::Config to populate

◆ from_json() [7/26]

void Acts::from_json	(	const nlohmann::json &	j,
		ConfigPair &	p )

Convert JSON to ConfigPair.

Parameters

j	Source JSON object
p	Destination ConfigPair to populate

◆ from_json() [8/26]

void Acts::from_json	(	const nlohmann::json &	j,
		CylindricalSpacePointGrid::Config &	config )

Convert JSON to CylindricalSpacePointGrid::Config.

Parameters

j	Source JSON object
config	Destination CylindricalSpacePointGrid::Config to populate

◆ from_json() [9/26]

void Acts::from_json	(	const nlohmann::json &	j,
		Direction &	direction )

Convert JSON to Direction.

Parameters

j	Source JSON object
direction	Destination Direction to populate

◆ from_json() [10/26]

void Acts::from_json	(	const nlohmann::json &	j,
		DoubletSeedFinder::Config &	config )

Convert JSON to DoubletSeedFinder::Config.

Parameters

j	Source JSON object
config	Destination DoubletSeedFinder::Config to populate

◆ from_json() [11/26]

void Acts::from_json	(	const nlohmann::json &	j,
		DoubletSeedFinder::DerivedConfig &	config )

Convert JSON to DoubletSeedFinder::DerivedConfig.

Parameters

j	Source JSON object
config	Destination DoubletSeedFinder::DerivedConfig to populate

◆ from_json() [12/26]

void Acts::from_json	(	const nlohmann::json &	j,
		Extent &	e )

Convert JSON to Extent.

Parameters

j	Source JSON object
e	Destination Extent to populate

◆ from_json() [13/26]

void Acts::from_json	(	const nlohmann::json &	j,
		ExtentEnvelope &	e )

Convert JSON to ExtentEnvelope.

Parameters

j	Source JSON object
e	Destination ExtentEnvelope to populate

◆ from_json() [14/26]

void Acts::from_json	(	const nlohmann::json &	j,
		GeometryIdentifier &	geoId )

Read from JSON.

Parameters

j	JSON object to read from
geoId	GeometryIdentifier to fill

◆ from_json() [15/26]

void Acts::from_json	(	const nlohmann::json &	j,
		Material &	t )

Convert JSON to Material.

Parameters

j	Source JSON object
t	Destination Material to populate

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ from_json() [16/26]

void Acts::from_json	(	const nlohmann::json &	j,
		MaterialSlab &	t )

Convert JSON to MaterialSlab.

Parameters

j	Source JSON object
t	Destination MaterialSlab to populate

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ from_json() [17/26]

void Acts::from_json	(	const nlohmann::json &	j,
		MaterialSlabMatrix &	t )

Convert JSON to MaterialSlabMatrix.

Parameters

j	Source JSON object
t	Destination MaterialSlabMatrix to populate

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ from_json() [18/26]

void Acts::from_json	(	const nlohmann::json &	j,
		PolynomialBetheHeitlerApprox::PolyData &	data )

Deserialize polynomial component data from JSON.

Parameters

j	Input JSON object
data	The PolyData to populate

◆ from_json() [19/26]

void Acts::from_json	(	const nlohmann::json &	j,
		PolynomialBetheHeitlerApprox::RangeData &	data )

Deserialize a single x/x0 range with its data from JSON.

Parameters

j	Input JSON object
data	The RangeData to populate

◆ from_json() [20/26]

template<typename Type>

void Acts::from_json	(	const nlohmann::json &	j,
		Range1D< Type > &	r )

Convert JSON to Range1D.

Parameters

j	JSON object to convert from
r	Range1D to populate

◆ from_json() [21/26]

void Acts::from_json	(	const nlohmann::json &	j,
		SeedConfirmationRangeConfig &	config )

Convert JSON to SeedConfirmationRangeConfig.

Parameters

j	Source JSON object
config	Destination SeedConfirmationRangeConfig to populate

◆ from_json() [22/26]

void Acts::from_json	(	const nlohmann::json &	j,
		surfaceMaterialPointer &	material )

Convert JSON to surfaceMaterialPointer.

Parameters

j	Source JSON object
material	Destination surfaceMaterialPointer to populate

Note: the caller takes ownership of the returned raw pointer

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ from_json() [23/26]

void Acts::from_json	(	const nlohmann::json &	j,
		Transform3 &	t )

Convert JSON to Transform3.

Parameters

j	Source JSON object
t	Destination Transform3 to populate

◆ from_json() [24/26]

void Acts::from_json	(	const nlohmann::json &	j,
		TripletSeedFinder::Config &	config )

Convert JSON to TripletSeedFinder::Config.

Parameters

j	Source JSON object
config	Destination TripletSeedFinder::Config to populate

◆ from_json() [25/26]

void Acts::from_json	(	const nlohmann::json &	j,
		TripletSeedFinder::DerivedConfig &	config )

Convert JSON to TripletSeedFinder::DerivedConfig.

Parameters

j	Source JSON object
config	Destination TripletSeedFinder::DerivedConfig to populate

◆ from_json() [26/26]

void Acts::from_json	(	const nlohmann::json &	j,
		volumeMaterialPointer &	material )

Convert JSON to volumeMaterialPointer.

Parameters

j	Source JSON object
material	Destination volumeMaterialPointer to populate

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ fromJson() [1/5]

AxisSpec Acts::AxisSpecJsonConverter::fromJson ( const nlohmann::json & j )

Create an AxisSpec from a json object.

Parameters

j	the json object to be read from

Returns: AxisSpec created from the JSON object

◆ fromJson() [2/5]

template<typename value_t, class decorator_t = void>

auto Acts::GeometryHierarchyMapJsonConverter< value_t, decorator_t >::fromJson ( const nlohmann::json & encoded ) const

Decode a Json object into a geometry hierarchy map.

Parameters

encoded Json object that should be decoded

Returns: Decoded geometry hierarchy map

Exceptions

std::invalid_argument in case of format errors

◆ fromJson() [3/5]

MultiAxisSpec Acts::MultiAxisSpecJsonConverter::fromJson ( const nlohmann::json & j )

Create a MultiAxisSpec from a json object.

Parameters

j	the json object to be read from

Returns: MultiAxisSpec created from the JSON object

◆ fromJson() [4/5]

Acts::ProtoAxis Acts::ProtoAxisJsonConverter::fromJson ( const nlohmann::json & j )

Create a ProtoAxis from a json object.

Parameters

j	the json object to be read from

Returns: ProtoAxis created from the JSON object

Deprecated: Use AxisSpecJsonConverter with an AxisSpec instead

◆ fromJson() [5/5]

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

static

The Surface converter from json.

Parameters

jSurface the surface json object

Returns: a shared object created from json input

◆ loadBetheHeitlerApproxFromJson()

PolynomialBetheHeitlerApprox Acts::loadBetheHeitlerApproxFromJson	(	const std::string &	filepath,
		bool	clampToRange = false,
		double	noChangeLimit = 0.0001,
		double	singleGaussianLimit = 0.002 )

Load a Bethe-Heitler approximation from a JSON file.

Parameters

filepath	Path to the JSON file
clampToRange	Whether to clamp x/x0 values to the valid range
noChangeLimit	Limit below which no change is applied
singleGaussianLimit	Limit below which a single Gaussian is used

Returns: The loaded PolynomialBetheHeitlerApprox

◆ readGbtsConnections()

std::vector< GbtsLayerConnection > Acts::Experimental::readGbtsConnections ( const std::filesystem::path & path )

Read the layer connections from a connection table file.

Parameters

path	The file to read, any format the JSON plugin reads

Returns: The connections of the file's connections entry

◆ readGbtsLayers()

std::vector< GbtsLayerConfig > Acts::Experimental::readGbtsLayers ( const std::filesystem::path & path )

Read the GBTS layers and their surfaces from a layer map file.

Parameters

path	The file to read, any format the JSON plugin reads

Returns: The layers of the file's layers entry

◆ readGbtsTauLookupTable()

GbtsTauLookupTable Acts::Experimental::readGbtsTauLookupTable ( const std::filesystem::path & path )

Read the tau lookup table of the cluster width cuts.

Parameters

path	The file to read, any format the JSON plugin reads

Returns: The table of the file's tauLookupTable entry

◆ setConfig()

void Acts::SurfaceJsonConverter::setConfig ( const Config & cfg )

static

Set externally constructed configuration.

Note: May be removed when the dispatcher migration is finished

Parameters

cfg	configuration to use

◆ to_json() [1/31]

void Acts::Experimental::to_json	(	nlohmann::json &	j,
		const GbtsLayerConfig &	layer )

Convert GbtsLayerConfig to JSON.

Parameters

j	Destination JSON object
layer	Source GbtsLayerConfig to convert

◆ to_json() [2/31]

void Acts::Experimental::to_json	(	nlohmann::json &	j,
		const GbtsLayerConnection &	connection )

Convert GbtsLayerConnection to JSON.

Parameters

j	Destination JSON object
connection	Source GbtsLayerConnection to convert

◆ to_json() [3/31]

void Acts::Experimental::to_json	(	nlohmann::json &	j,
		const GbtsTauBounds &	bounds )

Convert GbtsTauBounds to JSON.

Parameters

j	Destination JSON object
bounds	Source GbtsTauBounds to convert

◆ to_json() [4/31]

void Acts::to_json	(	nlohmann::json &	j,
		const Acts::TrackingVolume &	volume )

Convert TrackingVolume to JSON.

Parameters

j	Destination JSON object
volume	Source TrackingVolume to convert

◆ to_json() [5/31]

void Acts::to_json	(	nlohmann::json &	j,
		const BinningData &	bd )

Convert BinningData to JSON.

Parameters

j	JSON object to write to
bd	BinningData to convert

◆ to_json() [6/31]

void Acts::to_json	(	nlohmann::json &	j,
		const BinUtility &	bu )

Convert BinUtility to JSON.

Parameters

j	JSON object to write to
bu	BinUtility to convert

◆ to_json() [7/31]

void Acts::to_json	(	nlohmann::json &	j,
		const BroadTripletSeedFilter::Config &	config )

Convert BroadTripletSeedFilter::Config to JSON.

Parameters

j	Destination JSON object
config	Source BroadTripletSeedFilter::Config to convert

◆ to_json() [8/31]

void Acts::to_json	(	nlohmann::json &	j,
		const CylindricalSpacePointGrid::Config &	config )

Convert CylindricalSpacePointGrid::Config to JSON.

Parameters

j	Destination JSON object
config	Source CylindricalSpacePointGrid::Config to convert

◆ to_json() [9/31]

void Acts::to_json	(	nlohmann::json &	j,
		const Direction &	direction )

Convert Direction to JSON.

Parameters

j	Destination JSON object
direction	Source Direction to convert

◆ to_json() [10/31]

void Acts::to_json	(	nlohmann::json &	j,
		const DoubletSeedFinder::Config &	config )

Convert DoubletSeedFinder::Config to JSON.

Parameters

j	Destination JSON object
config	Source DoubletSeedFinder::Config to convert

◆ to_json() [11/31]

void Acts::to_json	(	nlohmann::json &	j,
		const DoubletSeedFinder::DerivedConfig &	config )

Convert DoubletSeedFinder::DerivedConfig to JSON.

Parameters

j	Destination JSON object
config	Source DoubletSeedFinder::DerivedConfig to convert

◆ to_json() [12/31]

void Acts::to_json	(	nlohmann::json &	j,
		const Extent &	e )

Convert Extent to JSON.

Parameters

j	Destination JSON object
e	Source Extent to convert

◆ to_json() [13/31]

void Acts::to_json	(	nlohmann::json &	j,
		const ExtentEnvelope &	e )

Convert ExtentEnvelope to JSON.

Parameters

j	Destination JSON object
e	Source ExtentEnvelope to convert

◆ to_json() [14/31]

void Acts::to_json	(	nlohmann::json &	j,
		const GeometryIdentifier &	geoId )

Write to JSON.

Parameters

j	JSON object to write to
geoId	GeometryIdentifier to write

◆ to_json() [15/31]

void Acts::to_json	(	nlohmann::json &	j,
		const Material &	t )

Convert Material to JSON.

Parameters

j	Destination JSON object
t	Source Material to convert

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ to_json() [16/31]

void Acts::to_json	(	nlohmann::json &	j,
		const MaterialSlab &	t )

Convert MaterialSlab to JSON.

Parameters

j	Destination JSON object
t	Source MaterialSlab to convert

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ to_json() [17/31]

void Acts::to_json	(	nlohmann::json &	j,
		const PolynomialBetheHeitlerApprox::PolyData &	data )

Serialize polynomial component data to JSON.

Parameters

j	Output JSON object
data	The PolyData to serialize

◆ to_json() [18/31]

void Acts::to_json	(	nlohmann::json &	j,
		const PolynomialBetheHeitlerApprox::RangeData &	data )

Serialize a single x/x0 range with its data to JSON.

Parameters

j	Output JSON object
data	The RangeData to serialize

◆ to_json() [19/31]

template<typename Type>

void Acts::to_json	(	nlohmann::json &	j,
		const Range1D< Type > &	r )

Convert Range1D to JSON.

Parameters

j	JSON object to write to
r	Range1D to convert

◆ to_json() [20/31]

void Acts::to_json	(	nlohmann::json &	j,
		const SeedConfirmationRangeConfig &	config )

Convert SeedConfirmationRangeConfig to JSON.

Parameters

j	Destination JSON object
config	Source SeedConfirmationRangeConfig to convert

◆ to_json() [21/31]

void Acts::to_json	(	nlohmann::json &	j,
		const std::pair< const Acts::TrackingVolume *, std::shared_ptr< const Acts::IVolumeMaterial > > &	volume )

Convert tracking volume and material pair to JSON.

Parameters

j	Destination JSON object
volume	Source tracking volume and material pair to convert

◆ to_json() [22/31]

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

Convert shared_ptr<Surface> to JSON.

Parameters

j	Destination JSON object
surface	Source shared_ptr<Surface> to convert

Note: it will take the default context

◆ to_json() [23/31]

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

Convert Surface to JSON.

Parameters

j	Destination JSON object
surface	Source Surface to convert

Note: it will take the default context

◆ to_json() [24/31]

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

Convert SurfaceAndMaterialWithContext to JSON.

Parameters

j	Destination JSON object
surface	Source SurfaceAndMaterialWithContext to convert

◆ to_json() [25/31]

void Acts::to_json	(	nlohmann::json &	j,
		const SurfaceBounds &	bounds )

Convert SurfaceBounds to JSON.

Parameters

j	Destination JSON object
bounds	Source SurfaceBounds to convert

◆ to_json() [26/31]

void Acts::to_json	(	nlohmann::json &	j,
		const surfaceMaterialPointer &	material )

Convert surfaceMaterialPointer to JSON.

Parameters

j	Destination JSON object
material	Source surfaceMaterialPointer to convert

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ to_json() [27/31]

void Acts::to_json	(	nlohmann::json &	j,
		const Transform3 &	t )

Convert Transform3 to JSON.

Parameters

j	Destination JSON object
t	Source Transform3 to convert

◆ to_json() [28/31]

void Acts::to_json	(	nlohmann::json &	j,
		const TripletSeedFinder::Config &	config )

Convert TripletSeedFinder::Config to JSON.

Parameters

j	Destination JSON object
config	Source TripletSeedFinder::Config to convert

◆ to_json() [29/31]

void Acts::to_json	(	nlohmann::json &	j,
		const TripletSeedFinder::DerivedConfig &	config )

Convert TripletSeedFinder::DerivedConfig to JSON.

Parameters

j	Destination JSON object
config	Source TripletSeedFinder::DerivedConfig to convert

◆ to_json() [30/31]

void Acts::to_json	(	nlohmann::json &	j,
		const VolumeBounds &	bounds )

Convert VolumeBounds to JSON.

Parameters

j	Destination JSON object
bounds	Source VolumeBounds to convert

◆ to_json() [31/31]

void Acts::to_json	(	nlohmann::json &	j,
		const volumeMaterialPointer &	material )

Convert volumeMaterialPointer to JSON.

Parameters

j	Destination JSON object
material	Source volumeMaterialPointer to convert

Deprecated: Legacy material format; use Acts::TrackingGeometryMaterialJsonConverter instead.

◆ toJson() [1/6]

nlohmann::json Acts::AxisSpecJsonConverter::toJson ( const AxisSpec & axisSpec )

Write the AxisSpec to a json object.

Parameters

axisSpec the axis spec to be written out

Returns: JSON object representing the axis spec

◆ toJson() [2/6]

template<typename value_t, class decorator_t>

nlohmann::json Acts::GeometryHierarchyMapJsonConverter< value_t, decorator_t >::toJson	(	const Container &	container,
		const decorator_t *	decorator ) const

Encode the geometry hierarchy map into a Json object.

Parameters

container	Geometry hierarchy map that should be encoded
decorator	nullptr or a decorator to add extra values to the json output

Returns: Encoded Json object

◆ toJson() [3/6]

nlohmann::json Acts::MultiAxisSpecJsonConverter::toJson ( const MultiAxisSpec & multiAxisSpec )

Write the MultiAxisSpec to a json object.

Parameters

multiAxisSpec the multi-axis spec to be written out

Returns: JSON object representing the multi-axis spec

◆ toJson() [4/6]

nlohmann::json Acts::ProtoAxisJsonConverter::toJson ( const ProtoAxis & pa )

Write the ProtoAxis to a json object.

Parameters

pa	the proto axis to be written out

Returns: JSON object representing the proto axis

Deprecated: Use AxisSpecJsonConverter with an AxisSpec instead

◆ toJson() [5/6]

nlohmann::json Acts::SurfaceJsonConverter::toJson	(	const GeometryContext &	gctx,
		const Surface &	surface,
		const Options &	options = Options{ .transformOptions=Transform3JsonConverter::Options{},.writeMaterial=true,.portal=false} )

static

Contextual conversion of a surface.

Parameters

gctx	the geometry context for this
surface	the surface to be converted
options	the writing options for the surfaces

Returns: a json object representing the surface

◆ toJson() [6/6]

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

Contextual conversion of a surface.

Parameters

j	the json to be filled
surface	the surface to be converted
gctx	the geometry context for this

◆ writeGbtsConnections()

void Acts::Experimental::writeGbtsConnections	(	const std::filesystem::path &	path,
		const std::vector< GbtsLayerConnection > &	connections )

Write layer connections to a connection table file.

Parameters

path	The file to write, whose extension selects the format
connections	The connections to write as the connections entry

Variable Documentation

◆ transformOptions

Transform3JsonConverter::Options Acts::SurfaceJsonConverter::Options::transformOptions

Initial value:

=

Transform3JsonConverter::Options{}

Acts::Transform3JsonConverter::Options

The options for the transform converter.

Definition AlgebraJsonConverter.hpp:34

Transform serialization options.

Detailed Description

Namespaces

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ ConfigPair

◆ DetectorConfig

◆ SurfaceAndMaterialWithContext

◆ SurfaceBoundsDecoder

◆ SurfaceDecoder

◆ SurfaceEncoder

◆ TrackingVolumeAndMaterial

Function Documentation

◆ accelerationLink()

◆ decorateJson() [1/2]

◆ decorateJson() [2/2]

◆ defaultConfig()

◆ from_json() [1/26]

◆ from_json() [2/26]

◆ from_json() [3/26]

◆ from_json() [4/26]

◆ from_json() [5/26]

◆ from_json() [6/26]

◆ from_json() [7/26]

◆ from_json() [8/26]

◆ from_json() [9/26]

◆ from_json() [10/26]

◆ from_json() [11/26]

◆ from_json() [12/26]

◆ from_json() [13/26]

◆ from_json() [14/26]

◆ from_json() [15/26]

◆ from_json() [16/26]

◆ from_json() [17/26]

◆ from_json() [18/26]

◆ from_json() [19/26]

◆ from_json() [20/26]

◆ from_json() [21/26]

◆ from_json() [22/26]

◆ from_json() [23/26]

◆ from_json() [24/26]

◆ from_json() [25/26]

◆ from_json() [26/26]

◆ fromJson() [1/5]

◆ fromJson() [2/5]

◆ fromJson() [3/5]

◆ fromJson() [4/5]

◆ fromJson() [5/5]

◆ loadBetheHeitlerApproxFromJson()

◆ readGbtsConnections()

◆ readGbtsLayers()

◆ readGbtsTauLookupTable()

◆ setConfig()

◆ to_json() [1/31]

◆ to_json() [2/31]

◆ to_json() [3/31]

◆ to_json() [4/31]

◆ to_json() [5/31]

◆ to_json() [6/31]

◆ to_json() [7/31]

◆ to_json() [8/31]

◆ to_json() [9/31]

◆ to_json() [10/31]

◆ to_json() [11/31]

◆ to_json() [12/31]

◆ to_json() [13/31]

◆ to_json() [14/31]

◆ to_json() [15/31]

◆ to_json() [16/31]

◆ to_json() [17/31]

◆ to_json() [18/31]

◆ to_json() [19/31]

◆ to_json() [20/31]

◆ to_json() [21/31]

◆ to_json() [22/31]

◆ to_json() [23/31]

◆ to_json() [24/31]

◆ to_json() [25/31]