ActsPlugins::DD4hepFieldAdapter Class Reference

Adapter for DD4hep magnetic field to Acts magnetic field provider. More...

#include <ActsPlugins/DD4hep/DD4hepFieldAdapter.hpp>

Inheritance diagram for ActsPlugins::DD4hepFieldAdapter:

Collaboration diagram for ActsPlugins::DD4hepFieldAdapter:

Public Member Functions
	DD4hepFieldAdapter (dd4hep::OverlayedField field)
	Constructor.
	~DD4hepFieldAdapter () override
	Destructor.
Acts::Result< Acts::Vector3 >	getField (const Acts::Vector3 &position, Acts::MagneticFieldProvider::Cache &cache) const override
	Retrieve magnetic field value at a given location.
Acts::MagneticFieldProvider::Cache	makeCache (const Acts::MagneticFieldContext &mctx) const override
	Make an opaque cache for the magnetic field.

Additional Inherited Members
Public Types inherited from Acts::MagneticFieldProvider
using	Cache = Acts::AnyBase<sizeof(char) * 512>
	Opaque cache type that can store arbitrary implementation specific cache data.

Detailed Description

Adapter for DD4hep magnetic field to Acts magnetic field provider.

Constructor & Destructor Documentation

DD4hepFieldAdapter()

ActsPlugins::DD4hepFieldAdapter::DD4hepFieldAdapter ( dd4hep::OverlayedField field )

explicit

Constructor.

Parameters

field

DD4hep overlaid field

Member Function Documentation

getField()

Acts::Result< Acts::Vector3 > ActsPlugins::DD4hepFieldAdapter::getField ( const Acts::Vector3 & position, Acts::MagneticFieldProvider::Cache & cache ) const

overridevirtual

Retrieve magnetic field value at a given location.

Requires an instance of Acts::MagneticFieldProvider::Cache created through makeCache.

Parameters

[in]	position	global 3D position for the lookup
[in,out]	cache	Field provider specific cache object

Returns

magnetic field vector at given position

Implements Acts::MagneticFieldProvider.

makeCache()

Acts::MagneticFieldProvider::Cache ActsPlugins::DD4hepFieldAdapter::makeCache ( const Acts::MagneticFieldContext & mctx ) const

overridevirtual

Make an opaque cache for the magnetic field.

Instructs the specific implementation to generate a Acts::MagneticFieldProvider::Cache instance for magnetic field lookup.

Parameters

mctx	The magnetic field context to generate cache for

Returns

Cache The opaque cache object

Implements Acts::MagneticFieldProvider.