PixelClusterTruthDecoratorAlg.h

Go to the documentation of this file.

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

// Header file for class PixelClusterTruthDecoratorAlg
//
// The algorithm extends xAOD::PixelClusterContainer
// with additional decorations associated to truth information
// And stores the results in a TrackMeasurementValidationContainer
// for compatibility with monitoring tools
 
#ifndef PIXELCLUSTERTRUTHDECORATORALG_H
#define PIXELCLUSTERTRUTHDECORATORALG_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "Gaudi/Property.h"
#include "GaudiKernel/ServiceHandle.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/ReadHandleKeyArray.h"
#include "xAODTracking/TrackParticleContainer.h"
 
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/WriteDecorHandle.h"
 
#include "xAODInDetMeasurement/PixelClusterContainer.h"
#include "xAODTracking/TrackMeasurementValidationContainer.h"
#include "xAODTracking/TrackMeasurementValidationAuxContainer.h"
#include "InDetReadoutGeometry/SiDetectorElementCollection.h"
 
#include "Identifier/Identifier.h"
 
#include "ActsEvent/MeasurementToTruthParticleAssociation.h"
#include "InDetIdentifier/PixelID.h"
#include "InDetCondTools/ISiLorentzAngleTool.h"
 
namespace ActsTrk {
  
  class PixelClusterTruthDecoratorAlg
    : public AthReentrantAlgorithm {
  public:
    PixelClusterTruthDecoratorAlg(const std::string &name,
                  ISvcLocator *pSvcLocator);
    virtual ~PixelClusterTruthDecoratorAlg() = default;
    
    virtual StatusCode initialize() override;
    virtual StatusCode execute(const EventContext& ctx) const override;
 
  private:
    // This function is used to mark the clusters and decide which one to keep
    // and which one to skip. It does so by filling a std::vector<bool>, which
    // size is the same as the cluster collection.
    StatusCode labelMeasurementToKeep(const EventContext& ctx,
                      const xAOD::PixelClusterContainer& clusters,
                      std::vector<bool>& labels) const;
    
  private:
    ToolHandle<ISiLorentzAngleTool> m_lorentzAngleTool {this, "LorentzAngleTool", ""};
 
    SG::ReadHandleKey<xAOD::PixelClusterContainer> m_clustercontainer_key {this,"ClusterContainer", "","Input Pixel Cluster container"};
    SG::ReadHandleKey<ActsTrk::MeasurementToTruthParticleAssociation> m_associationMap_key {this,"AssociationMapOut","", "Association map between measurements and truth particles"};
 
    SG::ReadHandleKeyArray< xAOD::TrackParticleContainer > m_trackParticlesKey {this, "TrackParticles", {}, "Input xAOD::TrackParticles"};
    
    SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> m_pixelDetEleCollKey {this, "PixelDetEleCollKey", "ITkPixelDetectorElementCollection"};
    SG::WriteHandleKey<xAOD::TrackMeasurementValidationContainer> m_write_xaod_key{this,"MeasurementContainer","", "Output Pixel Validation Clusters"};
 
    // Decorations
    SG::WriteDecorHandleKey< xAOD::PixelClusterContainer > m_trackMeasurement_link {this, "MeasurementLink", m_clustercontainer_key, "validationMeasurementLink"};
 
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_truth_indices {this, "MeasurementTruthIndices", m_write_xaod_key, "truth_index"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_truth_barcodes {this, "MeasurementTruthBarcode", m_write_xaod_key, "truth_barcode"};
 
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_detectorElementID {this, "MeasurementDetectorElementID", m_write_xaod_key, "detectorElementID"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_waferID {this, "MeasurementWaferID", m_write_xaod_key, "waferID"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_bec {this, "MeasurementBEC", m_write_xaod_key, "bec"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_layer {this, "MeasurementLayer", m_write_xaod_key, "layer"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_sizePhi {this, "MeasurementSizePhi", m_write_xaod_key, "sizePhi"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_sizeZ {this, "MeasurementSizeZ", m_write_xaod_key, "sizeZ"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_SiWidth {this, "MeasurementSiWidth", m_write_xaod_key, "SiWidth"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_eta_module {this, "MeasurementEtaModule", m_write_xaod_key, "eta_module"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_phi_module {this, "MeasurementPhiModule", m_write_xaod_key, "phi_module"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_omegax {this, "MeasurementOmegaX", m_write_xaod_key, "omegax"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_omegay {this, "MeasurementOmegaY", m_write_xaod_key, "omegay"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_LorentzShift {this, "MeasurementLorentzShift", m_write_xaod_key, "LorentzShift"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_centroid_xphi {this, "MeasurementCentroidXphi", m_write_xaod_key, "centroid_xphi"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_centroid_xeta {this, "MeasurementCentroidXeta", m_write_xaod_key, "centroid_xeta"};
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_side {this, "MeasurementSide", m_write_xaod_key, "side"};
 
    SG::WriteDecorHandleKey<xAOD::TrackMeasurementValidationContainer> m_measurement_tots {this, "MeasurementToT", m_write_xaod_key, "tots"};
    
    Gaudi::Property<bool> m_useTruthInfo {this, "UseTruthInfo", true};
    Gaudi::Property<bool> m_keepOnlyOnTrackMeasurements {this, "KeepOnlyOnTrackMeasurements", false, "Keep on on-track measurements instead of the full collection"};
    Gaudi::Property<std::string> m_idHelperName {
      this, "IDHelperName", "PixelID",
      "DetectorStore key of the identifier helper (e.g. PixelID, PLR_ID)"};
 
    const PixelID *m_PixelHelper {nullptr};
  };
  
}
 
#endif