Inherits from eflowTrackExtrapolatorBaseAlgTool and AthAlgTool. More...

#include <eflowTrackCaloExtensionTool.h>

Inheritance diagram for eflowTrackCaloExtensionTool:

Collaboration diagram for eflowTrackCaloExtensionTool:

Public Member Functions
	eflowTrackCaloExtensionTool (const std::string &type, const std::string &name, const IInterface *parent)
	~eflowTrackCaloExtensionTool ()
virtual StatusCode	initialize () override
virtual std::unique_ptr< eflowTrackCaloPoints >	execute (const xAOD::TrackParticle *track) const override
virtual StatusCode	finalize () override
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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
eflowCalo::LAYER	getLayer (const Trk::CurvilinearParameters *clParameters) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const float	m_invGeV = 1./CLHEP::GeV
ToolHandle< Trk::IParticleCaloExtensionTool >	m_theTrackExtrapolatorTool
std::unique_ptr< Trk::TrackParametersIdHelper >	m_trackParametersIdHelper
SG::ReadHandleKey< CaloExtensionCollection >	m_ParticleCacheKey
Gaudi::Property< bool >	m_useOldCalo {this,"useOldCalo",false,"If true, it uses the CaloExtensionTool for calculating track extrapolation. Otherwise, it allows the code to read from the cache created by CaloExtensionBuilderalg."}
ToolHandle< GenericMonitoringTool >	m_monTool {this,"MonTool_TrackCaloExtension","","Monitoring tool"}
	Online monitoring tool for recording histograms of the alg in action.
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 ParticleCaloExtenstionTool to extrapolate tracks to the calorimeter, and creates an eflowTrackCaloPoints object.

Definition at line 38 of file eflowTrackCaloExtensionTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ eflowTrackCaloExtensionTool()

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

Definition at line 32 of file eflowTrackCaloExtensionTool.cxx.

                                                                                                                                :
    AthAlgTool(type, name, parent),
    m_theTrackExtrapolatorTool("Trk::ParticleCaloExtensionTool",this),
    m_trackParametersIdHelper(std::make_unique<Trk::TrackParametersIdHelper>())
{
  declareInterface<eflowTrackExtrapolatorBaseAlgTool>(this);
  declareProperty("TrackCaloExtensionTool", m_theTrackExtrapolatorTool, "TrackCaloExtension Tool Handle");
}

◆ ~eflowTrackCaloExtensionTool()

eflowTrackCaloExtensionTool::~eflowTrackCaloExtensionTool ( )

default

Member Function Documentation

◆ 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:393

◆ 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:390

◆ execute()

std::unique_ptr< eflowTrackCaloPoints > eflowTrackCaloExtensionTool::execute ( const xAOD::TrackParticle * track ) const

overridevirtual

Implements eflowTrackExtrapolatorBaseAlgTool.

Definition at line 62 of file eflowTrackCaloExtensionTool.cxx.

                                                                                                             {
 
  ATH_MSG_VERBOSE(" Now running eflowTrackCaloExtensionTool");
 
  auto execution_timer = Monitored::Timer<std::chrono::microseconds>( "TIME_execute" );
  Monitored::ScopedTimer execution_time(execution_timer);
  auto extrapolation_timer = Monitored::Timer<std::chrono::microseconds>( "TIME_extrapolation" );
  auto track_pt = Monitored::Scalar<float>("track_pt");
  auto group = Monitored::Group(m_monTool, execution_timer, extrapolation_timer, track_pt);
 
  track_pt = track->pt() * m_invGeV ;
 
  /*Create a map to index the TrackParameters at calo (owned by the extension) wrt to layers*/
  std::map<eflowCalo::LAYER, const Trk::TrackParameters*> parametersMap;
  std::map<CaloCell_ID::CaloSample,const Trk::TrackParameters*> tileParametersMap;
 
  /*get the CaloExtension object*/
  const Trk::CaloExtension * extension = nullptr;
  std::unique_ptr<Trk::CaloExtension> uniqueExtension;
  const int index = track->index();
  ATH_MSG_VERBOSE("Getting element " << index << " from the particleCache");
 
  extrapolation_timer.start();
  if (m_useOldCalo) {
    /* If CaloExtensionBuilder is unavailable, use the calo extension tool */
    ATH_MSG_VERBOSE("Using the CaloExtensionTool");
    uniqueExtension = m_theTrackExtrapolatorTool->caloExtension(
      Gaudi::Hive::currentContext(), *track);
    extension = uniqueExtension.get();
  } else {
    /*get the CaloExtension object*/
    SG::ReadHandle<CaloExtensionCollection>  particleCache {m_ParticleCacheKey};
    ATH_MSG_VERBOSE("Using the CaloExtensionBuilder Cache");
    extension = (*particleCache)[index];
    ATH_MSG_VERBOSE("Getting element " << index << " from the particleCache");
    if( not extension ){
      ATH_MSG_VERBOSE("Cache does not contain a calo extension -> Calculating with the a CaloExtensionTool" );
      uniqueExtension = m_theTrackExtrapolatorTool->caloExtension(
        Gaudi::Hive::currentContext(), *track);
      extension = uniqueExtension.get();
    }
  }
  extrapolation_timer.stop();  
 
  if (extension != nullptr) {
 
    /*extract the CurvilinearParameters*/
    const std::vector<Trk::CurvilinearParameters>& clParametersVector = extension->caloLayerIntersections();
 
     /*The parameters are owned by the CaloExtension so are handled by it the eflowTrackCaloPoints does
     * not take ownership */
    for ( const Trk::CurvilinearParameters& clParameter : clParametersVector) {
      if (parametersMap[getLayer(&clParameter)] == nullptr) {
        parametersMap[getLayer(&clParameter)] = &clParameter;
      } else if (m_trackParametersIdHelper->isEntryToVolume(clParameter.cIdentifier())) {
        parametersMap[getLayer(&clParameter)] = &clParameter;
      }
 
      CaloCell_ID::CaloSample caloSample = m_trackParametersIdHelper->caloSample(clParameter.cIdentifier());
 
      if (tileParametersMap[caloSample] == nullptr){
        tileParametersMap[caloSample] = &clParameter;
      } else if (m_trackParametersIdHelper->isEntryToVolume(clParameter.cIdentifier())){
        tileParametersMap[caloSample] = &clParameter;
      }
 
    }
 
 
    /*
      parametersMap may have several entries for Tile1,2,3.
      The impact is negligible as the eta/phi of these entries are very similar
      https://its.cern.ch/jira/browse/ATLJETMET-242
    */
    
    return std::make_unique<eflowTrackCaloPoints>(parametersMap,tileParametersMap);
 
  }
  else{
    if (track->pt() > 3*Gaudi::Units::GeV) ATH_MSG_WARNING("TrackExtension failed for track with pt and eta " << track->pt() << " and " << track->eta());
    parametersMap[eflowCalo::LAYER::Unknown] = nullptr;
    return std::make_unique<eflowTrackCaloPoints>(parametersMap);
  }
}

◆ 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 eflowTrackCaloExtensionTool::finalize ( )

overridevirtual

Definition at line 147 of file eflowTrackCaloExtensionTool.cxx.

                                                 {
  return StatusCode::SUCCESS;
}

◆ getLayer()

eflowCalo::LAYER eflowTrackCaloExtensionTool::getLayer ( const Trk::CurvilinearParameters * clParameters ) const

private

Definition at line 152 of file eflowTrackCaloExtensionTool.cxx.

                                                                                                      {
  unsigned int parametersIdentifier = clParameter->cIdentifier();
 
  /*Return unknown when the identifier is invalid */
  if (!m_trackParametersIdHelper->isValid(parametersIdentifier)) {
    ATH_MSG_ERROR("invalid Track Identifier");
    return eflowCalo::LAYER::Unknown;
  };
 
  if(m_trackParametersIdHelper->isEntryToVolume(parametersIdentifier)) {
    ATH_MSG_VERBOSE("is Volume Entry");
 } else {
    ATH_MSG_VERBOSE("is Volume Exit");
    }
 
  return eflowCalo::translateSampl(m_trackParametersIdHelper->caloSample(parametersIdentifier));
}

◆ initialize()

StatusCode eflowTrackCaloExtensionTool::initialize ( )

overridevirtual

Definition at line 43 of file eflowTrackCaloExtensionTool.cxx.

                                                   {
 
  if (m_theTrackExtrapolatorTool.retrieve().isFailure()) {
    ATH_MSG_WARNING("Cannot find Extrapolation tool "
            << m_theTrackExtrapolatorTool.typeAndName());
    return StatusCode::SUCCESS;
  } else {
    ATH_MSG_VERBOSE("Successfully retrieved Extrapolation tool "
            << m_theTrackExtrapolatorTool.typeAndName());
  }
 
  if (!m_ParticleCacheKey.key().empty()) ATH_CHECK(m_ParticleCacheKey.initialize());
  else m_useOldCalo = true;
 
    if (!m_monTool.empty()) ATH_CHECK(m_monTool.retrieve());
  
  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.

◆ interfaceID()

const InterfaceID & eflowTrackCaloExtensionTool::interfaceID ( )

inlinestatic

Definition at line 71 of file eflowTrackCaloExtensionTool.h.

                                                                   {
  return IID_eflowTrackCaloExtensionTool;
}

◆ 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 380 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 364 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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_invGeV

const float eflowTrackCaloExtensionTool::m_invGeV = 1./CLHEP::GeV

private

Definition at line 52 of file eflowTrackCaloExtensionTool.h.

◆ m_monTool

ToolHandle<GenericMonitoringTool> eflowTrackCaloExtensionTool::m_monTool {this,"MonTool_TrackCaloExtension","","Monitoring tool"}

private

Online monitoring tool for recording histograms of the alg in action.

Definition at line 67 of file eflowTrackCaloExtensionTool.h.

67{this,"MonTool_TrackCaloExtension","","Monitoring tool"};

◆ m_ParticleCacheKey

SG::ReadHandleKey<CaloExtensionCollection> eflowTrackCaloExtensionTool::m_ParticleCacheKey

private

Initial value:

{this,

"PFParticleCache", "ParticleCaloExtension", "Name of the particle measurement extrapolation cache"}

Definition at line 61 of file eflowTrackCaloExtensionTool.h.

61 {this,

62 "PFParticleCache", "ParticleCaloExtension", "Name of the particle measurement extrapolation cache"};

◆ m_theTrackExtrapolatorTool

ToolHandle<Trk::IParticleCaloExtensionTool> eflowTrackCaloExtensionTool::m_theTrackExtrapolatorTool

private

Definition at line 56 of file eflowTrackCaloExtensionTool.h.

◆ m_trackParametersIdHelper

std::unique_ptr<Trk::TrackParametersIdHelper> eflowTrackCaloExtensionTool::m_trackParametersIdHelper

private

Definition at line 58 of file eflowTrackCaloExtensionTool.h.

◆ m_useOldCalo

Gaudi::Property<bool> eflowTrackCaloExtensionTool::m_useOldCalo {this,"useOldCalo",false,"If true, it uses the CaloExtensionTool for calculating track extrapolation. Otherwise, it allows the code to read from the cache created by CaloExtensionBuilderalg."}

private

Definition at line 64 of file eflowTrackCaloExtensionTool.h.

64{this,"useOldCalo",false,"If true, it uses the CaloExtensionTool for calculating track extrapolation. Otherwise, it allows the code to read from the cache created by CaloExtensionBuilderalg."};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ eflowTrackCaloExtensionTool()

◆ ~eflowTrackCaloExtensionTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ finalize()

◆ getLayer()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_invGeV

◆ m_monTool

◆ m_ParticleCacheKey

◆ m_theTrackExtrapolatorTool

◆ m_trackParametersIdHelper

◆ m_useOldCalo

◆ m_varHandleArraysDeclared

◆ m_vhka