InDetPhysValTruthDecoratorAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef INDETPHYSVALMONITORING_INDETPHYSVALTRUTHDECORATORTOOL_H
#define INDETPHYSVALMONITORING_INDETPHYSVALTRUTHDECORATORTOOL_H
// STL includes
#include <string>
#include "xAODTruth/TruthParticleContainer.h"
#include "xAODTruth/TruthEventContainer.h"
#include "xAODTruth/TruthPileupEventContainer.h"
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "GaudiKernel/ToolHandle.h"
#include "TrkExInterfaces/IExtrapolator.h"
#include "StoreGate/ReadDecorHandleKeyArray.h"
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/WriteDecorHandle.h"
#include "AthContainers/AuxElement.h"
#include "xAODEventInfo/EventInfo.h"
#include "xAODTracking/TrackMeasurementValidationContainer.h"
#include "GaudiKernel/EventContext.h"
#include "TrkTruthTrackInterfaces/IAthSelectionTool.h"
#include "InDetPhysValMonitoring/CutFlow.h"
#include "CxxUtils/checker_macros.h"
#include <atomic>
#include <utility>
#include <vector>
 
 
// class to decorate xAOD::TruthParticles with additional information required by validation
class InDetPhysValTruthDecoratorAlg: public AthReentrantAlgorithm {
public:
  InDetPhysValTruthDecoratorAlg(const std::string& name, ISvcLocator* pSvcLocator);
  virtual
  ~InDetPhysValTruthDecoratorAlg ();
  virtual StatusCode initialize();
  virtual StatusCode finalize();
  virtual StatusCode execute(const EventContext &ctx) const;
 
private:
  enum {kPixel,kSCT,kNClusterTypes};
  bool decorateTruth(const xAOD::TruthParticle& particle,
                     std::vector< std::pair<SG::WriteDecorHandle<xAOD::TruthParticleContainer,float>,
                                            bool > > &float_decor,
                     const Amg::Vector3D& perigeePos,
                     const std::vector<std::array<uint16_t, kNClusterTypes> > &counts) const;
  const xAOD::TruthEvent* getTruthHSEvent() const;
  bool decorateTruthTime(std::vector<std::pair<SG::WriteDecorHandle<xAOD::TruthParticleContainer, float>, bool>>& float_decor) const;
 
  PublicToolHandle<Trk::IExtrapolator> m_extrapolator
     {this,"Extrapolator","Trk::Extrapolator/AtlasExtrapolator",""};
  SG::ReadDecorHandleKeyArray<xAOD::EventInfo> m_beamSpotDecoKey
     {this, "BeamSpotDecoKeys",
        {"EventInfo.beamPosX", "EventInfo.beamPosY", "EventInfo.beamPosZ"},
    "Beamspot position decoration keys"};
 
  mutable std::atomic<std::size_t> m_nMissingTruthParticles = 0u;
  mutable std::atomic<bool> m_errorEmitted{false};

  SG::ReadHandleKey<xAOD::TruthParticleContainer> m_truthParticleName
    {this, "TruthParticleContainerName",  "TruthParticles", ""};
 
  Gaudi::Property<std::string> m_prefix
    {this, "Prefix", "", "Decoration prefix to avoid clashes."};
 
  Gaudi::Property<bool> m_decoTime{this, "decorateTime", false};
  
  SG::ReadHandleKey<xAOD::TrackMeasurementValidationContainer> m_truthPixelClusterName
    {this, "PixelClusterContainerName",  "PixelClusters", ""};
  
  SG::ReadHandleKey<xAOD::TrackMeasurementValidationContainer> m_truthSCTClusterName
    {this, "SCTClusterContainerName",  "SCT_Clusters", ""};
 
  SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> m_truthParticleIndexDecor
    {this, "TruthParticleIndexDecoration", m_truthParticleName, "origTruthIndex", "decoration name for the original truth particle index."};
 
  SG::ReadHandleKey<xAOD::TruthEventContainer> m_truthEventName
    {this, "TruthEventContainerName", "TruthEvents", ""};
 
  SG::ReadHandleKey<xAOD::TruthPileupEventContainer> m_truthPileupEventName
    {this, "TruthPileupEventContainerName", "TruthPileupEvents", ""};
 
  Gaudi::Property<bool> m_useTruthPVAsPerigee
    {this, "UseTruthPVAsPerigee", false, "Use the truth PV to calculate the perigee parameters instead of the BS"};
 
  // decoration helper
  enum EDecorations {
    kDecorD0,
    kDecorZ0,
    kDecorPhi,
    kDecorTheta,
    kDecorZ0st,
    kDecorQOverP,
    kDecorProdR,
    kDecorProdZ,
    kDecorNSilHits,
    kDecorTime,
    kNDecorators
  };
  std::vector< std::pair<SG::WriteDecorHandleKey<xAOD::TruthParticleContainer>,SG::AuxElement::ConstAccessor<float> > > m_decor;
};
#endif