Steven Schramm
February 2014. More...

#include <JetVertexFractionTool.h>

Inheritance diagram for JetVertexFractionTool:

Collaboration diagram for JetVertexFractionTool:

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

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

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

float	getCorrJetVertexFraction (const xAOD::Vertex , const std::vector< const xAOD::TrackParticle > &, const xAOD::TrackParticleContainer &, const jet::TrackVertexAssociation ) const

ElementLink< xAOD::VertexContainer >	getMaxJetVertexFraction (const xAOD::VertexContainer *, const std::vector< float > &) const

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

Protected Attributes
Gaudi::Property< bool >	m_isTrigger {this, "IsTrigger", false, "Is this in the trigger?"}

Gaudi::Property< bool >	m_useOriginVertex = {this, "UseOriginVertex", false, "use origin vertex for each jet"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_jvfCorrVtxHandleKey

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
std::vector< float >	getEmptyJetVertexFraction (const xAOD::VertexContainer *) const

int	getPileupTrackCount (const xAOD::Vertex , const xAOD::TrackParticleContainer &, const jet::TrackVertexAssociation *) const

const xAOD::Vertex *	findHSVertex (const xAOD::VertexContainer *&) const

std::pair< float, float >	getJetVertexTrackSums (const xAOD::Vertex , const std::vector< const xAOD::TrackParticle > &, const jet::TrackVertexAssociation *) 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 track container"}

Gaudi::Property< float >	m_kcorrJVF {this, "K_JVFCorrScale", 0.01, "Value of k for JVFCorr calculation"}

Gaudi::Property< float >	m_PUtrkptcut {this, "PUTrkPtCut", 30000., "Pileup track pt cut (MeV)"}

Gaudi::Property< bool >	m_suppressInputDeps {this, "SuppressInputDependence", false, "Will SumPtTrk be created in the same algorithm that uses this tool?"}

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

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

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

SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_tracksCont_key {this, "TrackParticleContainer", "", "Input track container"}

SG::ReadDecorHandleKey< xAOD::JetContainer >	m_sumPtTrkKey {this, "SumPtTrkName", "SumPtTrkPt500", "SG key for input SumPtTrk decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_jvfKey {this, "JVFName", "JVF", "SG key for output JVF decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_jvfCorrKey {this, "JVFCorrName", "JVFCorr", "SG key for output JVFCorr decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_maxJvfVtxKey {this, "HighestJVFVertexName", "HighestJVFVtx", "SG key for output HighestJVFVertex decoration"}

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 the jet vertex fraction (JVF) JVF is a vector<float> with respect to all vertices

Calculation requires three main types of information

Vertex container for the event (from evtStore), which the JVF vector is aligned with
Tracks associated to the input jet (in the jet aux store)
Track vertex association object (from evtStore)

Using this information, the procedure can be broken into three main steps:

Retrieve necessary information
Helper method to create the full vector given the information
Helper method to create the JVF value for one vertex given the information

Properties: VertexContainer - name of the vertex container AssociatedTracks - name for attribute holding the list of associated tracks TrackVertexAssociation - name for the container holding the track-vertex associations TrackSelector - tool to select tracks (none ==> no selection) JVFName - name for the JVF array attribute (default is "JVF")

Definition at line 56 of file JetVertexFractionTool.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

◆ JetVertexFractionTool()

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

Definition at line 13 of file JetVertexFractionTool.cxx.

14 : asg::AsgTool(name) {

15 }

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 JetVertexFractionTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 61 of file JetVertexFractionTool.cxx.

                                                                                 {
  
   // Get the vertices container
   auto vertexContainer = SG::makeHandle (m_vertexContainer_key);
   if (!vertexContainer.isValid()){
     ATH_MSG_WARNING("Invalid  xAOD::VertexContainer datahandle"
                     << m_vertexContainer_key.key()); 
     return StatusCode::FAILURE;
   }
   const auto *vertices = vertexContainer.cptr();
  
   ATH_MSG_DEBUG("Successfully retrieved VertexContainer: " 
                 << m_vertexContainer_key.key()); 
  
   // Get the Tracks container
   auto tracksContainer = SG::makeHandle (m_tracksCont_key);
   if (!tracksContainer.isValid()){
     ATH_MSG_ERROR("Could not retrieve the TrackParticleContainer: " 
                   << m_tracksCont_key.key());
     return StatusCode::FAILURE;
   }
   const auto *tracksCont = tracksContainer.cptr();
  
   ATH_MSG_DEBUG("Successfully retrieved TrackParticleContainer: " 
                 << m_tracksCont_key.key());
  
   // Get the TVA object
   auto tvaContainer = SG::makeHandle (m_tva_key);
   if (!tvaContainer.isValid()){
     ATH_MSG_ERROR("Could not retrieve the TrackVertexAssociation: " 
                   << m_tva_key.key());
     return StatusCode::FAILURE;
   }
   const auto *tva = tvaContainer.cptr();
  
   ATH_MSG_DEBUG("Successfully retrieved TrackVertexAssociation: " 
                 << m_tva_key.key());
  
   if (vertices->empty() ) {
     ATH_MSG_WARNING("There are no vertices in the container. Exiting");
     return StatusCode::SUCCESS;
   }
  
   // Get the vertex to calculate with respect to
   // Only appropriate if we are using a single vertex interpretation, not if using OriginVertex
   const xAOD::Vertex* HSvertex = nullptr;
   if (!m_useOriginVertex)
     HSvertex = findHSVertex(vertices);
  
   // Count pileup tracks - currently done for each collection
   // Only appropriate if we are using a single vertex interpretation, not if using OriginVertex
   const int n_putracks = !m_useOriginVertex ? getPileupTrackCount(HSvertex, tracksCont, tva) : -1;
  
   SG::ReadDecorHandle<xAOD::JetContainer, std::vector<float> > sumPtTrkHandle(m_sumPtTrkKey);
   SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float> > jvfHandle(m_jvfKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> jvfCorrHandle(m_jvfCorrKey);
  
   // We don't want to initialize this handle if this is trigger
   std::unique_ptr<SG::WriteDecorHandle<xAOD::JetContainer, ElementLink<xAOD::VertexContainer> > > maxJvfVtxHandle;
   if(!m_isTrigger)
     maxJvfVtxHandle = std::make_unique<SG::WriteDecorHandle<xAOD::JetContainer, ElementLink<xAOD::VertexContainer> > >(m_maxJvfVtxKey);
  
   for(const xAOD::Jet * jet : jetCont) {
     // Get origin-vertex-specific information if relevant
     if (m_useOriginVertex)
     {
       HSvertex = jet->getAssociatedObject<xAOD::Vertex>("OriginVertex");
       if (!HSvertex) // nullptr if the attribute doesn't exist
       {
         ATH_MSG_ERROR("OriginVertex was requested, but the jet does not contain an OriginVertex");
         return StatusCode::FAILURE;
       }
       else
         ATH_MSG_VERBOSE("JetVertexFractionTool " << name() << " is using OriginVertex at index: " << HSvertex->index());
     }
     const int n_putracks_local = !m_useOriginVertex ? n_putracks : getPileupTrackCount(HSvertex,tracksCont,tva);
  
     // Get the tracks associated to the jet
     // Note that there may be no tracks - this is both normal and an error case
     std::vector<const xAOD::TrackParticle*> tracks;
     if ( ! jet->getAssociatedObjects(m_assocTracksName, tracks) ) {
       ATH_MSG_DEBUG("Associated tracks not found.");
     }
  
     // Get the track pT sums for all tracks in the jet (first key) and those associated to PU (second key) vertices.
     const std::pair<float,float> tracksums = getJetVertexTrackSums(HSvertex, tracks, tva);
     // Get the track pT sums for each individual vertex
     std::vector<float> vsumpttrk = sumPtTrkHandle(*jet);
     float sumpttrk_all = tracksums.first;
     float sumpttrk_nonPV = tracksums.second;
     float sumpttrk_PV = vsumpttrk[HSvertex->index() - (*vertices)[0]->index()];
  
     // Get and set the JVF vector
     std::vector<float> jvf(vertices->size());
     for(size_t vtxi=0; vtxi<vertices->size(); ++vtxi) {
       jvf[vtxi] = sumpttrk_all > 1e-9 ? vsumpttrk[vtxi] / sumpttrk_all : -1;
     }
     jvfHandle(*jet) = jvf;
  
     // Get and set the highest JVF vertex
     if(!m_isTrigger) {
       (*maxJvfVtxHandle)(*jet) = getMaxJetVertexFraction(vertices,jvf);
     }
     // Calculate JVFCorr
     // Default JVFcorr to -1 when no tracks are associated.
     float jvfcorr = -999.;
     if(sumpttrk_PV + sumpttrk_nonPV > 0) {
       jvfcorr = sumpttrk_PV / (sumpttrk_PV + ( sumpttrk_nonPV / (m_kcorrJVF * std::max(n_putracks_local, 1) ) ) );
     } else {
       jvfcorr = -1;
     }
     jvfCorrHandle(*jet) = jvfcorr;
   }
  
   if (m_useOriginVertex) { // Add extra info to compute JVT for jets assuming other vertices as origin
     std::vector<float> jvfCorrVtx;
      
     auto jvfCorrVtxHandle = std::make_unique<SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float> > >(m_jvfCorrVtxHandleKey);
  
     for(const xAOD::Jet * jet : jetCont) {      
       jvfCorrVtx.clear();
       std::vector<float> vsumpttrk = sumPtTrkHandle(*jet);
  
       // Loop over vertices
       for(const xAOD::Vertex* pv : *vertices){
  
         // Calculate JVFCorr for a given vertex
         // Default JVFcorr to -1 when no tracks are associated. -  copied from JetVertexFractionTool.cxx
         // Get the tracks associated to the jet
         // Note that there may be no tracks - this is both normal and an error case
         std::vector<const xAOD::TrackParticle*> tracks;
         if ( ! jet->getAssociatedObjects(m_assocTracksName, tracks) ) {
           ATH_MSG_DEBUG("Associated tracks not found.");
         }
       
         const int n_putracks = getPileupTrackCount(pv, tracksCont, tva);
  
         // Get the track pT sums for all tracks in the jet (first key) and those associated to PU(?) (second key) vertices.
         const std::pair<float,float> tracksums = getJetVertexTrackSums(pv, tracks, tva);
         // Get the track pT sums for each individual vertex
     
         float sumpttrk_PV = vsumpttrk[pv->index()];
         float sumpttrk_nonPV = tracksums.second; // Consider as "PU" all vertices not matching the one I'm looping over
         float jvfcorr = -999.;
         float kcorrJVF = 0.01;
         if(sumpttrk_PV + sumpttrk_nonPV > 0) { 
           jvfcorr = sumpttrk_PV / (sumpttrk_PV + ( sumpttrk_nonPV / (kcorrJVF * std::max(n_putracks, 1) ) ) );
         } else {
           jvfcorr = -1;
         }
         jvfCorrVtx.push_back(jvfcorr);
       }
  
       (*jvfCorrVtxHandle)(*jet) = jvfCorrVtx;
       // Done
       
     } 
   }
   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

◆ findHSVertex()

const xAOD::Vertex * JetVertexFractionTool::findHSVertex ( const xAOD::VertexContainer *& vertices ) const

private

Definition at line 314 of file JetVertexFractionTool.cxx.

 {
   const xAOD::Vertex* primvert = nullptr;
   for (const xAOD::Vertex* pv : *vertices) {
     if (pv->vertexType() == xAOD::VxType::PriVtx ) {
         primvert = pv;
             ATH_MSG_VERBOSE("JetVertexFractionTool " << name() << " Found HS vertex.");
         break;
     }
   }
   if (primvert == nullptr ) {
     ATH_MSG_VERBOSE("There is no vertex of type PriVx. Taking default vertex.");
     primvert = *(vertices->begin());
   }
   return primvert;
 }

◆ getCorrJetVertexFraction()

float JetVertexFractionTool::getCorrJetVertexFraction	(	const xAOD::Vertex *	,
		const std::vector< const xAOD::TrackParticle * > &	,
		const xAOD::TrackParticleContainer *&	,
		const jet::TrackVertexAssociation *
	)		const

◆ getEmptyJetVertexFraction()

std::vector<float> JetVertexFractionTool::getEmptyJetVertexFraction ( const xAOD::VertexContainer * ) const

private

◆ getJetVertexTrackSums()

std::pair< float, float > JetVertexFractionTool::getJetVertexTrackSums	(	const xAOD::Vertex *	vertex,
		const std::vector< const xAOD::TrackParticle * > &	tracks,
		const jet::TrackVertexAssociation *	tva
	)		const

private

Definition at line 242 of file JetVertexFractionTool.cxx.

                                                                                                               {
     float sumTrackAll = 0;
     float sumTracknotPV = 0;
     bool notsel = m_htsel.empty();
     unsigned int nkeep = 0;
     unsigned int nskip = 0;
     for (size_t iTrack = 0; iTrack < tracks.size(); ++iTrack) {
       const xAOD::TrackParticle* track = tracks.at(iTrack);
       if ( notsel || m_htsel->keep(*track) ) {
         sumTrackAll += track->pt();
  
         const xAOD::Vertex* ptvtx = tva->associatedVertex(track);
         if( ptvtx != nullptr ) {
           // Track has vertex, assign to appropriate pT sum
           if ( ptvtx->index() != vertex->index() ) {sumTracknotPV += track->pt(); }
         }
         ++nkeep;
       }
       else { ++nskip; }
     }
     ATH_MSG_VERBOSE("JetVertexTaggerTool " << name()
             << ": nsel=" << nkeep
             << ", nrej=" << nskip           );
  
     return std::make_pair(sumTrackAll,sumTracknotPV);
  
 }

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

◆ getMaxJetVertexFraction()

ElementLink< xAOD::VertexContainer > JetVertexFractionTool::getMaxJetVertexFraction	(	const xAOD::VertexContainer *	vertices,
		const std::vector< float > &	jvf
	)		const

Definition at line 224 of file JetVertexFractionTool.cxx.

                                                            {
   size_t maxIndex = 0;
   float maxVal = -100;
   for ( size_t iVertex = 0; iVertex < jvf.size(); ++iVertex ) {
     if ( jvf.at(iVertex) > maxVal ) {
       maxIndex = iVertex;
       maxVal = jvf.at(iVertex);
     }
   }
   ElementLink<xAOD::VertexContainer> link =
     ElementLink<xAOD::VertexContainer>(*vertices,vertices->at(maxIndex)->index());
   return link;
 }

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

◆ getPileupTrackCount()

int JetVertexFractionTool::getPileupTrackCount	(	const xAOD::Vertex *	vertex,
		const xAOD::TrackParticleContainer *&	tracksCont,
		const jet::TrackVertexAssociation *	tva
	)		const

private

Definition at line 275 of file JetVertexFractionTool.cxx.

 {
     int n_pileuptrackcount = 0;
     bool notsel = m_htsel.empty();
     unsigned int nkeep = 0;
     unsigned int nskip = 0;
     int tot_count = 0;
     for(size_t iTrack = 0; iTrack < tracksCont->size(); ++iTrack)
       {
     const xAOD::TrackParticle * track = tracksCont->at(iTrack);
     if ( notsel || m_htsel->keep(*track) ) {
       const xAOD::Vertex* ptvtx = tva->associatedVertex(track);
       // Count track as PU if associated with non-primary vertex and within pT cut.
       // N.B. tracks with no vertex associated may be added to PV track sums, but not PU sums, nor the PU vertex counting.
       if ( ptvtx != nullptr ) {
         if ( (ptvtx->index() != vertex->index() ) && (track->pt() < m_PUtrkptcut) ) ++n_pileuptrackcount;
       }
       tot_count++;
       ++nkeep;
     }
     else { ++nskip; }
       }
     const int n_pileuptracks = n_pileuptrackcount;
  
     ATH_MSG_VERBOSE("JetVertexFractionTool " << name()
                   << ": nsel=" << nkeep
                   << ", nrej=" << nskip
          << ", total " << tracksCont->size() );
     ATH_MSG_VERBOSE("JetVertexFractionTool " << name()
          << ": n_PUtracks=" << n_pileuptracks
          << ", total=" << tot_count          );
  
     return n_pileuptracks;
 }

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode JetVertexFractionTool::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 19 of file JetVertexFractionTool.cxx.

                                              {
   ATH_MSG_INFO("Initializing JetVertexFractionTool " << name());
   ATH_MSG_INFO("Using origin vertex: " << m_useOriginVertex);
  
   if(m_jetContainerName.empty()){
     ATH_MSG_ERROR("JetVertexFractionTool needs to have its input jet container name configured!");
     return StatusCode::FAILURE;
   }
  
   if ( m_htsel.empty() ) {
     ATH_MSG_INFO("  No track selector.");
   } else {
     ATH_MSG_INFO("  Track selector: " << m_htsel->name());
   }
   ATH_MSG_INFO("  Attribute name: " << m_jvfKey.key());
  
   m_sumPtTrkKey = m_jetContainerName + "." + m_sumPtTrkKey.key();
   m_jvfKey = m_jetContainerName + "." + m_jvfKey.key();
   m_jvfCorrKey = m_jetContainerName + "." + m_jvfCorrKey.key();
   m_maxJvfVtxKey = m_jetContainerName + "." + m_maxJvfVtxKey.key();
   m_jvfCorrVtxHandleKey = m_jvfCorrKey.key() + "Vec";
  
 #ifndef XAOD_STANDALONE
   if(m_suppressInputDeps){
     // The user has promised that this will be produced by the same alg running JVF.
     // Tell the scheduler to ignore it to avoid circular dependencies.
     renounce(m_sumPtTrkKey);
   }
 #endif
  
   ATH_CHECK(m_vertexContainer_key.initialize());
   ATH_CHECK(m_tva_key.initialize());
   ATH_CHECK(m_tracksCont_key.initialize());
   ATH_CHECK(m_sumPtTrkKey.initialize());
   ATH_CHECK(m_jvfKey.initialize());
   ATH_CHECK(m_jvfCorrKey.initialize());
   ATH_CHECK(m_maxJvfVtxKey.initialize(!m_isTrigger));
   ATH_CHECK(m_jvfCorrVtxHandleKey.initialize(m_useOriginVertex));
  
   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> JetVertexFractionTool::m_assocTracksName {this, "AssociatedTracks", "", "Name of associated track container"}

private

Definition at line 88 of file JetVertexFractionTool.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_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> JetVertexFractionTool::m_htsel {this, "TrackSelector", "", "Track selector tool"}

private

Definition at line 93 of file JetVertexFractionTool.h.

◆ m_isTrigger

Gaudi::Property<bool> JetVertexFractionTool::m_isTrigger {this, "IsTrigger", false, "Is this in the trigger?"}

protected

Definition at line 124 of file JetVertexFractionTool.h.

◆ m_jetContainerName

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

private

Definition at line 87 of file JetVertexFractionTool.h.

◆ m_jvfCorrKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexFractionTool::m_jvfCorrKey {this, "JVFCorrName", "JVFCorr", "SG key for output JVFCorr decoration"}

private

Definition at line 100 of file JetVertexFractionTool.h.

◆ m_jvfCorrVtxHandleKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexFractionTool::m_jvfCorrVtxHandleKey

protected

Definition at line 126 of file JetVertexFractionTool.h.

◆ m_jvfKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexFractionTool::m_jvfKey {this, "JVFName", "JVF", "SG key for output JVF decoration"}

private

Definition at line 99 of file JetVertexFractionTool.h.

◆ m_kcorrJVF

Gaudi::Property<float> JetVertexFractionTool::m_kcorrJVF {this, "K_JVFCorrScale", 0.01, "Value of k for JVFCorr calculation"}

private

Definition at line 89 of file JetVertexFractionTool.h.

◆ m_maxJvfVtxKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexFractionTool::m_maxJvfVtxKey {this, "HighestJVFVertexName", "HighestJVFVtx", "SG key for output HighestJVFVertex decoration"}

private

Definition at line 101 of file JetVertexFractionTool.h.

◆ m_PUtrkptcut

Gaudi::Property<float> JetVertexFractionTool::m_PUtrkptcut {this, "PUTrkPtCut", 30000., "Pileup track pt cut (MeV)"}

private

Definition at line 90 of file JetVertexFractionTool.h.

◆ m_sumPtTrkKey

SG::ReadDecorHandleKey<xAOD::JetContainer> JetVertexFractionTool::m_sumPtTrkKey {this, "SumPtTrkName", "SumPtTrkPt500", "SG key for input SumPtTrk decoration"}

private

Definition at line 98 of file JetVertexFractionTool.h.

◆ m_suppressInputDeps

Gaudi::Property<bool> JetVertexFractionTool::m_suppressInputDeps {this, "SuppressInputDependence", false, "Will SumPtTrk be created in the same algorithm that uses this tool?"}

private

Definition at line 91 of file JetVertexFractionTool.h.

◆ m_tracksCont_key

SG::ReadHandleKey<xAOD::TrackParticleContainer> JetVertexFractionTool::m_tracksCont_key {this, "TrackParticleContainer", "", "Input track container"}

private

Definition at line 97 of file JetVertexFractionTool.h.

◆ m_tva_key

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

private

Definition at line 96 of file JetVertexFractionTool.h.

◆ m_useOriginVertex

Gaudi::Property<bool> JetVertexFractionTool::m_useOriginVertex = {this, "UseOriginVertex", false, "use origin vertex for each jet"}

protected

Definition at line 125 of file JetVertexFractionTool.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> JetVertexFractionTool::m_vertexContainer_key {this, "VertexContainer", "", "Input vertex container"}

private

Definition at line 95 of file JetVertexFractionTool.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

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetVertexFractionTool()

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

◆ findHSVertex()

◆ getCorrJetVertexFraction()

◆ getEmptyJetVertexFraction()

◆ getJetVertexTrackSums()

◆ getKey()

◆ getMaxJetVertexFraction()

◆ getName()

◆ getPileupTrackCount()

◆ getProperty()

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

◆ m_htsel

◆ m_isTrigger

◆ m_jetContainerName

◆ m_jvfCorrKey

◆ m_jvfCorrVtxHandleKey

◆ m_jvfKey

◆ m_kcorrJVF

◆ m_maxJvfVtxKey

◆ m_PUtrkptcut

◆ m_sumPtTrkKey

◆ m_suppressInputDeps

◆ m_tracksCont_key

◆ m_tva_key

◆ m_useOriginVertex

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka