TrkFitter/TrkGaussianSumFilter/TrkGaussianSumFilter/GaussianSumFitter.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TrkGaussianSumFitter_H
#define TrkGaussianSumFitter_H
 
#include "TrkGaussianSumFilter/IMultiStateExtrapolator.h"
#include "TrkGaussianSumFilterUtils/GsfMeasurementUpdator.h"
#include "TrkGaussianSumFilter/GSFTsos.h"
//
#include "TrkTrack/MultiComponentStateOnSurface.h"
//
#include "TrkCaloCluster_OnTrack/CaloCluster_OnTrack.h"
#include "TrkDetElementBase/TrkDetElementBase.h"
#include "TrkEventPrimitives/PropDirection.h"
#include "TrkEventUtils/TrkParametersComparisonFunction.h"
#include "TrkFitterInterfaces/ITrackFitter.h"
#include "TrkFitterUtils/FitterTypes.h"
#include "TrkParameters/TrackParameters.h"
#include "TrkSurfaces/Surface.h"
#include "TrkToolInterfaces/IRIO_OnTrackCreator.h"
//
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/EventContext.h"
#include "GaudiKernel/ToolHandle.h"
//
#include <atomic>
 
namespace Trk {
class IMultiStateMeasurementUpdator;
class MultiComponentStateOnSurface;
class FitQuality;
class Track;
 
class GaussianSumFitter final
  : virtual public ITrackFitter
  , public AthAlgTool
{
public:
  GaussianSumFitter(const std::string&, const std::string&, const IInterface*);
 
  virtual ~GaussianSumFitter() = default;
 
  virtual StatusCode initialize() override final;
 
  virtual std::unique_ptr<Track> fit(
    const EventContext& ctx,
    const Track&,
    const RunOutlierRemoval /*Not used*/,
    const ParticleHypothesis particleHypothesis =
      nonInteracting) const override final;
 
  virtual std::unique_ptr<Track> fit(
    const EventContext& ctx,
    const PrepRawDataSet&,
    const TrackParameters&,
    const RunOutlierRemoval /*Not used*/,
    const ParticleHypothesis particleHypothesis =
      nonInteracting) const override final;
 
  virtual std::unique_ptr<Track> fit(
    const EventContext& ctx,
    const MeasurementSet&,
    const TrackParameters&,
    const RunOutlierRemoval /*Not used*/,
    const ParticleHypothesis particleHypothesis =
      nonInteracting) const override final;
 
  virtual std::unique_ptr<Track> fit(
    const EventContext& ctx,
    const Track&,
    const PrepRawDataSet&,
    const RunOutlierRemoval /*Not used*/,
    const ParticleHypothesis matEffects = nonInteracting) const override final;
 
  virtual std::unique_ptr<Track> fit(
    const EventContext& ctx,
    const Track&,
    const MeasurementSet&,
    const RunOutlierRemoval /*Not used*/,
    const ParticleHypothesis matEffects = nonInteracting) const override final;
 
  virtual std::unique_ptr<Track> fit(
    const EventContext& ctx,
    const Track&,
    const Track&,
    const RunOutlierRemoval /*Not used*/,
    const ParticleHypothesis matEffects = nonInteracting) const override final;
 
 // Internally we can use a simple std::vector
 using GSFTrajectory = std::vector<GSFTsos>;
 
private:
 std::unique_ptr<MultiComponentStateOnSurfaceDV> convertTrajToTrack(
     GSFTrajectory& trajectory) const;
 
 GSFTsos makePerigee(
     const EventContext& ctx,
     Trk::IMultiStateExtrapolator::Cache&,
     const GSFTrajectory& smoothedTrajectory,
     const ParticleHypothesis particleHypothesis = nonInteracting) const;
 
 bool stepForwardFit(
     const EventContext& ctx,
     IMultiStateExtrapolator::Cache&,
     GSFTrajectory& forwardTrajectory,
     const PrepRawData* originalPrepRawData,
     const MeasurementBase* originalMeasurement,
     const Surface& surface,
     MultiComponentState& updatedState,
     const ParticleHypothesis particleHypothesis = nonInteracting) const;
 
 GSFTrajectory forwardPRDfit(
     const EventContext& ctx,
     IMultiStateExtrapolator::Cache& cache,
     const PrepRawDataSet& inputPrepRawDataSet,
     const TrackParameters& estimatedTrackParametersNearOrigin,
     const ParticleHypothesis particleHypothesis = nonInteracting) const;
 
 GSFTrajectory forwardMeasurementFit(
     const EventContext& ctx,
     IMultiStateExtrapolator::Cache& cache,
     const MeasurementSet& inputMeasurementSet,
     const TrackParameters& estimatedTrackParametersNearOrigin,
     const ParticleHypothesis particleHypothesis = nonInteracting) const;
 
 GSFTrajectory smootherFit(
     const EventContext& ctx,
     Trk::IMultiStateExtrapolator::Cache&,
     GSFTrajectory& forwardTrajectory,
     const ParticleHypothesis particleHypothesis = nonInteracting,
     const CaloCluster_OnTrack* ccot = nullptr) const;
 
 MultiComponentState addCCOT(const EventContext& ctx,
           const Trk::CaloCluster_OnTrack* ccot,
           GSFTrajectory& smoothedTrajectory) const;
 
private:
 ToolHandle<IMultiStateExtrapolator> m_extrapolator{
     this,
     "ToolForExtrapolation",
     "Trk::GsfExtrapolator/GsfExtrapolator",
      ""};
 ToolHandle<IRIO_OnTrackCreator> m_rioOnTrackCreator{
     this,
     "ToolForROTCreation", "",
     "Tool for converting Raw Data to measurements if we do not fit "
     "measurements directly"};
 
 Gaudi::Property<unsigned int> m_maximumNumberOfComponents{
     this,
     "MaximumNumberOfComponents",
     12,
     "Maximum number of components"};
 
 Gaudi::Property<bool> m_reintegrateOutliers{
   this,
   "ReintegrateOutliers",
   true,
   "Reintegrate Outliers"};
 
 Gaudi::Property<bool> m_refitOnMeasurementBase{
     this,
     "RefitOnMeasurementBase",
     true,
     "Refit On Measurement Base"};
 
 Gaudi::Property<bool> m_combineWithFitter{
     this,
     "CombineStateWithFitter",
     false,
     "Combine with forwards state during Smoothing"};
 
 Gaudi::Property<bool> m_useMode{
     this,
     "useMode",
     true,
     "Combine/Collapse MultiComponent State Mode rather than mean"};
 
 Gaudi::Property<bool> m_slimTransientMTSOS{
     this,
     "slimTransientMTSOS",
     true,
     "Slim the transient MTSOS . keeping just the combined state and not all "
     "components"};
 
 Gaudi::Property<double> m_cutChiSquaredPerNumberDOF{
     this,
     "StateChi2PerNDOFCut",
     50.,
     "Cut on Chi2 per NDOF"};
 
 PropDirection m_directionToPerigee;
 TrkParametersComparisonFunction m_trkParametersComparisonFunction;
 std::vector<double> m_sortingReferencePoint;
 
};
 
} // end Trk namespace
#endif