Inherits from eflowTrackExtrapolatorBaseAlgTool and AthAlgTool. More...

#include <PFTrackCaloExtensionTool.h>

Inheritance diagram for PFTrackCaloExtensionTool:

Collaboration diagram for PFTrackCaloExtensionTool:

Public Member Functions
	~PFTrackCaloExtensionTool ()
virtual StatusCode	initialize () override
virtual std::unique_ptr< eflowTrackCaloPoints >	execute (const EventContext &ctx, const xAOD::TrackParticle *track) const override
virtual StatusCode	finalize () override
	AthAlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ActsTrk::ContextUtility	m_ctxProvider {this}
	The ContextUtility will give us access to the Acts geometry context.
ServiceHandle< ActsTrk::ITrackingGeometrySvc >	m_trackingGeometrySvc {this, "TrackingGeometrySvc", "ActsTrackingGeometrySvc"}
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_extensionReadDecorKey {this, "ExtensionDecoration", "InDetTrackParticles.caloExtensionLink"}
std::map< Acts::GeometryIdentifier, CaloSampling::CaloSample >	m_geoIdCaloSampleMap
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Inherits from eflowTrackExtrapolatorBaseAlgTool and AthAlgTool.

Uses ACTS to extrapolate tracks to the calorimeter, and creates an eflowTrackCaloPoints object.

Definition at line 19 of file PFTrackCaloExtensionTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ~PFTrackCaloExtensionTool()

PFTrackCaloExtensionTool::~PFTrackCaloExtensionTool ( )

inline

Definition at line 24 of file PFTrackCaloExtensionTool.h.

24{};

Member Function Documentation

◆ AthAlgTool()

AthAlgTool::AthAlgTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor with parameters:

Definition at line 31 of file AthAlgTool.cxx.

                                       : 
  AthCommonDataStore<AthCommonMsg<AlgTool>> ( type, name, parent )
{
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:381

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:378

◆ execute()

std::unique_ptr< eflowTrackCaloPoints > PFTrackCaloExtensionTool::execute	(	const EventContext &	ctx,
		const xAOD::TrackParticle *	track ) const

overridevirtual

Implements eflowTrackExtrapolatorBaseAlgTool.

Definition at line 51 of file PFTrackCaloExtensionTool.cxx.

                                                                                                                                   {
 
    ATH_MSG_DEBUG("About to extrapolate track with pt, eta and phi: " << track->pt() << ", " << track->eta() << " and " << track->phi());
 
    SG::ReadDecorHandle<xAOD::TrackParticleContainer, ElementLink<ActsTrk::CaloExtensionContainer>> extensionReadDecorHandle(m_extensionReadDecorKey, ctx);
    ElementLink<ActsTrk::CaloExtensionContainer> trackCaloExtensionLink = extensionReadDecorHandle(*track);
 
    std::map<eflowCalo::LAYER, const Acts::BoundTrackParameters*> parametersMap;
    const Acts::GeometryContext gctx = m_ctxProvider.getGeometryContext(ctx);
 
    if (!trackCaloExtensionLink.isValid()) {
       ATH_MSG_DEBUG("Decoration exists, but this track has no valid CaloExtension link (null link)");
    }
    else{
      const ActsTrk::CaloExtension* trackCaloExtension = *trackCaloExtensionLink;
      ATH_MSG_DEBUG("Have CaloExtensions with size " << trackCaloExtension->size() << " for this track");
      ATH_MSG_DEBUG("Are the parameters empty?: " << trackCaloExtension->parameters().empty());
 
      for (const Acts::BoundTrackParameters& pars : trackCaloExtension->parameters()) {
          const Acts::Surface& surface = pars.referenceSurface();
          ATH_MSG_DEBUG("Geometry ID of surface is " << surface.geometryId());
 
          const auto thisGeoID = surface.geometryId();
 
          if (m_geoIdCaloSampleMap.contains(thisGeoID)) {
            CaloSampling::CaloSample caloSample = m_geoIdCaloSampleMap.at(thisGeoID);
            ATH_MSG_DEBUG("This surface is in the calorimeter with CaloSample " << caloSample << " and eta, phi: " << pars.position(gctx).eta() << ", " << pars.position(gctx).phi());
            /* parametersMap may have several entries for Tile1,2,3 
            due to the simplfification of eflowCalo::LAYER which only considers
            Tile in general and not barrel, exctended barrel and gap.
            The impact is negligible as the eta/phi of these entries are very similar
            https://its.cern.ch/jira/browse/ATLJETMET-242
            */
            parametersMap[eflowCalo::translateSampl(caloSample)] = &pars;
          }  
      }
    }
 
    return std::make_unique<eflowTrackCaloPoints>(parametersMap, gctx);
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode PFTrackCaloExtensionTool::finalize ( )

overridevirtual

Definition at line 92 of file PFTrackCaloExtensionTool.cxx.

                                              {
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode PFTrackCaloExtensionTool::initialize ( )

overridevirtual

Definition at line 19 of file PFTrackCaloExtensionTool.cxx.

                                                {
 
  ATH_CHECK( AthAlgTool::initialize() );
  ATH_CHECK(m_ctxProvider.initialize());
 
  ATH_CHECK(m_trackingGeometrySvc.retrieve());
 
  ATH_CHECK(m_extensionReadDecorKey.initialize());
 
  std::array<std::string, 7 > caloNames = {"EMB1_Layer", "EMB2_Layer", "EMB3_Layer",
                                          "TileBar0_Layer", "TileBar1_Layer", 
                                          "CaloLayerDiscNegativeZ", "CaloLayerDiscPositiveZ"};
 
 
  m_trackingGeometrySvc->trackingGeometry()->visitVolumes([&](const Acts::TrackingVolume *vol) {
 
    //get geo identifier
    Acts::GeometryIdentifier geoId = vol->geometryId();
    const auto & name = vol->volumeName();
    ATH_MSG_DEBUG(name << " - " << geoId << " - surfaces: " << vol->surfaces().size());
  
    if (std::ranges::contains(caloNames, name)){
      vol->visitSurfaces([&](const Acts::Surface *surface){
      ATH_MSG_DEBUG("This surface has ID" << surface->geometryId());
      m_geoIdCaloSampleMap[surface->geometryId()] = static_cast<CaloSampling::CaloSample>(surface->geometryId().layer());
      });
    };
  });
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 368 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_ctxProvider

ActsTrk::ContextUtility PFTrackCaloExtensionTool::m_ctxProvider {this}

private

The ContextUtility will give us access to the Acts geometry context.

Definition at line 33 of file PFTrackCaloExtensionTool.h.

33{this};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

◆ m_extensionReadDecorKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> PFTrackCaloExtensionTool::m_extensionReadDecorKey {this, "ExtensionDecoration", "InDetTrackParticles.caloExtensionLink"}

private

Definition at line 37 of file PFTrackCaloExtensionTool.h.

37{this, "ExtensionDecoration", "InDetTrackParticles.caloExtensionLink"};

◆ m_geoIdCaloSampleMap

std::map<Acts::GeometryIdentifier, CaloSampling::CaloSample> PFTrackCaloExtensionTool::m_geoIdCaloSampleMap

private

Definition at line 40 of file PFTrackCaloExtensionTool.h.

◆ m_trackingGeometrySvc

ServiceHandle<ActsTrk::ITrackingGeometrySvc> PFTrackCaloExtensionTool::m_trackingGeometrySvc {this, "TrackingGeometrySvc", "ActsTrackingGeometrySvc"}

private

Definition at line 35 of file PFTrackCaloExtensionTool.h.

35{this, "TrackingGeometrySvc", "ActsTrackingGeometrySvc"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ~PFTrackCaloExtensionTool()

Member Function Documentation

◆ AthAlgTool()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_ctxProvider

◆ m_detStore

◆ m_evtStore

◆ m_extensionReadDecorKey

◆ m_geoIdCaloSampleMap

◆ m_trackingGeometrySvc

◆ m_varHandleArraysDeclared

◆ m_vhka