Acts::TrackingGeometryJsonConverter Class Reference

Converter for tracking geometry JSON payloads. More...

#include <ActsPlugins/Json/TrackingGeometryJsonConverter.hpp>

Classes
struct	Config
	Configuration for the tracking geometry JSON converter. More...
struct	IdToPointerLikeLookup
	Generic lookup from serialized ID to pointer-like object holder. More...
struct	Options
	JSON serialization options for tracking geometry conversion. More...
struct	PointerToIdLookup
	Generic lookup from object pointer identity to serialized object ID. More...

Public Types
using	NavigationPolicyDecoder
	Navigation policy decoder.
using	NavigationPolicyEncoder
	Navigation policy encoder.
using	PortalIdLookup = PointerToIdLookup<Portal, kPortalLookupContext>
	Portal map to its JSON ID.
using	PortalLinkDecoder
	Portal link decoder.
using	PortalLinkEncoder
	Portal link encoder.
using	PortalPointerLookup
	JSON ID map to its portal.
using	SurfaceIdLookup = PointerToIdLookup<Surface, kSurfaceLookupContext>
	Surface map to its JSON ID.
using	SurfacePointerLookup
	JSON ID map to its surface.
using	VolumeBoundsDecoder = JsonKindDispatcher<std::unique_ptr<VolumeBounds>>
	Volume bounds decoder.
using	VolumeBoundsEncoder = TypeDispatcher<VolumeBounds, nlohmann::json()>
	Volume bounds encoder.
using	VolumeIdLookup
	Tracking volume map to its JSON ID.
using	VolumePointerLookup
	JSON ID map to its tracking volume.

Public Member Functions
	TrackingGeometryJsonConverter (Config config=Config::defaultConfig(), std::unique_ptr< const Acts::Logger > logger=Acts::getDefaultLogger("TrackingGeometryJsonConverter", Acts::Logging::INFO))
	Construct converter with custom or default dispatch configuration.
std::shared_ptr< TrackingGeometry >	fromJson (const GeometryContext &gctx, const nlohmann::json &encoded, const Options &options=Options{}) const
	Reconstruct a tracking geometry from JSON.
std::unique_ptr< Acts::INavigationPolicy >	navigationPolicyFromJson (const Acts::GeometryContext &gctx, const nlohmann::json &encoded, const Acts::TrackingVolume &volume, const Acts::Logger &logger) const
	Deserialize navigation policy using configured decoders.
nlohmann::json	navigationPolicyToJson (const INavigationPolicy &policy) const
	Serialize navigation policy using the configured dispatcher.
std::unique_ptr< PortalLinkBase >	portalLinkFromJson (const nlohmann::json &encoded, const SurfacePointerLookup &surfaces, const VolumePointerLookup &volumes) const
	Deserialize one portal link using configured decoders.
nlohmann::json	portalLinkToJson (const GeometryContext &gctx, const PortalLinkBase &link, const SurfaceIdLookup &surfaceIds, const VolumeIdLookup &volumeIds) const
	Serialize one portal link using the configured dispatcher.
nlohmann::json	toJson (const GeometryContext &gctx, const TrackingGeometry &geometry, const Options &options=Options{}) const
	Convert a tracking geometry to JSON.
std::shared_ptr< TrackingVolume >	trackingVolumeFromJson (const GeometryContext &gctx, const nlohmann::json &encoded, const Options &options=Options{}) const
	Reconstruct a tracking volume hierarchy from JSON.
nlohmann::json	trackingVolumeToJson (const GeometryContext &gctx, const TrackingVolume &world, const Options &options=Options{}) const
	Convert a tracking volume hierarchy to JSON.

Static Public Attributes
static constexpr char	kPortalLookupContext [] = "portal"
	Exception context for portals.
static constexpr char	kSurfaceLookupContext [] = "surface"
	Exception context for surfaces.
static constexpr char	kVolumeLookupContext [] = "volume"
	Exception context for volumes.

Detailed Description

Converter for tracking geometry JSON payloads.

High-level conversion overview:

• Serialization:
  • traverse the TrackingVolume::volumes() tree in depth-first order
  • collect unique instances of surfaces, portals, volumes and assign stable in-file IDs
  • serialize the instances into their independent top-level tables
  • encode object-to-object relationships through the assigned IDs
• Deserialization:
  • validate schema header and collect all volume records
  • instantiate volumes, portals, surfaces and build ID->pointer lookup
  • attach child volumes to reconstruct the tree
  • attach surfaces to portals and volumes via ID lookup
  • portals to volumes via ID lookup
  • return deserialized geometry

Member Typedef Documentation

NavigationPolicyDecoder

using Acts::TrackingGeometryJsonConverter::NavigationPolicyDecoder

Initial value:

 
      JsonKindDispatcher<std::unique_ptr<INavigationPolicy>,
                         const GeometryContext&,
                         const TrackingGeometryJsonConverter&,
                         const TrackingVolume&, const Acts::Logger&>

Navigation policy decoder.

NavigationPolicyEncoder

using Acts::TrackingGeometryJsonConverter::NavigationPolicyEncoder

Initial value:

 
      TypeDispatcher<INavigationPolicy,
                     nlohmann::json(
                         const Acts::TrackingGeometryJsonConverter&)>

Navigation policy encoder.

PortalLinkDecoder

using Acts::TrackingGeometryJsonConverter::PortalLinkDecoder

Initial value:

 JsonKindDispatcher<
      std::unique_ptr<PortalLinkBase>, const TrackingGeometryJsonConverter&,
      const SurfacePointerLookup&, const VolumePointerLookup&>

Portal link decoder.

PortalLinkEncoder

using Acts::TrackingGeometryJsonConverter::PortalLinkEncoder

Initial value:

 
      TypeDispatcher<PortalLinkBase,
                     nlohmann::json(const GeometryContext&,
                                    const TrackingGeometryJsonConverter&,
                                    const SurfaceIdLookup&,
                                    const VolumeIdLookup&)>

Portal link encoder.

PortalPointerLookup

using Acts::TrackingGeometryJsonConverter::PortalPointerLookup

Initial value:

 
      IdToPointerLikeLookup<Portal, std::shared_ptr<Portal>,
                            kPortalLookupContext>

JSON ID map to its portal.

SurfacePointerLookup

using Acts::TrackingGeometryJsonConverter::SurfacePointerLookup

Initial value:

 
      IdToPointerLikeLookup<RegularSurface, std::shared_ptr<RegularSurface>,
                            kSurfaceLookupContext>

JSON ID map to its surface.

VolumeIdLookup

using Acts::TrackingGeometryJsonConverter::VolumeIdLookup

Initial value:

 
      PointerToIdLookup<TrackingVolume, kVolumeLookupContext>

Tracking volume map to its JSON ID.

VolumePointerLookup

using Acts::TrackingGeometryJsonConverter::VolumePointerLookup

Initial value:

 
      IdToPointerLikeLookup<TrackingVolume, TrackingVolume*,
                            kVolumeLookupContext>

JSON ID map to its tracking volume.

Constructor & Destructor Documentation

TrackingGeometryJsonConverter()

Acts::TrackingGeometryJsonConverter::TrackingGeometryJsonConverter ( Config config = Config::defaultConfig(), std::unique_ptr< const Acts::Logger > logger = Acts::getDefaultLogger("TrackingGeometryJsonConverter", Acts::Logging::INFO) )

explicit

Construct converter with custom or default dispatch configuration.

Parameters

config	The conversion dispatch configuration
logger	The logger instance

Member Function Documentation

fromJson()

std::shared_ptr< TrackingGeometry > Acts::TrackingGeometryJsonConverter::fromJson	(	const GeometryContext &	gctx,
		const nlohmann::json &	encoded,
		const Options &	options = Options{} ) const

Reconstruct a tracking geometry from JSON.

Parameters

gctx	geometry context
encoded	serialized tracking geometry
options	options for the conversion

Returns

pointer to deserialized geometry

navigationPolicyFromJson()

std::unique_ptr< Acts::INavigationPolicy > Acts::TrackingGeometryJsonConverter::navigationPolicyFromJson	(	const Acts::GeometryContext &	gctx,
		const nlohmann::json &	encoded,
		const Acts::TrackingVolume &	volume,
		const Acts::Logger &	logger ) const

Deserialize navigation policy using configured decoders.

Parameters

gctx	geometry context
encoded	serialized navigation policy
volume	tracking volume to assign navigation policy to
logger	logging instance

Returns

pointer to deserialized navigation policy

navigationPolicyToJson()

nlohmann::json Acts::TrackingGeometryJsonConverter::navigationPolicyToJson

(

const INavigationPolicy &

policy

)

const

Serialize navigation policy using the configured dispatcher.

Parameters

policy

navigation policy to serialize

Returns

serialized navigation policy

portalLinkFromJson()

std::unique_ptr< PortalLinkBase > Acts::TrackingGeometryJsonConverter::portalLinkFromJson	(	const nlohmann::json &	encoded,
		const SurfacePointerLookup &	surfaces,
		const VolumePointerLookup &	volumes ) const

Deserialize one portal link using configured decoders.

Parameters

encoded	serialized portal link
surfaces	id-to-surface map for internal lookup
volumes	id-to-volume map for internal lookup

Returns

pointer to deserialized portal link

portalLinkToJson()

nlohmann::json Acts::TrackingGeometryJsonConverter::portalLinkToJson	(	const GeometryContext &	gctx,
		const PortalLinkBase &	link,
		const SurfaceIdLookup &	surfaceIds,
		const VolumeIdLookup &	volumeIds ) const

Serialize one portal link using the configured dispatcher.

Parameters

gctx	geometry context
link	portal link to serialize
surfaceIds	surface-to-id map for internal lookup
volumeIds	volume-to-id map for internal lookup

Returns

serialized portal link

toJson()

nlohmann::json Acts::TrackingGeometryJsonConverter::toJson	(	const GeometryContext &	gctx,
		const TrackingGeometry &	geometry,
		const Options &	options = Options{} ) const

Convert a tracking geometry to JSON.

Parameters

gctx	geometry context
geometry	tracking geometry to convert
options	options for the conversion

Returns

serialized tracking geometry

trackingVolumeFromJson()

std::shared_ptr< TrackingVolume > Acts::TrackingGeometryJsonConverter::trackingVolumeFromJson	(	const GeometryContext &	gctx,
		const nlohmann::json &	encoded,
		const Options &	options = Options{} ) const

Reconstruct a tracking volume hierarchy from JSON.

Parameters

gctx	geometry context
encoded	serialized tracking volume hierarchy
options	options for the conversion

Returns

pointer to deserialized tracking volume hierarchy

Note

currently the geometry context is only propagated to the Portal construction and the NavigationPolicy assignment

trackingVolumeToJson()

nlohmann::json Acts::TrackingGeometryJsonConverter::trackingVolumeToJson	(	const GeometryContext &	gctx,
		const TrackingVolume &	world,
		const Options &	options = Options{} ) const

Convert a tracking volume hierarchy to JSON.

Parameters

gctx	geometry context
world	top tracking volume in the hierarchy
options	options for the conversion

Returns

serialized tracking volume hierarchy

Note

the geometry context is applied to the transformations during the serialization