MeasurementToTrackParticleDecorationAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

// Header file for class MeasurementToTrackParticleDecoration
//
// The algorithm extends xAOD::TrackParticles
// with additional decorations associated to measurements,
// i.e. residuals, pulls, modules
//
 
#ifndef MEASUREMENTTOTRACKPARTICLEDECORATIONALG_H
#define MEASUREMENTTOTRACKPARTICLEDECORATIONALG_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
 
#include "StoreGate/ReadHandleKey.h"
 
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/WriteDecorHandle.h"
 
#include "xAODTracking/TrackParticleContainer.h"
#include "Acts/Definitions/Units.hpp"
#include "ActsEvent/TrackContainer.h"
#include "ActsEvent/ContextUtility.h"
#include "Acts/EventData/TrackStateProxy.hpp"
 
 
namespace ActsTrk {
 
    class MeasurementToTrackParticleDecorationAlg : public AthReentrantAlgorithm  {
    public:
        using AthReentrantAlgorithm::AthReentrantAlgorithm;
        virtual ~MeasurementToTrackParticleDecorationAlg() = default;
 
        virtual StatusCode initialize() override;
        virtual StatusCode execute(const EventContext& ctx) const override;
 
    private:      
        enum Subdetector {
            INVALID_DETECTOR=-1, INNERMOST_PIXEL, PIXEL, STRIP, N_SUBDETECTORS
        };
        enum Region {
            INVALID_REGION=-1, BARREL, ENDCAP
        };
        enum MeasurementType {
        INVALID_MEASUREMENT=-1, HIT, OUTLIER, HOLE, BIASED, UNBIASED
        };
 
      float getChi2Contribution(const typename ActsTrk::TrackStateBackend::ConstTrackStateProxy &state) const;
      std::pair<Acts::BoundVector, Acts::BoundMatrix> getUnbiasedTrackParameters(const typename ActsTrk::TrackStateBackend::ConstTrackStateProxy &state,
                                         bool useSmoothed = true) const;
 
      float evaluatePull(const float residual,
             const float measurementCovariance,
             const float trackParameterCovariance,
             const bool evaluateUnbiased) const;
      
    private:
      
       ContextUtility m_ctxProvider{this};
 
      SG::ReadHandleKey<xAOD::TrackParticleContainer> m_trackParticlesKey {
    this, "TrackParticleKey", "", "Input track particle collection"};
      
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementRegionKey{
    this, "MeasurementRegionKey", m_trackParticlesKey, "measurement_region",
    "Decorate track particle with region of the measurement (barrel, ec)"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementDetectorKey{
    this, "MeasurementDetectorKey", m_trackParticlesKey, "measurement_det",
    "Decorate track particle with measurement detector id (innermost pix, pix, strip)"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementLayerKey{
    this, "MeasurementLayerKey", m_trackParticlesKey, "measurement_iLayer",
    "Decorate track particle with measurement layer"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_chi2HitPredictedKey{
    this, "Chi2HitPredictedKey", m_trackParticlesKey, "chi2_hit_predicted",
    "Predicted Chi2 contribution for each hit"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_chi2HitFilteredKey{
    this, "Chi2HitFilteredKey", m_trackParticlesKey, "chi2_hit_filtered",
    "Filtered Chi2 contribution for each hit"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementTypeKey{
    this, "MeasurementTypeKey", m_trackParticlesKey, "measurement_type",
    "Decorate track particle with type of track state (outlier,hole, biased/unbiased)"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementPhiWidthKey{
    this, "MeasurementPhiWidthKey", m_trackParticlesKey, "hitResiduals_phiWidth",
    "Decorate track particle with measurement cluster size (in r-phi)"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementEtaWidthKey{
    this, "MeasurementEtaWidthKey", m_trackParticlesKey, "hitResiduals_etaWidth",
    "Decorate track particle with measurement cluster size (in eta)"};
      
      
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_residualLocXkey{
    this, "ResidualLocXkey", m_trackParticlesKey, "hitResiduals_residualLocX",
    "Decorate track particle with unbiased residual in local x"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_pullLocXkey{
    this, "PullLocXkey", m_trackParticlesKey, "hitResiduals_pullLocX",
    "Decorate track particle with unbiased pull in local x"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementLocXkey{
    this, "MeasurementLocXkey", m_trackParticlesKey, "measurementLocX",
    "Decorate track particle with measurement local x"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_trackParameterLocXkey{
    this, "TrackParameterLocXkey", m_trackParticlesKey, "trackParamLocX",
    "Decorate track particle with unbiased prediction in local x"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementLocCovXkey{
    this, "MeasurementLocCovXkey", m_trackParticlesKey, "measurementLocCovX",
    "Decorate track particle with local x measurement covariance"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_trackParameterLocCovXkey{
    this, "TrackParameterLocCovXkey", m_trackParticlesKey, "trackParameterLocCovX",
    "Decorate track particle with unbiased local x prediction covariance"};
      
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_residualLocYkey{
    this, "ResidualLocYkey", m_trackParticlesKey, "hitResiduals_residualLocY",
    "Decorate track particle with unbiased residual in local y"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_pullLocYkey{
    this, "PullLocYkey", m_trackParticlesKey, "hitResiduals_pullLocY",
    "Decorate track particle with unbiased pull in local y"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementLocYkey{
    this, "MeasurementLocYkey", m_trackParticlesKey, "measurementLocY",
    "Decorate track particle with measurement local y"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_trackParameterLocYkey{
    this, "TrackParameterLocYkey", m_trackParticlesKey, "trackParamLocY",
    "Decorate track particle with unbiased prediction in local y"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_measurementLocCovYkey{
    this, "MeasurementLocCovYkey", m_trackParticlesKey, "measurementLocCovY",
    "Decorate track particle with local y measurement covariance"};
      SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> m_trackParameterLocCovYkey{
    this, "TrackParameterLocCovYkey", m_trackParticlesKey, "trackParameterLocCovY",
    "Decorate track particle with unbiased local y prediction covariance"};
    };
}
 
#endif