Builds a TrackCaloClusterInfo map which contains the weights needed to build TrackCaloCluster objects. More...

#include <TrackCaloClusterInfoAlg.h>

Inheritance diagram for TrackCaloClusterInfoAlg:

Collaboration diagram for TrackCaloClusterInfoAlg:

Public Member Functions
	TrackCaloClusterInfoAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~TrackCaloClusterInfoAlg ()
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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
virtual StatusCode	fillInfo (SG::WriteHandle< TrackCaloClusterInfo > &tccInfo) const
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.

Protected Attributes
SG::WriteHandleKey< TrackCaloClusterInfo >	m_tccInfoHandle {this, "TCCInfoName","TCCInfo","Name of TrackCaloClusterInfo to be created" }
	TrackCaloClusterInfo created by this alg.
SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_inputTracksHandle {this, "InputTracks", "InDetTrackParticles", ""}
	Tracks used by this alg.
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_assoClustersKey {this, "AssoClustersDecor", "", "Key to access clusters associated to a track. IMPORTANT must be consistent with TrackParticleContainer "}
	Decoration of tracks expected by this alg (set by TrackParticleClusterAssociationAlg)
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_inputClustersHandle {this, "InputClusters", "CaloCalTopoClusters","input calo clusters"}
	Original clusters from which the m_inputObjectName are build ()
SG::ReadHandleKey< xAOD::VertexContainer >	m_inputVertexHandle {this, "VertexContainer", "PrimaryVertices", "IMPORTANT : if blank all tracks will be considered, else only those from the PV[0] of VertexContainer"}
Gaudi::Property< bool >	m_useEnergy {this, "UseEnergy", false,"wether to cut on E or pT"}
	use cluster energy or pt?

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
DataObjIDColl	m_extendedExtraObjects
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

Builds a TrackCaloClusterInfo map which contains the weights needed to build TrackCaloCluster objects.

This TrackCaloClusterInfo is then expected to be used by a TrackCaloClusterAlg and its tools.

Authors: : Naomie Calace, P-A Delsart

Definition at line 32 of file TrackCaloClusterInfoAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TrackCaloClusterInfoAlg()

TrackCaloClusterInfoAlg::TrackCaloClusterInfoAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 13 of file TrackCaloClusterInfoAlg.cxx.

13 :

14 AthAlgorithm( name, pSvcLocator ) {}

AthAlgorithm::AthAlgorithm

AthAlgorithm()

Default constructor:

◆ ~TrackCaloClusterInfoAlg()

virtual TrackCaloClusterInfoAlg::~TrackCaloClusterInfoAlg ( )

inlinevirtual

Definition at line 35 of file TrackCaloClusterInfoAlg.h.

35{}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode TrackCaloClusterInfoAlg::execute ( )

overridevirtual

Definition at line 30 of file TrackCaloClusterInfoAlg.cxx.

                                             {  
  ATH_MSG_DEBUG ("Executing " << name() << "...");
 
  // Prepare a TrackCaloClusterInfo map : 
  SG::WriteHandle<TrackCaloClusterInfo> tccInfo(m_tccInfoHandle);    
  ATH_CHECK( tccInfo.record( std::make_unique<TrackCaloClusterInfo>() ) );
 
  // Retrieve the input containers 
  SG::ReadHandle<xAOD::CaloClusterContainer> clusterContainer(m_inputClustersHandle);
  SG::ReadHandle<xAOD::TrackParticleContainer> tracks(m_inputTracksHandle);
  SG::ReadHandle<xAOD::VertexContainer> vertices(m_inputVertexHandle);
 
  tccInfo->allClusters = &*clusterContainer;
  tccInfo->allTracks = &*tracks;
 
  // retrieve PV0 if it exists
  if(!vertices->empty()) {
    tccInfo->pv0=(*vertices)[0]; // Hard code HS vertex as PV0 : WARNING we expect it is the same as was used for m_inputTrackCaloAssocName !!
  } else {    
    ATH_MSG_ERROR ("Vertex container " << m_inputVertexHandle << " is empty! Can't perform TVA!");
    return StatusCode::FAILURE;
  }
 
  // Fill the maps 
  ATH_CHECK( fillInfo(tccInfo) );  
  
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ fillInfo()

StatusCode TrackCaloClusterInfoAlg::fillInfo ( SG::WriteHandle< TrackCaloClusterInfo > & tccInfo ) const

protectedvirtual

Reimplemented in TrackCaloClusterInfoUFOAlg.

Definition at line 60 of file TrackCaloClusterInfoAlg.cxx.

                                                                                                {
 
  std::multimap <const xAOD::IParticle*, const xAOD::TrackParticle*> clusterToTracksMap;
 
  SG::ReadDecorHandle<xAOD::TrackParticleContainer, std::vector<ElementLink<xAOD::CaloClusterContainer>> > clusterLinks(m_assoClustersKey);
  static const xAOD::IParticle::FourMom_t nullV(0,0,0,0);
  
  for(const xAOD::TrackParticle* trk : *tccInfo->allTracks){
    const auto & clustLinks = clusterLinks( *trk );
    if(clustLinks.empty() ) continue;
    // follow the link to the calorimeter clusters
    for( const auto& clLink : clustLinks) {
      const xAOD::IParticle* cluster = *clLink;
      clusterToTracksMap.insert(std::make_pair(cluster, trk));
      // find FourMom_t for trk or insert (0,0,0,0) if not yet in map :
      xAOD::IParticle::FourMom_t & totalP4 = ( tccInfo->trackTotalClusterPt.insert( {trk, nullV} ) ).first->second;
      totalP4 += cluster->p4(); // add the cluster p4 into the map.      
    }
  }
  
 
  // Create cluster-to-tracks weight map
  for (std::pair<const xAOD::IParticle*, const xAOD::TrackParticle*>  entry : clusterToTracksMap)
    {
      const xAOD::IParticle* cluster = entry.first;
      double cluster_pt       = m_useEnergy ? cluster->e() : cluster->pt();
      double totalcluster_pt  = m_useEnergy ? tccInfo->trackTotalClusterPt.at(entry.second).E() : tccInfo->trackTotalClusterPt.at(entry.second).Pt();
 
      // find FourMom_t for trk or insert (0,0,0,0) if not yet in map :
      xAOD::IParticle::FourMom_t & totalP4 = ( tccInfo->clusterToTracksWeightMap.insert( {cluster, nullV} ) ).first->second;
      totalP4 += entry.second->p4() * (cluster_pt/totalcluster_pt); // add the track p4 into the map.
    }
 
  
  return StatusCode::SUCCESS;  
}

◆ initialize()

StatusCode TrackCaloClusterInfoAlg::initialize ( )

overridevirtual

Reimplemented in TrackCaloClusterInfoUFOAlg.

Definition at line 17 of file TrackCaloClusterInfoAlg.cxx.

                                               {
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
  ATH_CHECK(m_inputClustersHandle.initialize() );
  ATH_CHECK(m_inputTracksHandle.initialize() );
  ATH_CHECK(m_inputVertexHandle.initialize());
  ATH_CHECK(m_tccInfoHandle.initialize());
 
  ATH_CHECK(m_assoClustersKey.initialize());
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_assoClustersKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> TrackCaloClusterInfoAlg::m_assoClustersKey {this, "AssoClustersDecor", "", "Key to access clusters associated to a track. IMPORTANT must be consistent with TrackParticleContainer "}

protected

Decoration of tracks expected by this alg (set by TrackParticleClusterAssociationAlg)

Definition at line 52 of file TrackCaloClusterInfoAlg.h.

52{this, "AssoClustersDecor", "", "Key to access clusters associated to a track. IMPORTANT must be consistent with TrackParticleContainer "};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_inputClustersHandle

SG::ReadHandleKey<xAOD::CaloClusterContainer> TrackCaloClusterInfoAlg::m_inputClustersHandle {this, "InputClusters", "CaloCalTopoClusters","input calo clusters"}

protected

Original clusters from which the m_inputObjectName are build ()

Definition at line 55 of file TrackCaloClusterInfoAlg.h.

55{this, "InputClusters", "CaloCalTopoClusters","input calo clusters"};

◆ m_inputTracksHandle

SG::ReadHandleKey< xAOD::TrackParticleContainer > TrackCaloClusterInfoAlg::m_inputTracksHandle {this, "InputTracks", "InDetTrackParticles", ""}

protected

Tracks used by this alg.

Definition at line 50 of file TrackCaloClusterInfoAlg.h.

50{this, "InputTracks", "InDetTrackParticles", ""};

◆ m_inputVertexHandle

SG::ReadHandleKey<xAOD::VertexContainer> TrackCaloClusterInfoAlg::m_inputVertexHandle {this, "VertexContainer", "PrimaryVertices", "IMPORTANT : if blank all tracks will be considered, else only those from the PV[0] of VertexContainer"}

protected

Definition at line 57 of file TrackCaloClusterInfoAlg.h.

57{this, "VertexContainer", "PrimaryVertices", "IMPORTANT : if blank all tracks will be considered, else only those from the PV[0] of VertexContainer"};

◆ m_tccInfoHandle

SG::WriteHandleKey<TrackCaloClusterInfo> TrackCaloClusterInfoAlg::m_tccInfoHandle {this, "TCCInfoName","TCCInfo","Name of TrackCaloClusterInfo to be created" }

protected

TrackCaloClusterInfo created by this alg.

Definition at line 45 of file TrackCaloClusterInfoAlg.h.

45{this, "TCCInfoName","TCCInfo","Name of TrackCaloClusterInfo to be created" };

◆ m_useEnergy

Gaudi::Property<bool> TrackCaloClusterInfoAlg::m_useEnergy {this, "UseEnergy", false,"wether to cut on E or pT"}

protected

use cluster energy or pt?

Definition at line 60 of file TrackCaloClusterInfoAlg.h.

60{this, "UseEnergy", false,"wether to cut on E or pT"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TrackCaloClusterInfoAlg()

◆ ~TrackCaloClusterInfoAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fillInfo()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_assoClustersKey

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputClustersHandle

◆ m_inputTracksHandle

◆ m_inputVertexHandle

◆ m_tccInfoHandle

◆ m_useEnergy

◆ m_varHandleArraysDeclared

◆ m_vhka