Implements the creation of UFO objects. More...

#include <TrackCaloClusterTool.h>

Inheritance diagram for UFOTool:

Collaboration diagram for UFOTool:

Public Member Functions
	UFOTool (const std::string &, const std::string &, const IInterface *)
virtual StatusCode	initialize () override
virtual StatusCode	fillTCC (xAOD::FlowElementContainer *container, const TrackCaloClusterInfo &tccInfo) const 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.

Protected Attributes
SG::ReadHandleKey< xAOD::FlowElementContainer >	m_inputPFOHandle {this, "InputPFO", "CHSParticleFlowObjects", ""}
Gaudi::Property< std::string >	m_orig_pfo {this, "OriginPFO", "originalObjectLink", "Key to access original un-modified pfo"}
Gaudi::Property< float >	m_clusterEcut {this , "ClusterECut", 0, " Impotant !! : must be the same value as in TrackCaloClusterInfoUFOAlg"}
	cluster with E below this cut won't be considered in the TCC alg. WARNING cut must be configured as in TrackCaloClusterInfoUFOAlg
ToolHandle< CP::ITrackVertexAssociationTool >	m_trackVertexAssoTool {this ,"TrackVertexAssoTool", ""}
	The tool used to make sure a track is associated to PV0.
Gaudi::Property< bool >	m_useEnergy {this, "UseEnergy", false, "if false will use pT for weights evaluation"}
	use cluster energy or pt?
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_assoClustersKey {this, "AssoClustersDecor", "TCCAssoClusters", "Key to access clusters associated to a track. IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on"}
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_caloEntryParsDecor {this, "CaloEntryParsDecorKey" , "","IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on, REQUIRED if SaveDetectorEta or DoOriginCorrection, else leave blank so the scheduler won't require it unnecessarily."}
Gaudi::Property< bool >	m_saveDetectorEta {this, "SaveDetectorEta", false, ""}
	flag to add dectetor eta decoration onto the produced TrackCaloClusters

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

Implements the creation of UFO objects.

These are build similarly as TCC but using PFO in the place of CaloClusters. All Combined, Charged and Neutral are build together within this class.

Definition at line 126 of file TrackCaloClusterTool.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

◆ UFOTool()

UFOTool::UFOTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 345 of file TrackCaloClusterTool.cxx.

346 : TrackCaloClusterBaseTool(t,n,p) {}

TrackCaloClusterBaseTool::TrackCaloClusterBaseTool

TrackCaloClusterBaseTool(const std::string &, const std::string &, const IInterface *)

Definition TrackCaloClusterTool.cxx:78

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

◆ 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

◆ fillTCC()

StatusCode UFOTool::fillTCC	(	xAOD::FlowElementContainer *	container,
		const TrackCaloClusterInfo &	tccInfo ) const

overridevirtual

Implements TrackCaloClusterBaseTool.

Definition at line 359 of file TrackCaloClusterTool.cxx.

                                                                                                               {
 
  SG::ReadHandle<xAOD::FlowElementContainer> pfos(m_inputPFOHandle);
  const EventContext& ctx=Gaudi::Hive::currentContext(); 
 
  SG::ReadDecorHandle<xAOD::TrackParticleContainer, std::vector<ElementLink<xAOD::CaloClusterContainer>> > clusterLinksH(m_assoClustersKey,ctx);
 
  // We use a dedicated helper to build the combined UFO. Initialize it :  
  TCCHelpers::UFOBuilder ufoB;
  ufoB.m_orig_pfoK = m_orig_pfo;
  ufoB.m_clustersLinkK = SG::decorKeyFromKey (m_assoClustersKey.key());
  ufoB.m_trackVertexAssoTool = m_trackVertexAssoTool.get();
  ufoB.m_clusterEcut = m_clusterEcut;
  ufoB.m_useEnergy = m_useEnergy;
 
  ufoB.m_pfoContainer = pfos.ptr();
  ufoB.m_tccInfo = &tccInfo;
  ufoB.m_tccContainer = tccContainer;
  ufoB.m_linkdecorkey=&m_assoClustersKey;
 
  // create a combined UFO for each track matched to some PFO 
  ufoB.m_linkdecorkey=&m_assoClustersKey;
  ufoB.combinedUFOLoop(&tccInfo, pfos.cptr());
  
  // Create a UFO for all neutral and charged PFO which are not matched to any tracks
  for ( const xAOD::FlowElement* pfo : *pfos ) {
    if(pfo->pt() <= 0) continue;
    if(tccInfo.clusterToTracksWeightMap.find(pfo)!=tccInfo.clusterToTracksWeightMap.end())
      {
    // If the pfo is part of clusterToTracksWeightMap, this means it will be included as part of a combined UFO 
    continue;
      }
 
    if(pfo->isCharged()) {
      // this decoration is set by JetRecTools/Root/ChargedHadronSubtractionTool.cxx !
      const static SG::AuxElement::Accessor<char> PVMatchedAcc("matchedToPV"); 
      if(!PVMatchedAcc(*pfo)) continue;
    }
    
    const xAOD::FlowElementContainer *tmp_pfoContainer = dynamic_cast< const xAOD::FlowElementContainer* >(pfo->container());
    ElementLink< xAOD::FlowElementContainer > pfoLink(tmp_pfoContainer,pfo->index());
    const std::vector< ElementLink<xAOD::FlowElementContainer> > PFOLink {pfoLink};    
    xAOD::FlowElement* tcc = new xAOD::FlowElement;
    tccContainer->push_back(tcc);
 
    if(pfo->isCharged()) {
      //retrieve the track from the charged PFO
      const xAOD::IParticle* pfo_chargedobj=pfo->chargedObjects().at(0);
      const xAOD::TrackParticle* pfo_track=dynamic_cast<const xAOD::TrackParticle*>(pfo_chargedobj);
      
      setParameters(tcc, pfo->pt(), pfo->eta(), pfo->phi(), pfo->m(), xAOD::FlowElement::SignalType::Charged, ElementLink<xAOD::TrackParticleContainer>(*tccInfo.allTracks, pfo_track->index()), PFOLink);
    }else{
      setParameters(tcc, pfo->pt(),pfo->eta(),pfo->phi(),pfo->m(),xAOD::FlowElement::SignalType::Neutral,ElementLink<xAOD::TrackParticleContainer>(),PFOLink);      
    }
  } //  PFO
  
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode UFOTool::initialize ( )

overridevirtual

Reimplemented from TrackCaloClusterBaseTool.

Definition at line 348 of file TrackCaloClusterTool.cxx.

                              {
    //override parent class because of additional requirements on the PFOHandles etc
 ATH_CHECK(m_trackVertexAssoTool.retrieve());
 
    ATH_CHECK(m_assoClustersKey.initialize());
    
    ATH_CHECK(m_caloEntryParsDecor.initialize(!m_caloEntryParsDecor.empty()) );
    ATH_CHECK(m_inputPFOHandle.initialize(!m_inputPFOHandle.empty()));
    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 & ITrackCaloClusterTool::interfaceID ( )

inlinestaticinherited

Definition at line 32 of file ITrackCaloClusterTool.h.

                                                             {
  return IID_ITrackCaloClusterTool; 
}

◆ 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_assoClustersKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> TrackCaloClusterBaseTool::m_assoClustersKey {this, "AssoClustersDecor", "TCCAssoClusters", "Key to access clusters associated to a track. IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on"}

protectedinherited

Definition at line 52 of file TrackCaloClusterTool.h.

52{this, "AssoClustersDecor", "TCCAssoClusters", "Key to access clusters associated to a track. IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on"};

◆ m_caloEntryParsDecor

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> TrackCaloClusterBaseTool::m_caloEntryParsDecor {this, "CaloEntryParsDecorKey" , "","IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on, REQUIRED if SaveDetectorEta or DoOriginCorrection, else leave blank so the scheduler won't require it unnecessarily."}

protectedinherited

Definition at line 56 of file TrackCaloClusterTool.h.

56{this, "CaloEntryParsDecorKey" , "","IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on, REQUIRED if SaveDetectorEta or DoOriginCorrection, else leave blank so the scheduler won't require it unnecessarily."};

◆ m_clusterEcut

Gaudi::Property<float> UFOTool::m_clusterEcut {this , "ClusterECut", 0, " Impotant !! : must be the same value as in TrackCaloClusterInfoUFOAlg"}

protected

cluster with E below this cut won't be considered in the TCC alg. WARNING cut must be configured as in TrackCaloClusterInfoUFOAlg

Definition at line 139 of file TrackCaloClusterTool.h.

139{this , "ClusterECut", 0, " Impotant !! : must be the same value as in TrackCaloClusterInfoUFOAlg"};

◆ 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_inputPFOHandle

SG::ReadHandleKey<xAOD::FlowElementContainer> UFOTool::m_inputPFOHandle {this, "InputPFO", "CHSParticleFlowObjects", ""}

protected

Definition at line 134 of file TrackCaloClusterTool.h.

134{this, "InputPFO", "CHSParticleFlowObjects", ""};

◆ m_orig_pfo

Gaudi::Property<std::string> UFOTool::m_orig_pfo {this, "OriginPFO", "originalObjectLink", "Key to access original un-modified pfo"}

protected

Definition at line 136 of file TrackCaloClusterTool.h.

136{this, "OriginPFO", "originalObjectLink", "Key to access original un-modified pfo"};

◆ m_saveDetectorEta

Gaudi::Property<bool> TrackCaloClusterBaseTool::m_saveDetectorEta {this, "SaveDetectorEta", false, ""}

protectedinherited

flag to add dectetor eta decoration onto the produced TrackCaloClusters

Definition at line 59 of file TrackCaloClusterTool.h.

59{this, "SaveDetectorEta", false, ""};

◆ m_trackVertexAssoTool

ToolHandle<CP::ITrackVertexAssociationTool> TrackCaloClusterBaseTool::m_trackVertexAssoTool {this ,"TrackVertexAssoTool", ""}

protectedinherited

The tool used to make sure a track is associated to PV0.

Definition at line 46 of file TrackCaloClusterTool.h.

46{this ,"TrackVertexAssoTool", ""};

◆ m_useEnergy

Gaudi::Property<bool> TrackCaloClusterBaseTool::m_useEnergy {this, "UseEnergy", false, "if false will use pT for weights evaluation"}

protectedinherited

use cluster energy or pt?

Definition at line 49 of file TrackCaloClusterTool.h.

49{this, "UseEnergy", false, "if false will use pT for weights evaluation"};

◆ 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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ UFOTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ fillTCC()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_assoClustersKey

◆ m_caloEntryParsDecor

◆ m_clusterEcut

◆ m_detStore

◆ m_evtStore

◆ m_inputPFOHandle

◆ m_orig_pfo

◆ m_saveDetectorEta

◆ m_trackVertexAssoTool

◆ m_useEnergy

◆ m_varHandleArraysDeclared

◆ m_vhka