MuonExperimental::Gx2FitterOptions< traj_t > Struct Template Reference

Combined options for the Global-Chi-Square fitter. More...

#include <Chi2Fitter.h>

Collaboration diagram for MuonExperimental::Gx2FitterOptions< traj_t >:

Public Member Functions
	Gx2FitterOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx, std::reference_wrapper< const CalibrationContext > cctx, Gx2FitterExtensions< traj_t > extensions_, const PropagatorPlainOptions &pOptions)
	PropagatorOptions with context.

Public Attributes
std::reference_wrapper< const GeometryContext >	geoContext
	Context object for the geometry.
std::reference_wrapper< const MagneticFieldContext >	magFieldContext
	Context object for the magnetic field.
std::reference_wrapper< const CalibrationContext >	calibrationContext
	context object for the calibration
Gx2FitterExtensions< traj_t >	extensions
	Extensions for calibration and outlier finding.
PropagatorPlainOptions	propagatorPlainOptions
	The trivial propagator options.
bool	doMultipleScattering = false
	Whether to consider multiple scattering.
bool	doEnergyLoss = false
	Whether to consider energy loss.
bool	includeMaterialInIter = true
	Flag to toggle whether material is fitted simultaneously with the track parameters or whether the material update is just a small adjustment to the track parameters.
double	scatteringCutOff = 0.
	Cutoff value on the scattering uncertainty to fine tune the number of scattering angles in the fit.
double	elossCutOff = 0.
	Cutoff value on the energy loss to fine tune the number of energy loss parameters in the fit.
FreeToBoundCorrection	freeToBoundCorrection {false}
	Whether to include non-linear correction during global to local transformation.
std::size_t	nUpdateMax = 5
	Max number of iterations during the fit (abort condition).
double	relChi2changeCutOff = 1e-5
	Check for convergence (abort condition). Set to 0 to skip.

Detailed Description

template<typename traj_t>
struct MuonExperimental::Gx2FitterOptions< traj_t >

Combined options for the Global-Chi-Square fitter.

Template Parameters

traj_t

The trajectory type

Definition at line 290 of file Chi2Fitter.h.

Constructor & Destructor Documentation

Gx2FitterOptions()

template<typename traj_t>

MuonExperimental::Gx2FitterOptions< traj_t >::Gx2FitterOptions ( const GeometryContext & gctx, const MagneticFieldContext & mctx, std::reference_wrapper< const CalibrationContext > cctx, Gx2FitterExtensions< traj_t > extensions_, const PropagatorPlainOptions & pOptions )

inline

PropagatorOptions with context.

Parameters

gctx	The geometry context for this fit
mctx	The magnetic context for this fit
cctx	The calibration context for this fit
extensions_	The KF extensions
pOptions	The plain propagator options
rSurface	The reference surface for the fit to be expressed at
mScattering	Whether to include multiple scattering
eLoss	Whether to include energy loss
freeToBoundCorrection_	Correction for non-linearity effect during transform from free to bound
nUpdateMax_	Max number of iterations for updating the parameters
relChi2changeCutOff_	Check for convergence (abort condition). Set to 0 to skip.

Definition at line 304 of file Chi2Fitter.h.

      : geoContext(gctx),
        magFieldContext(mctx),
        calibrationContext(cctx),
        extensions(std::move(extensions_)),
        propagatorPlainOptions(pOptions){}

Member Data Documentation

calibrationContext

template<typename traj_t>

std::reference_wrapper<const CalibrationContext> MuonExperimental::Gx2FitterOptions< traj_t >::calibrationContext

context object for the calibration

Definition at line 321 of file Chi2Fitter.h.

doEnergyLoss

template<typename traj_t>

bool MuonExperimental::Gx2FitterOptions< traj_t >::doEnergyLoss = false

Whether to consider energy loss.

Definition at line 333 of file Chi2Fitter.h.

doMultipleScattering

template<typename traj_t>

bool MuonExperimental::Gx2FitterOptions< traj_t >::doMultipleScattering = false

Whether to consider multiple scattering.

Definition at line 330 of file Chi2Fitter.h.

elossCutOff

template<typename traj_t>

double MuonExperimental::Gx2FitterOptions< traj_t >::elossCutOff = 0.

Cutoff value on the energy loss to fine tune the number of energy loss parameters in the fit.

Definition at line 348 of file Chi2Fitter.h.

extensions

template<typename traj_t>

Gx2FitterExtensions<traj_t> MuonExperimental::Gx2FitterOptions< traj_t >::extensions

Extensions for calibration and outlier finding.

Definition at line 324 of file Chi2Fitter.h.

freeToBoundCorrection

template<typename traj_t>

FreeToBoundCorrection MuonExperimental::Gx2FitterOptions< traj_t >::freeToBoundCorrection {false}

Whether to include non-linear correction during global to local transformation.

Definition at line 352 of file Chi2Fitter.h.

{false};

geoContext

template<typename traj_t>

std::reference_wrapper<const GeometryContext> MuonExperimental::Gx2FitterOptions< traj_t >::geoContext

Context object for the geometry.

Definition at line 317 of file Chi2Fitter.h.

includeMaterialInIter

template<typename traj_t>

bool MuonExperimental::Gx2FitterOptions< traj_t >::includeMaterialInIter = true

Flag to toggle whether material is fitted simultaneously with the track parameters or whether the material update is just a small adjustment to the track parameters.

Definition at line 338 of file Chi2Fitter.h.

magFieldContext

template<typename traj_t>

std::reference_wrapper<const MagneticFieldContext> MuonExperimental::Gx2FitterOptions< traj_t >::magFieldContext

Context object for the magnetic field.

Definition at line 319 of file Chi2Fitter.h.

nUpdateMax

template<typename traj_t>

std::size_t MuonExperimental::Gx2FitterOptions< traj_t >::nUpdateMax = 5

Max number of iterations during the fit (abort condition).

Definition at line 355 of file Chi2Fitter.h.

propagatorPlainOptions

template<typename traj_t>

PropagatorPlainOptions MuonExperimental::Gx2FitterOptions< traj_t >::propagatorPlainOptions

The trivial propagator options.

Definition at line 327 of file Chi2Fitter.h.

relChi2changeCutOff

template<typename traj_t>

double MuonExperimental::Gx2FitterOptions< traj_t >::relChi2changeCutOff = 1e-5

Check for convergence (abort condition). Set to 0 to skip.

Definition at line 358 of file Chi2Fitter.h.

scatteringCutOff

template<typename traj_t>

double MuonExperimental::Gx2FitterOptions< traj_t >::scatteringCutOff = 0.

Cutoff value on the scattering uncertainty to fine tune the number of scattering angles in the fit.

Instead of creating scattering states at each material surface, a scatterer is only created if the uncertainy on the theta scattering angle exceeds the threshold. Otherwise the material is accumulated

Definition at line 345 of file Chi2Fitter.h.

---

The documentation for this struct was generated from the following file:

• Chi2Fitter.h