Steven Schramm
February 2014. More...

#include <JetTrackMomentsTool.h>

Inheritance diagram for JetTrackMomentsTool:

Collaboration diagram for JetTrackMomentsTool:

Classes
struct	TrackMomentStruct

Public Member Functions
	JetTrackMomentsTool (const std::string &name)

StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it. More...

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
const std::vector< TrackMomentStruct >	getTrackMoments (const xAOD::Jet &jet, const xAOD::VertexContainer vertices, const float minTrackPt, const std::vector< const xAOD::TrackParticle > &tracks, const jet::TrackVertexAssociation *tva) const

TrackMomentStruct	getTrackMoments (const xAOD::Jet &, const xAOD::Vertex vertex, const float minTrackPt, const std::vector< const xAOD::TrackParticle > &tracks, const jet::TrackVertexAssociation *tva) const

const std::string	getMomentBaseName (const float minTrackPt) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< std::string >	m_jetContainerName {this, "JetContainer", "", "SG key for input jet container"}

Gaudi::Property< std::string >	m_assocTracksName {this, "AssociatedTracks", "", "Name of associated tracks collection"}

Gaudi::Property< std::string >	m_suffix {this, "MomentSuffix", "", "Suffix for track moment decorations"}

Gaudi::Property< std::vector< float > >	m_minTrackPt {this, "TrackMinPtCuts", {}, "Vector of track pt cuts"}

Gaudi::Property< bool >	m_doPFlowMoments {this, "DoPFlowMoments", false, "Calculate PFlow Object track moments?"}

ToolHandle< IJetTrackSelector >	m_htsel {this, "TrackSelector", "", "Track selector tool"}

SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer_key {this, "VertexContainer", "", "SG key for vertex container"}

SG::ReadHandleKey< jet::TrackVertexAssociation >	m_tva_key {this, "TrackVertexAssociation", "", "SG key for track-vertex association"}

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_keysNumTrk {this, "NumTrkDecorKeys", {}, "SG keys for NumTrk decoration (not to be configured manually!)"}

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_keysSumPtTrk {this, "SumPtTrkDecorKeys", {}, "SG keys for SumPtTrk decoration (not to be configured manually!)"}

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_keysTrkWidth {this, "TrackWidthDecorKeys", {}, "SG keys for TrackWidth decoration (not to be configured manually!)"}

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_keysNumCPFO {this, "NumChargedPFODecorKeys", {}, "SG keys for NumChargedPFO decoration (not to be configured manually!)"}

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_keysSumPtCPFO {this, "SumPtChargedPFODecorKeys", {}, "SG keys for SumPtChargedPFO decoration (not to be configured manually!)"}

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_keysCPFOWidth {this, "ChargedPFOWidthDecorKeys", {}, "SG keys for ChargedPFO Width decoration (not to be configured manually!)"}

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Steven Schramm
February 2014.

Updated for Run 3 by Bill Balunas March 2020

Tool to calculate general track-based jet moments

Moments to calculate: NumTrkPtXXX SumPtTrkPtXXX TrackWidthPtXXX where the track pT threshold is XXX MeV.

Definition at line 41 of file JetTrackMomentsTool.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

◆ JetTrackMomentsTool()

JetTrackMomentsTool::JetTrackMomentsTool ( const std::string & name )

Definition at line 13 of file JetTrackMomentsTool.cxx.

     : asg::AsgTool(name)
 {
 }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ decorate()

StatusCode JetTrackMomentsTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 64 of file JetTrackMomentsTool.cxx.

                                                                            {
  
   // Get input vertex collection
   auto handle_v = SG::makeHandle (m_vertexContainer_key);
   if (!handle_v.isValid()){
     ATH_MSG_ERROR("Could not retrieve the VertexContainer: "
                   << m_vertexContainer_key.key());
     return StatusCode::FAILURE;
   }
  
   const auto *vertexContainer = handle_v.cptr();
  
   // Get the track-vertex association
   auto handle_tva = SG::makeHandle (m_tva_key);
   if (!handle_tva.isValid()){
     ATH_MSG_ERROR("Could not retrieve the TrackVertexAssociation: "
                   << m_tva_key.key());
     return StatusCode::FAILURE;
   }
  
   const auto *tva = handle_tva.cptr();
  
   for(const xAOD::Jet* jet : jets){
     ATH_MSG_VERBOSE("On jet " << jet->index());
  
     // Retrieve the associated tracks.
     std::vector<const xAOD::TrackParticle*> tracks;
     bool havetracks = jet->getAssociatedObjects(m_assocTracksName, tracks);
     if(!havetracks) ATH_MSG_WARNING("Associated tracks not found: " <<  m_assocTracksName);
     ATH_MSG_VERBOSE("Successfully retrieved track particles for jet " << jet->index());
  
     std::vector<const xAOD::TrackParticle*> pflowTracks;
     bool isPFlowJet = false;
     if(m_doPFlowMoments) {
       // Check if this is a PFlow jet. If so, get the PFO tracks.
       xAOD::Type::ObjectType ctype = jet->rawConstituent(0)->type();
       if (ctype  == xAOD::Type::ParticleFlow) {
         isPFlowJet = true;
         size_t numConstit = jet->numConstituents();
         for ( size_t i=0; i<numConstit; i++ ) {
           const xAOD::PFO* constit = dynamic_cast<const xAOD::PFO*>(jet->rawConstituent(i));
           if (constit->isCharged()){
             const xAOD::TrackParticle *thisTrack = constit->track(0);//by construction xAOD::PFO can only have one track, in eflowRec usage
             pflowTracks.push_back(thisTrack);
           }// We have a charged PFO
         }// Loop on jet constituents
       }// This jet is either a PFlow jet (constituent type: xAOD::FlowElement::PFlow) or UFO jets
       else if (ctype  == xAOD::Type::FlowElement) {
     isPFlowJet = true;
         size_t numConstit = jet->numConstituents();
         for ( size_t i=0; i<numConstit; i++ ) {
           const xAOD::FlowElement* constit = dynamic_cast<const xAOD::FlowElement*>(jet->rawConstituent(i));
       // UFO jet constituents have signalType xAOD::FlowElement::Charged or xAOD::FlowElement::Neutral
       // PFlow jet constituents have signalType xAOD::FlowElement::ChargedPFlow or xAOD::FlowElement::NeutralPFlow
           if(constit != nullptr && ((constit->signalType() & xAOD::FlowElement::PFlow) || constit->signalType() == xAOD::FlowElement::Charged)){
             if (constit->isCharged()){
               const xAOD::TrackParticle *thisTrack = dynamic_cast<const xAOD::TrackParticle*>(constit->chargedObject(0));//PFO should have only 1 track
               if(thisTrack != nullptr) pflowTracks.push_back(thisTrack);
               else ATH_MSG_WARNING("Charged PFO had no associated TrackParticle");
             }// We have a charged PFO
           }// The FlowElement is a PFO
         }// Loop on jet constituents
       }// This jet is made from xAOD::FlowElement, so we calculate the pflow moments if they're PFOs
     }// We actually want to calculate the PFlow moments
  
     // For each track cut, compute and set the associated moments
     for (size_t iCut = 0; iCut < m_minTrackPt.size(); ++iCut) {
       SG::WriteDecorHandle<xAOD::JetContainer, std::vector<int> > numTrkHandle(m_keysNumTrk.at(iCut));
       SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float> > sumPtTrkHandle(m_keysSumPtTrk.at(iCut));
       SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float> > trkWidthHandle(m_keysTrkWidth.at(iCut));
       // Get info
       const float minPt = m_minTrackPt[iCut];
       const std::vector<TrackMomentStruct> moments = getTrackMoments(*jet,vertexContainer,minPt,tracks,tva);
       // Collate info
       std::vector<int>   numTrkVec;       numTrkVec.resize(moments.size());
       std::vector<float> sumPtTrkVec;     sumPtTrkVec.resize(moments.size());
       std::vector<float> trackWidthVec;   trackWidthVec.resize(moments.size());
       for ( size_t iVertex = 0; iVertex < moments.size(); ++iVertex ) {
         numTrkVec[iVertex]     = moments.at(iVertex).numTrk;
         sumPtTrkVec[iVertex]   = moments.at(iVertex).sumPtTrk;
         trackWidthVec[iVertex] = moments.at(iVertex).trackWidth;
       }
       // Set moment decorations
       numTrkHandle(*jet) = numTrkVec;
       sumPtTrkHandle(*jet) = sumPtTrkVec;
       trkWidthHandle(*jet) = trackWidthVec;
  
       if(m_doPFlowMoments) {
         SG::WriteDecorHandle<xAOD::JetContainer, std::vector<int> > numCPFOHandle(m_keysNumCPFO.at(iCut));
         SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float> > sumPtCPFOHandle(m_keysSumPtCPFO.at(iCut));
         SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float> > cPFOWidthHandle(m_keysCPFOWidth.at(iCut));
         if(isPFlowJet){
  
           const std::vector<TrackMomentStruct> pflowMoments = getTrackMoments(*jet,vertexContainer,minPt,pflowTracks,tva);
  
           std::vector<int>   pflowNumTrkVec;       pflowNumTrkVec.resize(pflowMoments.size());
           std::vector<float> pflowSumPtTrkVec;     pflowSumPtTrkVec.resize(pflowMoments.size());
           std::vector<float> pflowTrackWidthVec;   pflowTrackWidthVec.resize(pflowMoments.size());
           for ( size_t iVertex = 0; iVertex < pflowMoments.size(); ++iVertex ) {
             pflowNumTrkVec[iVertex]     = pflowMoments.at(iVertex).numTrk;
             pflowSumPtTrkVec[iVertex]   = pflowMoments.at(iVertex).sumPtTrk;
             pflowTrackWidthVec[iVertex] = pflowMoments.at(iVertex).trackWidth;
           }
           // Set moment decorations
           numCPFOHandle(*jet) = pflowNumTrkVec;
           sumPtCPFOHandle(*jet) = pflowSumPtTrkVec;
           cPFOWidthHandle(*jet) = pflowTrackWidthVec;
         }
         else{
           // User configured for PFO track moments but this isn't a PFlow jet. Set them to empty vectors.
           numCPFOHandle(*jet) = std::vector<int>();
           sumPtCPFOHandle(*jet) = std::vector<float>();
           cPFOWidthHandle(*jet) = std::vector<float>();
         } // Should find a more graceful way to complain?
       }// do PF moments
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ 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; }

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ 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

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getMomentBaseName()

const std::string JetTrackMomentsTool::getMomentBaseName ( const float minTrackPt ) const

private

Definition at line 251 of file JetTrackMomentsTool.cxx.

 {
     int value = round(minTrackPt);
     if (fabs(value - minTrackPt) > 0.1)
         ATH_MSG_WARNING("Cut float and int disagree: " << minTrackPt << " float vs " << value << " int");
  
     std::ostringstream sout;
     sout << "Pt" << value;
     return sout.str();
 }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ getTrackMoments() [1/2]

JetTrackMomentsTool::TrackMomentStruct JetTrackMomentsTool::getTrackMoments	(	const xAOD::Jet &	jet,
		const xAOD::Vertex *	vertex,
		const float	minTrackPt,
		const std::vector< const xAOD::TrackParticle * > &	tracks,
		const jet::TrackVertexAssociation *	tva
	)		const

private

Definition at line 197 of file JetTrackMomentsTool.cxx.

 {
     // Prepare the moments
     TrackMomentStruct moments{};
     moments.numTrk = 0;
     moments.sumPtTrk = 0;
     moments.trackWidth = 0;
  
     // Prepare const vars for jet eta/phi
     const float jetEta = jet.eta();
     const float jetPhi = jet.phi();
  
     // Track selection and counters
     bool notsel = m_htsel.empty();
     unsigned int nkeep = 0;
     unsigned int nskip = 0;
  
     // Loop over the tracks
     for (size_t iTrack = 0; iTrack < tracks.size(); ++iTrack)
     {
         const xAOD::TrackParticle* track = tracks.at(iTrack);
         const float trackPt = track->pt();
  
         // Skip the track if it doesn't pass the cut
         if (trackPt < minTrackPt)
             continue;
  
         // Skip the track if it's not from the vertex in question
         if( vertex == nullptr || vertex != tva->associatedVertex(track) ) continue ;
  
         // Check track passes track selection, otherwise mark as skipped
         if ( notsel || m_htsel->keep(*track) ) {
           ++nkeep;
  
           // Calculate necessary info for the moments
           const double deltaR = jet::JetDistances::deltaR(jetEta, jetPhi, track->eta(),  track->phi() );
  
           // Adjust values as necessary for this track
           moments.numTrk     += 1;
           moments.sumPtTrk   += trackPt;
           moments.trackWidth += deltaR * trackPt;
         }
         else { ++nskip;}
     }
  
     // Finish processing the moments
     moments.trackWidth = moments.sumPtTrk > 0 ? moments.trackWidth / moments.sumPtTrk : -1;
  
     ATH_MSG_DEBUG(" jet index= " << jet.index() << " pt="<<jet.pt() 
          << ": nsel=" << nkeep
          << ", nrej=" << nskip << "  minpt="<<minTrackPt);
     return moments;
 }

◆ getTrackMoments() [2/2]

const std::vector< JetTrackMomentsTool::TrackMomentStruct > JetTrackMomentsTool::getTrackMoments	(	const xAOD::Jet &	jet,
		const xAOD::VertexContainer *	vertices,
		const float	minTrackPt,
		const std::vector< const xAOD::TrackParticle * > &	tracks,
		const jet::TrackVertexAssociation *	tva
	)		const

private

Definition at line 186 of file JetTrackMomentsTool.cxx.

 {
     std::vector<TrackMomentStruct> moments;
     moments.resize(vertices->size());
  
     for (size_t iVertex = 0; iVertex < vertices->size(); ++iVertex)
         moments[iVertex] = getTrackMoments(jet,vertices->at(iVertex),minTrackPt,tracks,tva);
  
     return moments;
 }

◆ initialize()

StatusCode JetTrackMomentsTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 21 of file JetTrackMomentsTool.cxx.

                                            {
  
   ATH_MSG_INFO("Initializing JetTrackMomentsTool " << name());
   if ( m_htsel.empty() ) {
     ATH_MSG_INFO("  No track selector.");
   } else {
     ATH_MSG_INFO("  Track selector: " << m_htsel->name());
   }
  
   if(m_jetContainerName.empty()){
     ATH_MSG_ERROR("JetTrackMomentsTool needs to have its input container name configured!");
     return StatusCode::FAILURE;
   }
  
   // Set up the decoration names for each track pt cut
   for (size_t iCut = 0; iCut < m_minTrackPt.size(); ++iCut) {
     const float minPt = m_minTrackPt[iCut];
     const std::string baseName = getMomentBaseName(minPt);
     m_keysNumTrk.emplace_back(  m_jetContainerName + ".NumTrk"     + baseName + m_suffix);
     m_keysSumPtTrk.emplace_back(m_jetContainerName + ".SumPtTrk"   + baseName + m_suffix);
     m_keysTrkWidth.emplace_back(m_jetContainerName + ".TrackWidth" + baseName + m_suffix);
     if(m_doPFlowMoments){
       m_keysNumCPFO.emplace_back(  m_jetContainerName + ".NumChargedPFO"   + baseName + m_suffix);
       m_keysSumPtCPFO.emplace_back(m_jetContainerName + ".SumPtChargedPFO" + baseName + m_suffix);
       m_keysCPFOWidth.emplace_back(m_jetContainerName + ".ChargedPFOWidth" + baseName + m_suffix);
     }
   }
  
   ATH_CHECK(m_vertexContainer_key.initialize());
   ATH_CHECK(m_tva_key.initialize());
   ATH_CHECK(m_keysNumTrk.initialize());
   ATH_CHECK(m_keysSumPtTrk.initialize());
   ATH_CHECK(m_keysTrkWidth.initialize());
   ATH_CHECK(m_keysNumCPFO.initialize(m_doPFlowMoments));
   ATH_CHECK(m_keysSumPtCPFO.initialize(m_doPFlowMoments));
   ATH_CHECK(m_keysCPFOWidth.initialize(m_doPFlowMoments));
  
   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.

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32 {return decorate(jets);};

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, top::TopObjectSelection, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

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

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

Gaudi::Property<std::string> JetTrackMomentsTool::m_assocTracksName {this, "AssociatedTracks", "", "Name of associated tracks collection"}

private

Definition at line 60 of file JetTrackMomentsTool.h.

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

Gaudi::Property<bool> JetTrackMomentsTool::m_doPFlowMoments {this, "DoPFlowMoments", false, "Calculate PFlow Object track moments?"}

private

Definition at line 63 of file JetTrackMomentsTool.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_htsel

ToolHandle<IJetTrackSelector> JetTrackMomentsTool::m_htsel {this, "TrackSelector", "", "Track selector tool"}

private

Definition at line 65 of file JetTrackMomentsTool.h.

◆ m_jetContainerName

Gaudi::Property<std::string> JetTrackMomentsTool::m_jetContainerName {this, "JetContainer", "", "SG key for input jet container"}

private

Definition at line 59 of file JetTrackMomentsTool.h.

◆ m_keysCPFOWidth

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetTrackMomentsTool::m_keysCPFOWidth {this, "ChargedPFOWidthDecorKeys", {}, "SG keys for ChargedPFO Width decoration (not to be configured manually!)"}

private

Definition at line 75 of file JetTrackMomentsTool.h.

◆ m_keysNumCPFO

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetTrackMomentsTool::m_keysNumCPFO {this, "NumChargedPFODecorKeys", {}, "SG keys for NumChargedPFO decoration (not to be configured manually!)"}

private

Definition at line 73 of file JetTrackMomentsTool.h.

◆ m_keysNumTrk

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetTrackMomentsTool::m_keysNumTrk {this, "NumTrkDecorKeys", {}, "SG keys for NumTrk decoration (not to be configured manually!)"}

private

Definition at line 70 of file JetTrackMomentsTool.h.

◆ m_keysSumPtCPFO

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetTrackMomentsTool::m_keysSumPtCPFO {this, "SumPtChargedPFODecorKeys", {}, "SG keys for SumPtChargedPFO decoration (not to be configured manually!)"}

private

Definition at line 74 of file JetTrackMomentsTool.h.

◆ m_keysSumPtTrk

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetTrackMomentsTool::m_keysSumPtTrk {this, "SumPtTrkDecorKeys", {}, "SG keys for SumPtTrk decoration (not to be configured manually!)"}

private

Definition at line 71 of file JetTrackMomentsTool.h.

◆ m_keysTrkWidth

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetTrackMomentsTool::m_keysTrkWidth {this, "TrackWidthDecorKeys", {}, "SG keys for TrackWidth decoration (not to be configured manually!)"}

private

Definition at line 72 of file JetTrackMomentsTool.h.

◆ m_minTrackPt

Gaudi::Property<std::vector<float> > JetTrackMomentsTool::m_minTrackPt {this, "TrackMinPtCuts", {}, "Vector of track pt cuts"}

private

Definition at line 62 of file JetTrackMomentsTool.h.

◆ m_suffix

Gaudi::Property<std::string> JetTrackMomentsTool::m_suffix {this, "MomentSuffix", "", "Suffix for track moment decorations"}

private

Definition at line 61 of file JetTrackMomentsTool.h.

◆ m_tva_key

SG::ReadHandleKey<jet::TrackVertexAssociation> JetTrackMomentsTool::m_tva_key {this, "TrackVertexAssociation", "", "SG key for track-vertex association"}

private

Definition at line 68 of file JetTrackMomentsTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> JetTrackMomentsTool::m_vertexContainer_key {this, "VertexContainer", "", "SG key for vertex container"}

private

Definition at line 67 of file JetTrackMomentsTool.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:

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetTrackMomentsTool()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ decorate()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getMomentBaseName()

◆ getName()

◆ getProperty()

◆ getTrackMoments() [1/2]

◆ getTrackMoments() [2/2]

◆ initialize()

◆ inputHandles()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_assocTracksName

◆ m_detStore

◆ m_doPFlowMoments

◆ m_evtStore

◆ m_htsel

◆ m_jetContainerName

◆ m_keysCPFOWidth

◆ m_keysNumCPFO

◆ m_keysNumTrk

◆ m_keysSumPtCPFO

◆ m_keysSumPtTrk

◆ m_keysTrkWidth

◆ m_minTrackPt

◆ m_suffix

◆ m_tva_key

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka