Covfie Plugin

Detailed Description

Typedefs
using	ActsPlugins::Covfie::BuilderBackend
	Backend type for building covfie fields.
using	ActsPlugins::Covfie::ConstantField
	Constant magnetic field type in covfie format.
using	ActsPlugins::Covfie::InterpolatedField
	Interpolated magnetic field type in covfie format.

Functions
ConstantField	ActsPlugins::Covfie::covfieField (const Acts::ConstantBField &magneticField)
	Creates a covfie field from a constant B field.
InterpolatedField	ActsPlugins::Covfie::covfieField (const Acts::InterpolatedMagneticField &magneticField)
	Creates a covfie field from an interpolated magnetic field.
InterpolatedField	ActsPlugins::Covfie::covfieField (const Acts::MagneticFieldProvider &magneticField, Acts::MagneticFieldProvider::Cache &cache, const std::array< std::size_t, 3 > &nPoints, const Acts::Vector3 &min, const Acts::Vector3 &max)
	Creates a covfie field from a magnetic field provider by sampling it.

Typedef Documentation

BuilderBackend

using ActsPlugins::Covfie::BuilderBackend

Initial value:

 
    covfie::backend::strided<covfie::vector::size3,
                             covfie::backend::array<covfie::vector::float3>>

Backend type for building covfie fields.

ConstantField

using ActsPlugins::Covfie::ConstantField

Initial value:

 covfie::field<
    covfie::backend::constant<covfie::vector::float3, covfie::vector::float3>>

Constant magnetic field type in covfie format.

InterpolatedField

using ActsPlugins::Covfie::InterpolatedField

Initial value:

 covfie::field<covfie::backend::clamp<
    covfie::backend::affine<covfie::backend::linear<BuilderBackend>>>>

Interpolated magnetic field type in covfie format.

Function Documentation

covfieField() [1/3]

ConstantField ActsPlugins::Covfie::covfieField

(

const Acts::ConstantBField &

magneticField

)

Creates a covfie field from a constant B field.

Parameters

magneticField

The acts constant magnetic field.

Returns

A constant covfie field.

covfieField() [2/3]

InterpolatedField ActsPlugins::Covfie::covfieField

(

const Acts::InterpolatedMagneticField &

magneticField

)

Creates a covfie field from an interpolated magnetic field.

Parameters

magneticField

The acts interpolated magnetic field.

Returns

An affine linear strided covfie field.

covfieField() [3/3]

InterpolatedField ActsPlugins::Covfie::covfieField	(	const Acts::MagneticFieldProvider &	magneticField,
		Acts::MagneticFieldProvider::Cache &	cache,
		const std::array< std::size_t, 3 > &	nPoints,
		const Acts::Vector3 &	min,
		const Acts::Vector3 &	max )

Creates a covfie field from a magnetic field provider by sampling it.

The field must be defined within min (inclusive) and max (inclusive).

Parameters

magneticField	The acts magnetic field provider.
cache	The acts cache.
nPoints	3D array of containing the number of bins for each axis.
min	(min_x, min_y, min_z)
max	(max_x, max_y, max_z)

Returns

An affine linear strided covfie field.