ActsTrk::ActsToTrkFitterWrapTool Class Reference

Tool wrapping an ACTS track fitter tool to expose the Trk::ITrackFitter interface. More...

#include <ActsToTrkFitterWrapTool.h>

Inheritance diagram for ActsTrk::ActsToTrkFitterWrapTool:

Collaboration diagram for ActsTrk::ActsToTrkFitterWrapTool:

Public Member Functions
	~ActsToTrkFitterWrapTool ()=default
StatusCode	initialize () override
virtual std::unique_ptr< Trk::Track >	fit (const EventContext &ctx, const Trk::Track &track, const Trk::RunOutlierRemoval runOutlier=false, const Trk::ParticleHypothesis hypothesis=Trk::nonInteracting) const override
	Re-fit a track using the ACTS fitter tool.
virtual std::unique_ptr< Trk::Track >	fit (const EventContext &ctx, const Trk::Track &track, const Trk::MeasurementSet &measSet, const Trk::RunOutlierRemoval runOutlier=false, const Trk::ParticleHypothesis hypothesis=Trk::nonInteracting) const override
	Re-fit a track adding a fittable measurement set.
virtual std::unique_ptr< Trk::Track >	fit (const EventContext &ctx, const Trk::Track &track, const Trk::PrepRawDataSet &prepRawSet, const Trk::RunOutlierRemoval runOutlier=false, const Trk::ParticleHypothesis hypothesis=Trk::nonInteracting) const override
	Re-fit a track adding a set of prepared raw data.
virtual std::unique_ptr< Trk::Track >	fit (const EventContext &ctx, const Trk::PrepRawDataSet &prepRawSet, const Trk::TrackParameters &params, const Trk::RunOutlierRemoval runOutlier=false, const Trk::ParticleHypothesis hypothesis=Trk::nonInteracting) const override
	Fit a track to a set of prepared raw data.
virtual std::unique_ptr< Trk::Track >	fit (const EventContext &ctx, const Trk::MeasurementSet &measSet, const Trk::TrackParameters &params, const Trk::RunOutlierRemoval runOutlier=false, const Trk::ParticleHypothesis hypothesis=Trk::nonInteracting) const override
	Fit a track to a set of measurements.
virtual std::unique_ptr< Trk::Track >	fit (const EventContext &ctx, const Trk::Track &track1, const Trk::Track &track2, const Trk::RunOutlierRemoval runOutlier=false, const Trk::ParticleHypothesis hypothesis=Trk::nonInteracting) const override
	Combines two tracks by fitting them together.

Private Member Functions
std::unique_ptr< Trk::Track >	reFitImpl (const EventContext &ctx, const Trk::Track &track, const std::vector< Acts::SourceLink > &measColl, const Trk::ParticleHypothesis hypothesis, const bool useScaledCov=false) const
	Implementation of the logic for re-fitting a track adding a set of measurements passed as source links.
std::unique_ptr< Trk::Track >	fitImpl (const EventContext &ctx, const std::vector< Acts::SourceLink > &measColl, const Acts::BoundTrackParameters &params) const
	Implementation of the logic for fitting a track to a set of measurements passed as source links.

Private Attributes
ToolHandle< IFitterTool >	m_actsFitterTool {this, "ActsFitterTool", ""}
	The underlying Acts fitter tool.
ToolHandle< ITrackConverterTool >	m_ATLASConverterTool {this, "ATLASConverterTool", ""}
	Track converter tool for converting Acts tracks to ATLAS tracks.
PublicToolHandle< IGeometryRealmConvTool >	m_geometryConvTool {this, "GeometryRealmConvTool", ""}
	Geometry realm converter tool.
ContextUtility	m_ctxProvider {this}
	Auxiliary class to access the magnetic field, geometry and calibration context.
Gaudi::Property< double >	m_option_seedCovarianceScale
	Property for the seed covariance scale factor.

Detailed Description

Tool wrapping an ACTS track fitter tool to expose the Trk::ITrackFitter interface.

The EDM objects are piped to the Acts::IFitterTool interface and processed by the ACTS infrastructure. The successful fit result is then converted back to a Trk::Track object. The wrapper leverages the usage of the ACTS fitters in the legacy reconstruction framework and is mainly meant to be used for validation and testing purposes.

Definition at line 29 of file ActsToTrkFitterWrapTool.h.

Constructor & Destructor Documentation

~ActsToTrkFitterWrapTool()

ActsTrk::ActsToTrkFitterWrapTool::~ActsToTrkFitterWrapTool ( )

default

Member Function Documentation

fit() [1/6]

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::fit ( const EventContext & ctx, const Trk::MeasurementSet & measSet, const Trk::TrackParameters & params, const Trk::RunOutlierRemoval runOutlier = false, const Trk::ParticleHypothesis hypothesis = Trk::nonInteracting ) const

overridevirtual

Fit a track to a set of measurements.

Parameters

ctx	The event context.
measSet	The measurement set.
params	The initial track parameters.
runOutlier	Whether to run outlier removal.
hypothesis	The particle hypothesis.

Returns

A unique pointer to the fitted track.

Definition at line 79 of file ActsToTrkFitterWrapTool.cxx.

                                                                  {
 
    std::vector<Acts::SourceLink> sourceLinks;
    detail::MeasurementCalibratorBase::pack(prepRawSet, sourceLinks);
 
    const auto initialParams = m_geometryConvTool->convertTrackParametersToActs(ctx, params); 
 
    return fitImpl(ctx, sourceLinks, initialParams);
}

fit() [2/6]

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::fit ( const EventContext & ctx, const Trk::PrepRawDataSet & prepRawSet, const Trk::TrackParameters & params, const Trk::RunOutlierRemoval runOutlier = false, const Trk::ParticleHypothesis hypothesis = Trk::nonInteracting ) const

overridevirtual

Fit a track to a set of prepared raw data.

Parameters

ctx	The event context.
prepRawSet	The set of prepared raw data.
params	The initial track parameters.
runOutlier	Whether to run outlier removal.
hypothesis	The particle hypothesis.

Returns

A unique pointer to the fitted track.

Definition at line 64 of file ActsToTrkFitterWrapTool.cxx.

                                                                  {
    
    std::vector<Acts::SourceLink> sourceLinks;
    detail::MeasurementCalibratorBase::pack(prepRawSet, sourceLinks);
 
    const auto initialParams = m_geometryConvTool->convertTrackParametersToActs(ctx, params); 
    
    return fitImpl(ctx, sourceLinks, initialParams);
}

fit() [3/6]

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::fit ( const EventContext & ctx, const Trk::Track & track, const Trk::MeasurementSet & measSet, const Trk::RunOutlierRemoval runOutlier = false, const Trk::ParticleHypothesis hypothesis = Trk::nonInteracting ) const

overridevirtual

Re-fit a track adding a fittable measurement set.

Parameters

ctx	The event context.
track	The input track.
measSet	The measurement set to add.
runOutlier	Whether to run outlier removal.
hypothesis	The particle hypothesis.

Returns

A unique pointer to the fitted track.

Definition at line 34 of file ActsToTrkFitterWrapTool.cxx.

                                                                           {
    
    std::vector<Acts::SourceLink> sourceLinks;
    detail::MeasurementCalibratorBase::pack(measSet, sourceLinks);
 
    bool useScaledCov = false;
 
    return reFitImpl(ctx, track, sourceLinks, hypothesis, useScaledCov);
}

fit() [4/6]

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::fit ( const EventContext & ctx, const Trk::Track & track, const Trk::PrepRawDataSet & prepRawSet, const Trk::RunOutlierRemoval runOutlier = false, const Trk::ParticleHypothesis hypothesis = Trk::nonInteracting ) const

overridevirtual

Re-fit a track adding a set of prepared raw data.

Parameters

ctx	The event context.
track	The input track.
prepRawSet	The set of prepared raw data to add.
runOutlier	Whether to run outlier removal.
hypothesis	The particle hypothesis.

Returns

A unique pointer to the fitted track.

Definition at line 49 of file ActsToTrkFitterWrapTool.cxx.

                                                                           {
 
    std::vector<Acts::SourceLink> sourceLinks;
    detail::MeasurementCalibratorBase::pack(prepRawSet, sourceLinks);
 
    bool useScaledCov = false;
 
    return reFitImpl(ctx, track, sourceLinks, hypothesis, useScaledCov);
}

fit() [5/6]

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::fit ( const EventContext & ctx, const Trk::Track & track, const Trk::RunOutlierRemoval runOutlier = false, const Trk::ParticleHypothesis hypothesis = Trk::nonInteracting ) const

overridevirtual

Re-fit a track using the ACTS fitter tool.

Parameters

ctx	The event context.
track	The input track.
runOutlier	Whether to run outlier removal.
hypothesis	The particle hypothesis.

Returns

A unique pointer to the fitted track.

Definition at line 24 of file ActsToTrkFitterWrapTool.cxx.

                                                                           {
 
    bool useScaledCov = std::abs(m_option_seedCovarianceScale - 1.0) > Acts::s_epsilon;
 
    return reFitImpl(ctx, track, {}, hypothesis, useScaledCov);
}

fit() [6/6]

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::fit ( const EventContext & ctx, const Trk::Track & track1, const Trk::Track & track2, const Trk::RunOutlierRemoval runOutlier = false, const Trk::ParticleHypothesis hypothesis = Trk::nonInteracting ) const

overridevirtual

Combines two tracks by fitting them together.

Parameters

ctx	The event context.
track1	The first track.
track2	The second track.
runOutlier	Whether to run outlier removal.
hypothesis	The particle hypothesis.

Returns

A unique pointer to the combined track.

Definition at line 94 of file ActsToTrkFitterWrapTool.cxx.

                                                                           {
    ATH_MSG_VERBOSE ("--> enter ActsToTrkFitterWrapTool::fit(Track,Track,)"
        << "with Tracks from #1 = " << track1.info().dumpInfo()
                    << " and #2 = " << track2.info().dumpInfo());
 
    // protection, if empty track2
    if (!track2.measurementsOnTrack()) {
        ATH_MSG_DEBUG( "input #2 is empty try to fit track 1 alone" );
        return fit(ctx,track1);
    }
 
    // protection, if empty track1
    if (!track1.measurementsOnTrack()) {
        ATH_MSG_DEBUG( "input #1 is empty try to fit track 2 alone" );
        return fit(ctx,track2);
    }
 
    std::vector<Acts::SourceLink> trackSourceLinks2 = m_ATLASConverterTool->trkTrackToSourceLinks(track2);
 
    bool useScaledCov = std::abs(m_option_seedCovarianceScale - 1.0) > Acts::s_epsilon;
 
    return reFitImpl(ctx, track1, trackSourceLinks2, hypothesis, useScaledCov);
}

fitImpl()

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::fitImpl ( const EventContext & ctx, const std::vector< Acts::SourceLink > & measColl, const Acts::BoundTrackParameters & params ) const

private

Implementation of the logic for fitting a track to a set of measurements passed as source links.

Parameters

ctx	The event context.
measColl	The collection of measurements.
params	The initial track parameters.

Returns

A unique pointer to the fitted track.

Definition at line 161 of file ActsToTrkFitterWrapTool.cxx.

                                                                             {
    ATH_MSG_VERBOSE ("--> enter ActsToTrkFitterWrapTool::fitImpl(measColl,)"
       << " with nMeas = " << measColl.size());
 
    // protection against not having measurements on the input track
    if (measColl.size() < 2) {
        ATH_MSG_DEBUG("called to refit empty measurement set or a measurement set with too little information, reject fit");
        return nullptr;
    }
 
    // Construct a perigee surface as the target surface
    auto pSurface = Acts::Surface::makeShared<Acts::PerigeeSurface>(Acts::Vector3::Zero());
  
    const Acts::GeometryContext tgContext{m_ctxProvider.getGeometryContext(ctx)};
    const Acts::MagneticFieldContext mfContext{m_ctxProvider.getMagneticFieldContext(ctx)};
    const Acts::CalibrationContext calContext{m_ctxProvider.getCalibrationContext(ctx)};
 
    std::unique_ptr<MutableTrackContainer> outTracks = 
        m_actsFitterTool->fit(measColl, params, tgContext, mfContext, calContext, pSurface.get());
    
    if (!outTracks || outTracks->size() == 0 ) {
        ATH_MSG_DEBUG("Acts fitter failed to refit the track, reject fit");
        return nullptr;
    }
 
    // We expect only one track to be returned
    for (auto trkProxy : *outTracks) {
 
        xAOD::TrackFitter fitterType = TrackContainerUtils::hasFitterType(trkProxy) 
            ? TrackContainerUtils::fitterType(trkProxy) 
            : xAOD::TrackFitter::Unknown;
 
        std::unique_ptr<Trk::Track> convertedTrack = 
            m_ATLASConverterTool->convertActsToTrk(ctx, trkProxy, toTrkFitterType(fitterType));
 
        if (convertedTrack) {
            return convertedTrack;
        }     
    }
    return nullptr;                            
}                     

initialize()

StatusCode ActsTrk::ActsToTrkFitterWrapTool::initialize ( )

override

Definition at line 15 of file ActsToTrkFitterWrapTool.cxx.

                                               {
    ATH_CHECK(m_actsFitterTool.retrieve());
    ATH_CHECK(m_ATLASConverterTool.retrieve());
    ATH_CHECK(m_geometryConvTool.retrieve());
    ATH_CHECK(m_ctxProvider.initialize());
    return StatusCode::SUCCESS;
}

reFitImpl()

std::unique_ptr< Trk::Track > ActsTrk::ActsToTrkFitterWrapTool::reFitImpl ( const EventContext & ctx, const Trk::Track & track, const std::vector< Acts::SourceLink > & measColl, const Trk::ParticleHypothesis hypothesis, const bool useScaledCov = false ) const

private

Implementation of the logic for re-fitting a track adding a set of measurements passed as source links.

Parameters

ctx	The event context.
track	The input track.
measColl	The collection of measurements.
hypothesis	The particle hypothesis.
useScaledCov	Whether to use scaled covariance.

Returns

A unique pointer to the re-fitted track.

Definition at line 123 of file ActsToTrkFitterWrapTool.cxx.

                                                                  {
    ATH_MSG_VERBOSE ("--> enter ActsToTrkFitterWrapTool::reFitImpl(Track,measColl,)"
       << " with Track from author = " << track.info().dumpInfo());
 
    // protection against not having measurements on the input track
    if (!track.measurementsOnTrack() || (track.measurementsOnTrack()->size() < 2 && measColl.empty())) {
        ATH_MSG_DEBUG("called to refit empty track or track with too little information, reject fit");
        return nullptr;
    }
 
    // protection against not having track parameters on the input track
    if (!track.trackParameters() || track.trackParameters()->empty()) {
        ATH_MSG_DEBUG("input fails to provide track parameters for seeding the fitter, reject fit");
        return nullptr;
    }
 
    std::vector<Acts::SourceLink> trackSourceLinks = m_ATLASConverterTool->trkTrackToSourceLinks(track);
    trackSourceLinks.insert(trackSourceLinks.end(), std::make_move_iterator(measColl.begin()), 
                            std::make_move_iterator(measColl.end()));
 
    auto initialParams = m_geometryConvTool->convertTrackParametersToActs(ctx, *track.perigeeParameters());
    if (useScaledCov) {
        // The covariance from already fitted track are too small and would result an incorect smoothing.
        // We scale up the input covaraiance to avoid this.
        Acts::BoundMatrix scaledCov = m_option_seedCovarianceScale * (*initialParams.covariance());
        initialParams = Acts::BoundTrackParameters(initialParams.referenceSurface().getSharedPtr(),
                                                   initialParams.parameters(),
                                                   scaledCov, ParticleHypothesis::convert(hypothesis));
    }
 
    return fitImpl(ctx, trackSourceLinks, initialParams);
}

Member Data Documentation

m_actsFitterTool

ToolHandle<IFitterTool> ActsTrk::ActsToTrkFitterWrapTool::m_actsFitterTool {this, "ActsFitterTool", ""}

private

The underlying Acts fitter tool.

Definition at line 148 of file ActsToTrkFitterWrapTool.h.

{this, "ActsFitterTool", ""};

m_ATLASConverterTool

ToolHandle<ITrackConverterTool> ActsTrk::ActsToTrkFitterWrapTool::m_ATLASConverterTool {this, "ATLASConverterTool", ""}

private

Track converter tool for converting Acts tracks to ATLAS tracks.

Definition at line 151 of file ActsToTrkFitterWrapTool.h.

{this, "ATLASConverterTool", ""};

m_ctxProvider

ContextUtility ActsTrk::ActsToTrkFitterWrapTool::m_ctxProvider {this}

private

Auxiliary class to access the magnetic field, geometry and calibration context.

Definition at line 155 of file ActsToTrkFitterWrapTool.h.

{this};

m_geometryConvTool

PublicToolHandle<IGeometryRealmConvTool> ActsTrk::ActsToTrkFitterWrapTool::m_geometryConvTool {this, "GeometryRealmConvTool", ""}

private

Geometry realm converter tool.

Definition at line 153 of file ActsToTrkFitterWrapTool.h.

{this, "GeometryRealmConvTool", ""};

m_option_seedCovarianceScale

Gaudi::Property< double > ActsTrk::ActsToTrkFitterWrapTool::m_option_seedCovarianceScale

private

Initial value:

{this, "SeedCovarianceScale", 1.,
      "Scale factor for the input seed covariance when doing refitting"}

Property for the seed covariance scale factor.

Definition at line 157 of file ActsToTrkFitterWrapTool.h.

                                                         {this, "SeedCovarianceScale", 1.,
      "Scale factor for the input seed covariance when doing refitting"};

---

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

• ActsToTrkFitterWrapTool.h
• ActsToTrkFitterWrapTool.cxx