MuonR4::FitterTool Class Reference

#include <FitterTool.h>

Inheritance diagram for MuonR4::FitterTool:

Collaboration diagram for MuonR4::FitterTool:

Public Types
using	StraightPropagator_t = Acts::Propagator<Acts::StraightLineStepper, Acts::Navigator>
	Abrivation for the straight line propagator.
using	CurvedPropagator_t = Acts::Propagator<Acts::EigenStepper<>, Acts::Navigator>
	Abrivation for the curved standard propagator.
using	StraightFitter_t = MuonExperimental::Gx2Fitter<StraightPropagator_t, ActsTrk::MutableTrackStateBackend>
	Abrivation of the fitter using the straight line propagator.
using	CurvedFitter_t = MuonExperimental::Gx2Fitter<CurvedPropagator_t, ActsTrk::MutableTrackStateBackend>
	Abrivation of the fitter using the curved line propagator.
using	Gx2FitterOptions_t = MuonExperimental::Gx2FitterOptions<ActsTrk::MutableTrackStateBackend>
	Abbrivation of the configuration to launch the fit.
using	Gx2FitterExtension_t = MuonExperimental::Gx2FitterExtensions<ActsTrk::MutableTrackStateBackend>
	Abbrivation of the fitter extensions.

Public Member Functions
virtual StatusCode	initialize () override final
virtual std::unique_ptr< ActsTrk::MutableTrackContainer >	fit (const ActsTrk::Seed &seed, const Acts::BoundTrackParameters &initialParams, const Acts::GeometryContext &tgContext, const Acts::MagneticFieldContext &mfContext, const Acts::CalibrationContext &calContext, const Acts::Surface &targetSurface) const override final
	Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.
virtual std::unique_ptr< ActsTrk::MutableTrackContainer >	fit (const std::vector< const xAOD::UncalibratedMeasurement * > &measList, const Acts::BoundTrackParameters &initialParams, const Acts::GeometryContext &tgContext, const Acts::MagneticFieldContext &mfContext, const Acts::CalibrationContext &calContext, const Acts::Surface *targetSurface=nullptr) const override final
	Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.
virtual std::unique_ptr< ActsTrk::MutableTrackContainer >	fit (const std::vector< Acts::SourceLink > &sourceLinks, const Acts::BoundTrackParameters &initialParams, const Acts::GeometryContext &tgContext, const Acts::MagneticFieldContext &mfContext, const Acts::CalibrationContext &calContext, const Acts::Surface *targetSurface=nullptr) const override final
	Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.
virtual StatusCode	fit (const EventContext &ctx, const ActsTrk::TrackContainer::ConstTrackProxy &track, ActsTrk::MutableTrackContainer &trackContainer, const Acts::PerigeeSurface &pSurface) const override final
	Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.

Private Types
using	Fitter_t

Private Attributes
Gaudi::Property< bool >	m_doStraightLineFit {this, "doStraightLine", false}
	Do the straight line fit.
Gaudi::Property< unsigned >	m_doMaxSteps {this, "maxSteps", 1000000 }
	How ,many steps to go.
Gaudi::Property< unsigned >	m_maxSurfaces {this, "maxSurfaces", 10000}
	How many surfaces to try.
Gaudi::Property< unsigned >	m_maxIter {this, "nIterMax" , 250}
	How many iterations to use in the fit.
Gaudi::Property< bool >	m_doEnergyLoss {this, "doEnergyLoss" , false}
	Do energy loss modelling in the fit.
Gaudi::Property< bool >	m_doScattering {this, "doScattering" , false}
	Increase the nuissances by introducing scattering angles.
ServiceHandle< ActsTrk::ITrackingGeometrySvc >	m_trackingGeometrySvc
	Tracking geometry service.
ToolHandle< MuonR4::ISpacePointCalibrator >	m_muonCalibrator {this, "MuonCalibrationTool", ""}
	Tool handle to calibrate the muon measurmeents.
ActsTrk::detail::xAODUncalibMeasSurfAcc	m_unalibMeasSurfAcc {}
	Surface accessor delegate for xAOD::UncalibratedMeasurement objects.
ActsTrk::detail::xAODUncalibMeasCalibrator	m_uncalibMeasCalibrator {}
	Calibrator for the uncalibrated xAOD::UnCalibratedMeasurement objects.
Gx2FitterExtension_t	m_extensions {}
Fitter_t	m_fitter {}

Detailed Description

Definition at line 34 of file FitterTool.h.

Member Typedef Documentation

CurvedFitter_t

using MuonR4::FitterTool::CurvedFitter_t = MuonExperimental::Gx2Fitter<CurvedPropagator_t, ActsTrk::MutableTrackStateBackend>

Abrivation of the fitter using the curved line propagator.

Definition at line 76 of file FitterTool.h.

CurvedPropagator_t

using MuonR4::FitterTool::CurvedPropagator_t = Acts::Propagator<Acts::EigenStepper<>, Acts::Navigator>

Abrivation for the curved standard propagator.

Definition at line 72 of file FitterTool.h.

Fitter_t

using MuonR4::FitterTool::Fitter_t

private

Initial value:

std::variant<std::monostate,
                                        StraightFitter_t, 
                                        CurvedFitter_t>

Definition at line 108 of file FitterTool.h.

Gx2FitterExtension_t

using MuonR4::FitterTool::Gx2FitterExtension_t = MuonExperimental::Gx2FitterExtensions<ActsTrk::MutableTrackStateBackend>

Abbrivation of the fitter extensions.

Definition at line 81 of file FitterTool.h.

Gx2FitterOptions_t

using MuonR4::FitterTool::Gx2FitterOptions_t = MuonExperimental::Gx2FitterOptions<ActsTrk::MutableTrackStateBackend>

Abbrivation of the configuration to launch the fit.

Definition at line 79 of file FitterTool.h.

StraightFitter_t

using MuonR4::FitterTool::StraightFitter_t = MuonExperimental::Gx2Fitter<StraightPropagator_t, ActsTrk::MutableTrackStateBackend>

Abrivation of the fitter using the straight line propagator.

Definition at line 74 of file FitterTool.h.

StraightPropagator_t

using MuonR4::FitterTool::StraightPropagator_t = Acts::Propagator<Acts::StraightLineStepper, Acts::Navigator>

Abrivation for the straight line propagator.

Definition at line 70 of file FitterTool.h.

Member Function Documentation

fit() [1/4]

std::unique_ptr< ActsTrk::MutableTrackContainer > MuonR4::FitterTool::fit ( const ActsTrk::Seed & seed, const Acts::BoundTrackParameters & initialParams, const Acts::GeometryContext & tgContext, const Acts::MagneticFieldContext & mfContext, const Acts::CalibrationContext & calContext, const Acts::Surface & targetSurface ) const

finaloverridevirtual

Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.

For a better fit convergence, this method also takes an external estimate of the track parameters

Parameters

seed	Reference to the riplet of ITk/ID space points to fit.
initialParams	Rough parameter estimate used to start the fit
tgContext	Geometry context to fetch the aligned positions of each surface
mfContext	Reference to the magnetic field context having the ATLAS magnetic field wrapped
calContext	Reference to the CalibrationContext which is wrapping the pointer to the Gaudi-event context

Returns

: In case of fit-failure, a nullptr otherwise a unique_ptr to the fitted trajectories from the fit

Definition at line 50 of file FitterTool.cxx.

                                                    {
        THROW_EXCEPTION("Method is not implemented");
        return nullptr;
    }

fit() [2/4]

StatusCode MuonR4::FitterTool::fit ( const EventContext & ctx, const ActsTrk::TrackContainer::ConstTrackProxy & track, ActsTrk::MutableTrackContainer & trackContainer, const Acts::PerigeeSurface & pSurface ) const

finaloverridevirtual

Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.

For a better fit convergence, this method also takes an external estimate of the track parameters

Parameters

seed	Reference to the riplet of ITk/ID space points to fit.
initialParams	Rough parameter estimate used to start the fit
tgContext	Geometry context to fetch the aligned positions of each surface
mfContext	Reference to the magnetic field context having the ATLAS magnetic field wrapped
calContext	Reference to the CalibrationContext which is wrapping the pointer to the Gaudi-event context

Returns

: In case of fit-failure, a nullptr otherwise a unique_ptr to the fitted trajectories from the fit

Definition at line 42 of file FitterTool.cxx.

                                                                  {
        ATH_MSG_ERROR(__func__<<"() "<<__LINE__<<" - The method is not implemented");
        return StatusCode::FAILURE;
    }

fit() [3/4]

std::unique_ptr< ActsTrk::MutableTrackContainer > MuonR4::FitterTool::fit ( const std::vector< Acts::SourceLink > & sourceLinks, const Acts::BoundTrackParameters & initialParams, const Acts::GeometryContext & tgContext, const Acts::MagneticFieldContext & mfContext, const Acts::CalibrationContext & calContext, const Acts::Surface * targetSurface = nullptr ) const

finaloverridevirtual

Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.

For a better fit convergence, this method also takes an external estimate of the track parameters

Parameters

seed	Reference to the riplet of ITk/ID space points to fit.
initialParams	Rough parameter estimate used to start the fit
tgContext	Geometry context to fetch the aligned positions of each surface
mfContext	Reference to the magnetic field context having the ATLAS magnetic field wrapped
calContext	Reference to the CalibrationContext which is wrapping the pointer to the Gaudi-event context

Returns

: In case of fit-failure, a nullptr otherwise a unique_ptr to the fitted trajectories from the fit

Definition at line 75 of file FitterTool.cxx.

                                                    {
 
        Acts::PropagatorPlainOptions propagationOption{tgContext, mfContext};
        propagationOption.maxSteps = m_doMaxSteps;
        propagationOption.maxTargetSkipping = m_maxSurfaces;
    
        Gx2FitterOptions_t options{tgContext, mfContext, calContext, 
                                    m_extensions, std::move(propagationOption)}; 
                                    
        options.doMultipleScattering = m_doScattering;
        options.doEnergyLoss = m_doEnergyLoss;
        options.nUpdateMax = m_maxIter;
        auto tracks = std::make_unique<ActsTrk::MutableTrackContainer>(ActsTrk::MutableTrackBackend{},
                                                                       ActsTrk::MutableTrackStateBackend{});
 
        bool ok{false};
        std::visit([&](const auto& fitter) {
            using Fitter_t = std::decay_t<decltype(fitter)>;
            if constexpr(std::is_same_v<Fitter_t, std::monostate>) {
                ATH_MSG_WARNING("The fitter is uninitalized. That should not happen");
            } else {
                ok = fitter.fit(sourceLinks.begin(), sourceLinks.end(), 
                                initialParams, options, *tracks).ok();
            }
        }, m_fitter);
        if (!ok) {
            ATH_MSG_VERBOSE("Fit failed");
            return nullptr;
        }
        ActsTrk::TrackContainerUtils::addFitterTypeProperty(*tracks);
        for (auto trkProxy : *tracks) {
            ActsTrk::TrackContainerUtils::setFitterType(trkProxy, xAOD::TrackFitter::GlobalChi2Fitter);
        }
        return tracks;
    }

fit() [4/4]

std::unique_ptr< ActsTrk::MutableTrackContainer > MuonR4::FitterTool::fit ( const std::vector< const xAOD::UncalibratedMeasurement * > & measList, const Acts::BoundTrackParameters & initialParams, const Acts::GeometryContext & tgContext, const Acts::MagneticFieldContext & mfContext, const Acts::CalibrationContext & calContext, const Acts::Surface * targetSurface = nullptr ) const

finaloverridevirtual

Tries to fit a short-line track from an initial ITk/ID seed made up out of three spacepoints.

For a better fit convergence, this method also takes an external estimate of the track parameters

Parameters

seed	Reference to the riplet of ITk/ID space points to fit.
initialParams	Rough parameter estimate used to start the fit
tgContext	Geometry context to fetch the aligned positions of each surface
mfContext	Reference to the magnetic field context having the ATLAS magnetic field wrapped
calContext	Reference to the CalibrationContext which is wrapping the pointer to the Gaudi-event context

Returns

: In case of fit-failure, a nullptr otherwise a unique_ptr to the fitted trajectories from the fit

Definition at line 60 of file FitterTool.cxx.

                                                                {
        std::vector<Acts::SourceLink> sourceLinks{};
        std::ranges::transform(measList, std::back_inserter(sourceLinks),
                               [](const xAOD::UncalibratedMeasurement* m ){
                                    return ActsTrk::detail::xAODUncalibMeasCalibrator::pack(m);
                               });
        return fit (sourceLinks, initialParams, tgContext, mfContext, calContext, targetSurface);
 
    }

initialize()

StatusCode MuonR4::FitterTool::initialize ( )

finaloverridevirtual

Definition at line 16 of file FitterTool.cxx.

                                      {
        ATH_CHECK(m_trackingGeometrySvc.retrieve());
        ATH_CHECK(m_muonCalibrator.retrieve());
        m_unalibMeasSurfAcc = xAODUncalibMeasSurfAcc{m_trackingGeometrySvc.get()};
        for (const xAOD::UncalibMeasType type : xAOD::muonMeasurementTypes()) {
            m_uncalibMeasCalibrator.connect<&MuonR4::ISpacePointCalibrator::calibrateSourceLink>(type, m_muonCalibrator.get());
        }
        
        m_extensions.surfaceAccessor.connect<&ActsTrk::detail::xAODUncalibMeasSurfAcc::operator()>(&m_unalibMeasSurfAcc);
        m_extensions.calibrator.connect<&ActsTrk::detail::xAODUncalibMeasCalibrator::calibrate>(&m_uncalibMeasCalibrator);
        auto logger = makeActsAthenaLogger(this, "MuonTrackFit");
 
        Acts::Navigator::Config navConfig{m_trackingGeometrySvc->trackingGeometry()};
        Acts::Navigator navigator(std::move(navConfig), logger->cloneWithSuffix("Navigator"));
        if (!m_doStraightLineFit) {
            CurvedPropagator_t::Stepper stepper{std::make_shared<ATLASMagneticFieldWrapper>()};
            CurvedPropagator_t propagator{std::move(stepper), 
                                         std::move(navigator), logger->cloneWithSuffix("Prop")};
            m_fitter = CurvedFitter_t{std::move(propagator), logger->cloneWithSuffix("Fitter")};
        } else {
           StraightPropagator_t propagator{Acts::StraightLineStepper{}, 
                                            std::move(navigator), logger->cloneWithSuffix("Prop")};
            m_fitter = StraightFitter_t{std::move(propagator), logger->cloneWithSuffix("Fitter")};
        }
        return StatusCode::SUCCESS;
    }

Member Data Documentation

m_doEnergyLoss

Gaudi::Property<bool> MuonR4::FitterTool::m_doEnergyLoss {this, "doEnergyLoss" , false}

private

Do energy loss modelling in the fit.

Definition at line 92 of file FitterTool.h.

{this, "doEnergyLoss" , false};

m_doMaxSteps

Gaudi::Property<unsigned> MuonR4::FitterTool::m_doMaxSteps {this, "maxSteps", 1000000 }

private

How ,many steps to go.

Definition at line 86 of file FitterTool.h.

{this, "maxSteps", 1000000 };

m_doScattering

Gaudi::Property<bool> MuonR4::FitterTool::m_doScattering {this, "doScattering" , false}

private

Increase the nuissances by introducing scattering angles.

Definition at line 94 of file FitterTool.h.

{this, "doScattering" , false};

m_doStraightLineFit

Gaudi::Property<bool> MuonR4::FitterTool::m_doStraightLineFit {this, "doStraightLine", false}

private

Do the straight line fit.

Definition at line 84 of file FitterTool.h.

{this, "doStraightLine", false};

m_extensions

Gx2FitterExtension_t MuonR4::FitterTool::m_extensions {}

private

Definition at line 106 of file FitterTool.h.

{};

m_fitter

Fitter_t MuonR4::FitterTool::m_fitter {}

private

Definition at line 111 of file FitterTool.h.

{};

m_maxIter

Gaudi::Property<unsigned> MuonR4::FitterTool::m_maxIter {this, "nIterMax" , 250}

private

How many iterations to use in the fit.

Definition at line 90 of file FitterTool.h.

{this, "nIterMax" , 250};

m_maxSurfaces

Gaudi::Property<unsigned> MuonR4::FitterTool::m_maxSurfaces {this, "maxSurfaces", 10000}

private

How many surfaces to try.

Definition at line 88 of file FitterTool.h.

{this, "maxSurfaces", 10000};

m_muonCalibrator

ToolHandle<MuonR4::ISpacePointCalibrator> MuonR4::FitterTool::m_muonCalibrator {this, "MuonCalibrationTool", ""}

private

Tool handle to calibrate the muon measurmeents.

Definition at line 99 of file FitterTool.h.

{this, "MuonCalibrationTool", ""};

m_trackingGeometrySvc

ServiceHandle<ActsTrk::ITrackingGeometrySvc> MuonR4::FitterTool::m_trackingGeometrySvc

private

Initial value:

{this, "TrackingGeometrySvc", 
                                                                                "ActsTrackingGeometrySvc"}

Tracking geometry service.

Definition at line 96 of file FitterTool.h.

                                                                            {this, "TrackingGeometrySvc", 
                                                                                "ActsTrackingGeometrySvc"};

m_unalibMeasSurfAcc

ActsTrk::detail::xAODUncalibMeasSurfAcc MuonR4::FitterTool::m_unalibMeasSurfAcc {}

private

Surface accessor delegate for xAOD::UncalibratedMeasurement objects.

Definition at line 102 of file FitterTool.h.

{};

m_uncalibMeasCalibrator

ActsTrk::detail::xAODUncalibMeasCalibrator MuonR4::FitterTool::m_uncalibMeasCalibrator {}

private

Calibrator for the uncalibrated xAOD::UnCalibratedMeasurement objects.

Definition at line 104 of file FitterTool.h.

{};

---

The documentation for this class was generated from the following files:

• FitterTool.h
• FitterTool.cxx