ActsPlugins Namespace Reference

The ACTS plugins namespace: All plugins go here. More...

Namespaces
namespace	Covfie
namespace	DD4hepBinningHelpers
namespace	DetrayConversionUtils
namespace	EDM4hepUtil
namespace	FastJet
namespace	Geant4PhysicalVolumeSelectors
namespace	GeoModel
namespace	GeoModelReader
namespace	PodioUtil
namespace	Svg

Classes
class	AmbiguityTrackClassifier
	Onnx model implementation for track scoring and selection. More...
class	BoostTrackBuilding
class	ConstPodioTrackContainer
class	ConstPodioTrackStateContainer
class	CudaTrackBuilding
class	DD4hepDetectorElement
	DetectorElement class implementation for DD4hep geometry. More...
struct	DD4hepDetectorElementExtension
	This extension holds an ACTS detector element belonging to a DD4hep detector element, and synchronizes ownership. More...
class	DD4hepDetectorSurfaceFactory
	A factory to convert DD4hep DetectorElements into sensitive of passive surfaces which are filled into a Cache object, also the create DD4hepDetector elements are provided. More...
class	DD4hepFieldAdapter
class	DD4hepLayerBuilder
	build layers of one cylinder-endcap setup from DD4hep input More...
class	DD4hepVolumeBuilder
	build confined TrackingVolumes of one cylinder setup from DD4hep input. More...
class	DetrayPayloadConverter
class	DetrayUnsupportedMaterialException
struct	Device
	A simple device description struct. More...
class	EdgeClassificationBase
struct	ExecutionContext
	Capture the context of the execution. More...
class	FpeMonitor
struct	Geant4AlgebraConverter
class	Geant4DetectorElement
	Detector element representative for Geant4 sensitive elements. More...
class	Geant4DetectorSurfaceFactory
	A factory to convert Geant4 physical volumes into Geant4 detector elements. More...
struct	Geant4MaterialConverter
struct	Geant4PhysicalVolumeConverter
struct	Geant4ShapeConverter
struct	Geant4VolumeConverter
class	GeoModelDetectorElement
	Detector element representative for GeoModel based sensitive elements. More...
class	GeoModelDetectorElementITk
	Specialization of the GeoModelDetectorElement for the ITk. More...
class	GeoModelDetectorObjectFactory
	Factory class to convert GeoModel objects into Acts volumes and surfaces. More...
struct	GeoModelTree
	Holder struct to manage a GeoModel world. More...
class	GnnHook
class	GnnPipeline
struct	GnnTiming
class	GraphConstructionBase
class	GraphStoreHook
class	HashingAlgorithm
struct	HashingAlgorithmConfig
class	HashingAnnoy
class	HashingTrainingAlgorithm
struct	HashingTrainingConfig
class	IGeant4PhysicalVolumeSelector
	Interface class for selectors from physical volumes. More...
class	IGeoShapeConverter
	Interface for the conversion of GeoShapes to Acts surfaces. More...
class	ITGeoDetectorElementSplitter
	ITGeoElementSplitter. More...
class	ITGeoIdentifierProvider
	ITGeoIdentierProvider. More...
class	ITkIdentifier
class	MLTrackClassifier
class	ModuleMapCuda
class	MutablePodioTrackContainer
class	MutablePodioTrackStateContainer
struct	NoEdgesError
	Error that is thrown if no edges are found. More...
class	OnnxEdgeClassifier
class	OnnxRuntimeBase
struct	PipelineTensors
	Struct that ties together the tensors used in the GNN pipeline. More...
class	PodioTrackContainerBase
class	PodioTrackStateContainerBase
class	RootMaterialDecorator
	Read the collection of SurfaceMaterial & VolumeMaterial. More...
class	RootMaterialMapIo
	Simple payload class that can be wrapped for reading and writing. More...
class	RootMaterialTrackIo
	Simple payload class that can be wrapped for reading and writing. More...
class	RootMeasurementIo
	Helper class to manage the I/O of measurements and associated clusters to and from ROOT files. More...
class	RootSpacePointIo
	Root space point reading and writing utility. More...
class	SeedClassifier
	Onnx model implementation for seed scoring and selection. More...
class	Tensor
	This is a very small, limited class that models a 2D tensor of arbitrary type. More...
class	TensorRTEdgeClassifier
class	TGeoCylinderDiscSplitter
	TGeoCylinderDiscSplitter. More...
class	TGeoDetectorElement
	DetectorElement plugin for ROOT TGeo shapes. More...
class	TGeoLayerBuilder
	This parses the gGeoManager and looks for a defined combination of volume with contained sensitive detector element. More...
struct	TGeoMaterialConverter
struct	TGeoParser
	TGeoParser is a helper struct that walks recursively through a TGeometry and selects by string comparison the TGeoNodes that match the criteria. More...
struct	TGeoPrimitivesHelper
struct	TGeoSurfaceConverter
	Helper struct to convert TGeoShapes into Surface or Volume Bounds. More...
class	TorchEdgeClassifier
class	TorchMetricLearning
class	TrackBuildingBase
class	TruthGraphMetricsHook

Typedefs
using	AnnoyMetric = Annoy::AngularEuclidean
using	AnnoyModel
using	DetrayHostDetector = detray::detector<DetrayMetaData>
using	DetrayMetaData = detray::default_metadata<detray::array<double>>
using	GeoBoxConverter
	The GeoBox converter.
using	GeoIntersectionAnnulusConverter
	A dedicated converter for GeoInterseciton that describe annulus bounds.
using	GeoModelSensitiveSurface
	Collect the sensitive surface & detector element.
using	GeoPolygonConverter
using	GeoShiftConverter
	The GeoShift + Trd/Box/Tube converter.
using	GeoSubtractionConverter
using	GeoTrdConverter
	The GeoTrd converter.
using	GeoTubeConverter
	The GeoTube converter.
using	GeoUnionDoubleTrdConverter
	The GeoTube converter.
using	NetworkBatchInput
	Type alias for network batch input data structure.

Enumerations
enum class	FpeType : std::uint32_t {   FpeType::INTDIV = FPE_INTDIV , FpeType::INTOVF = FPE_INTOVF , FpeType::FLTDIV = FPE_FLTDIV , FpeType::FLTOVF = FPE_FLTOVF ,   FpeType::FLTUND = FPE_FLTUND , FpeType::FLTRES = FPE_FLTRES , FpeType::FLTINV = FPE_FLTINV , FpeType::FLTSUB = FPE_FLTSUB }
enum class	GeoModelConversionError { GeoModelConversionError::WrongShapeForConverter = 1 , GeoModelConversionError::InvalidShapeParameters , GeoModelConversionError::UnkownShape , GeoModelConversionError::MissingLogicalVolume }

Functions
void	addCylinderLayerProtoMaterial (dd4hep::DetElement detElement, Acts::Layer &cylinderLayer, const Acts::Logger &logger=Acts::getDummyLogger())
	Helper method to translate DD4hep material to Acts::ISurfaceMaterial.
void	addDiscLayerProtoMaterial (dd4hep::DetElement detElement, Acts::Layer &discLayer, const Acts::Logger &logger=Acts::getDummyLogger())
	Helper method to translate DD4hep material to Acts::ISurfaceMaterial.
void	addLayerProtoMaterial (const dd4hep::rec::VariantParameters &params, Acts::Layer &layer, const std::vector< std::pair< const std::string, Acts::BinningOption > > &binning, const Acts::Logger &logger=Acts::getDummyLogger())
	Helper method to be called for Cylinder and Disc Proto material.
std::pair< Tensor< std::int64_t >, std::optional< Tensor< float > > >	applyEdgeLimit (const Tensor< std::int64_t > &edgeIndex, const std::optional< Tensor< float > > &edgeFeatures, std::size_t maxEdges, std::optional< cudaStream_t > stream)
	Apply a limit on the number of edges consistently on edgeIndex and edgeFeatures.
std::pair< Tensor< float >, Tensor< std::int64_t > >	applyScoreCut (const Tensor< float > &scores, const Tensor< std::int64_t > &edgeIndex, float cut, std::optional< cudaStream_t > stream={})
	Apply a score cut to the tensor and return a new tensor with the values that satisfy the cut.
void	collectCompounds_dd4hep (dd4hep::DetElement &detElement, std::vector< dd4hep::DetElement > &compounds)
	Method internally used by convertDD4hepDetector to collect all volumes of a compound detector.
void	collectLayers_dd4hep (dd4hep::DetElement &detElement, std::vector< dd4hep::DetElement > &layers, const Acts::Logger &logger)
	Method internally used by convertDD4hepDetector.
void	collectSubDetectors_dd4hep (dd4hep::DetElement &detElement, std::vector< dd4hep::DetElement > &subdetectors, const Acts::Logger &logger)
	Method internally used by convertDD4hepDetector to collect all sub detectors Sub detector means each 'compound' DetElement or DetElements which are declared as 'isBarrel' or 'isBeampipe' by their extension.
std::unique_ptr< const Acts::TrackingGeometry >	convertDD4hepDetector (dd4hep::DetElement worldDetElement, const Acts::Logger &logger, Acts::BinningType bTypePhi=Acts::equidistant, Acts::BinningType bTypeR=Acts::equidistant, Acts::BinningType bTypeZ=Acts::equidistant, double layerEnvelopeR=Acts::UnitConstants::mm, double layerEnvelopeZ=Acts::UnitConstants::mm, double defaultLayerThickness=Acts::UnitConstants::fm, const std::function< void(std::vector< dd4hep::DetElement > &detectors)> &sortSubDetectors=sortDetElementsByID, const Acts::GeometryContext &gctx=Acts::GeometryContext::dangerouslyDefaultConstruct(), std::shared_ptr< const Acts::IMaterialDecorator > matDecorator=nullptr, std::shared_ptr< const Acts::GeometryIdentifierHook > geometryIdentifierHook=std::make_shared< Acts::GeometryIdentifierHook >(), const DD4hepLayerBuilder::ElementFactory &detectorElementFactory=DD4hepLayerBuilder::defaultDetectorElementFactory)
	Global method which creates the TrackingGeometry from DD4hep input.
std::shared_ptr< Acts::ProtoSurfaceMaterial >	createProtoMaterial (const dd4hep::rec::VariantParameters &params, const std::string &valueTag, const std::vector< std::pair< const std::string, Acts::BinningOption > > &binning, const Acts::Logger &logger=Acts::getDummyLogger())
	Helper method to create proto material - to be called from the addProto(...) methods.
std::shared_ptr< const Acts::CylinderVolumeHelper >	cylinderVolumeHelper_dd4hep (const Acts::Logger &logger)
	Helper method internally used to create a default Acts::CylinderVolumeBuilder.
template<typename value_type>
std::vector< value_type >	extractSeries (const dd4hep::DetElement &dd4hepElement, const std::string &bname, const value_type &unitConversion=1)
	A simple helper function to extract a series.
Acts::Transform3	extractTransform (const dd4hep::DetElement &dd4hepElement, const std::string &bname, const double unitConversion=1.)
	A simple helper function to extract a transform.
std::shared_ptr< const IGeoShapeConverter >	geoShapesConverters (int geoShapeId)
	The map that maps the converters with the shapes.
template<typename value_type>
value_type	getAttrValueOr (const dd4hep::xml::Component &node, const std::string &attrName, const value_type &fallbackValue)
	Helper method to get an attribute with fallback.
template<typename T>
T	getParam (const std::string &key, dd4hep::DetElement &elt)
	Helper function to extract a parameter value from a dd4hep detector element from VariantParameters.
template<typename T>
T	getParamOr (const std::string &key, const dd4hep::DetElement &elt, T alternative)
	Get a parameter value or an alternative value if either the VariantParameters extension isn't set, or it doesn't contain the demanded key.
const dd4hep::rec::VariantParameters &	getParams (const dd4hep::DetElement &elt)
	Helper function to extract a VariantParameters instance, const version.
dd4hep::rec::VariantParameters &	getParams (dd4hep::DetElement &elt)
	Helper function to extract a VariantParameters instance.
bool	hasParam (const std::string &key, dd4hep::DetElement &elt)
	Check if a detector element has a key set in its VariantParameters.
bool	hasParams (dd4hep::DetElement &elt)
	Check if a detector element has VariantParameters set.
std::error_code	make_error_code (GeoModelConversionError e)
Acts::InterpolatedBFieldMap< Acts::Grid< Acts::Vector2, Acts::Axis< Acts::AxisType::Equidistant >, Acts::Axis< Acts::AxisType::Equidistant > > >	makeMagneticFieldMapRzFromRoot (const std::function< std::size_t(std::array< std::size_t, 2 > binsRZ, std::array< std::size_t, 2 > nBinsRZ)> &localToGlobalBin, const std::string &fieldMapFile, const std::string &treeName, double lengthUnit, double BFieldUnit, bool firstQuadrant=false)
	Method to setup the FieldMap.
Acts::InterpolatedBFieldMap< Acts::Grid< Acts::Vector3, Acts::Axis< Acts::AxisType::Equidistant >, Acts::Axis< Acts::AxisType::Equidistant >, Acts::Axis< Acts::AxisType::Equidistant > > >	makeMagneticFieldMapXyzFromRoot (const std::function< std::size_t(std::array< std::size_t, 3 > binsXYZ, std::array< std::size_t, 3 > nBinsXYZ)> &localToGlobalBin, const std::string &fieldMapFile, const std::string &treeName, double lengthUnit, double BFieldUnit, bool firstOctant=false)
	Method to setup the FieldMap.
std::ostream &	operator<< (std::ostream &os, const ITkIdentifier &id)
std::ostream &	operator<< (std::ostream &os, Device device)
	Stream operator for Device.
std::ostream &	operator<< (std::ostream &os, FpeType type)
void	sigmoid (Tensor< float > &tensor, std::optional< cudaStream_t > stream={})
	Element-wise sigmoid function for float cpu tensors.
void	sortDetElementsByID (std::vector< dd4hep::DetElement > &det)
	Sort function which sorts dd4hep::DetElement by their ID.
Acts::AxisDirection	stringToAxisDirection (const std::string &binningString)
	Helper method to convert the string to binning value.
std::vector< Acts::AxisDirection >	stringToAxisDirections (const std::string &binningString, const char &del=',')
	Helper method to cenvert a binning list string to a vector of binning values e.g.
TEfficiency *	toRoot (const Acts::Experimental::Efficiency1 &boostEff)
	Convert Efficiency1 to ROOT TEfficiency.
TEfficiency *	toRoot (const Acts::Experimental::Efficiency2 &boostEff)
	Convert Efficiency2 to ROOT TEfficiency.
TH1F *	toRoot (const Acts::Experimental::Histogram1 &boostHist)
	Convert Histogram1 to ROOT TH1F.
TH2F *	toRoot (const Acts::Experimental::Histogram2 &boostHist)
	Convert Histogram2 to ROOT TH2F.
TProfile *	toRoot (const Acts::Experimental::ProfileHistogram1 &boostProfile)
	Convert ProfileHistogram1 to ROOT TProfile.
std::shared_ptr< const Acts::CylinderVolumeBuilder >	volumeBuilder_dd4hep (dd4hep::DetElement subDetector, const Acts::Logger &logger, Acts::BinningType bTypePhi=Acts::equidistant, Acts::BinningType bTypeR=Acts::equidistant, Acts::BinningType bTypeZ=Acts::equidistant, double layerEnvelopeR=Acts::UnitConstants::mm, double layerEnvelopeZ=Acts::UnitConstants::mm, double defaultLayerThickness=Acts::UnitConstants::fm, const DD4hepLayerBuilder::ElementFactory &detectorElementFactory=DD4hepLayerBuilder::defaultDetectorElementFactory)
	Method internally used to create an Acts::CylinderVolumeBuilder.

Variables
static const std::vector< std::tuple< std::string, Acts::AxisDirection > >	allowedBinnings

Detailed Description

The ACTS plugins namespace: All plugins go here.

Typedef Documentation

DetrayHostDetector

using ActsPlugins::DetrayHostDetector = detray::detector<DetrayMetaData>

DetrayMetaData

using ActsPlugins::DetrayMetaData = detray::default_metadata<detray::array<double>>

Function Documentation

make_error_code()

std::error_code ActsPlugins::make_error_code

(

GeoModelConversionError

e

)

toRoot() [1/5]

TEfficiency * ActsPlugins::toRoot

(

const Acts::Experimental::Efficiency1 &

boostEff

)

Convert Efficiency1 to ROOT TEfficiency.

Creates a new ROOT TEfficiency object with the same binning, passed counts, and total counts as the input boost efficiency histogram.

Parameters

boostEff

The boost 1D efficiency histogram to convert

Returns

Raw pointer to new TEfficiency (caller owns and must delete)

toRoot() [2/5]

TEfficiency * ActsPlugins::toRoot

(

const Acts::Experimental::Efficiency2 &

boostEff

)

Convert Efficiency2 to ROOT TEfficiency.

Creates a new ROOT TEfficiency object (2D) with the same binning, passed counts, and total counts as the input boost efficiency histogram.

Parameters

boostEff

The boost 2D efficiency histogram to convert

Returns

Raw pointer to new TEfficiency (caller owns and must delete)

toRoot() [3/5]

TH1F * ActsPlugins::toRoot

(

const Acts::Experimental::Histogram1 &

boostHist

)

Convert Histogram1 to ROOT TH1F.

Creates a new ROOT TH1F histogram with the same binning, content, and errors as the input boost histogram.

Parameters

boostHist

The boost 1D histogram to convert

Returns

Raw pointer to new TH1F (caller owns and must delete)

toRoot() [4/5]

TH2F * ActsPlugins::toRoot

(

const Acts::Experimental::Histogram2 &

boostHist

)

Convert Histogram2 to ROOT TH2F.

Creates a new ROOT TH2F histogram with the same binning, content, and errors as the input boost histogram.

Parameters

boostHist

The boost 2D histogram to convert

Returns

Raw pointer to new TH2F (caller owns and must delete)

toRoot() [5/5]

TProfile * ActsPlugins::toRoot

(

const Acts::Experimental::ProfileHistogram1 &

boostProfile

)

Convert ProfileHistogram1 to ROOT TProfile.

Creates a new ROOT TProfile histogram with the same binning and mean values as the input boost profile histogram.

Parameters

boostProfile

The boost profile histogram to convert

Returns

Raw pointer to new TProfile (caller owns and must delete)