James Frost
November 2014. More...

#include <JetVertexTaggerTool.h>

Inheritance diagram for JetVertexTaggerTool:

Collaboration diagram for JetVertexTaggerTool:

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

virtual	~JetVertexTaggerTool ()

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	evaluateJvt (float rpt, float jvfcorr) const

float	updateJvt (const xAOD::Jet &jet) const override
	Calculate the updated JVT. More...

const xAOD::Vertex *	findHSVertex () 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...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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 the input jet container"}

Gaudi::Property< std::string >	m_jvtlikelihoodHistName {this, "JVTLikelihoodHistName", "JVTRootCore_kNN100trim_pt20to50_Likelihood", "JVT likelihood histogram name"}

Gaudi::Property< std::string >	m_jvtfileName {this, "JVTFileName", "JetMomentTools/JVTlikelihood_20140805.root", "JVT likelihood file name"}

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

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

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

SG::ReadDecorHandleKey< xAOD::JetContainer >	m_jvfCorrVtxKey

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

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_jvtKey {this, "JVTName", "Jvt", "SG key for output JVT decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_jvtVecKey

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_rptKey {this, "RpTName", "JvtRpt", "SG key for output RpT decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_rptVecKey

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

TString	m_fn

TH2F *	m_jvthisto

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

James Frost
November 2014.

Updated for Run 3 by Bill Balunas March 2020

Tool to calculate the jet vertex tag (JVT) JVT is a float per jet

The JVT likelihood is parameterised in terms of: RPT: ratio of the primary vertex track sum to the jet pT JVFCorr: a corrected JVF calculation accounting for the number of PU tracks in the event.

Calculation requires three main types of information

Vertex container for the event (from evtStore), with respect to which the JVT track sums
Tracks associated to each of the input jet (in the jet aux store)
Track vertex association object (from evtStore)
The track container needed for PU track counting
The ID track selector tool to provide an input track selection.
An input file with the JVT likelihood stored as a 2D histogram.

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

Count the total number of pileup tracks
Per jet: Get track pT sums needed for JVFCorr and RpT
Use JVT likelihood to get JVT value

Attributes added (each is a float per jet):

Jvt - the JVTLikelihood value for the jet. This is parameterised in terms of:
JvtRpt - the ratio of the PV track pT sum to the jet pT
JvtJvfcorr - a corrected Jvf quantity that corrects for the number of pileup tracks in an event.

Properties: JetContainer - name of the jet container VertexContainer - name of the vertex container TrackParticleContainer - name of the track 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) JVTFileName - ROOT Filename containing JVT likelihood histogram JVTLikelihoodHistName - JVT Likelihood histogram name JVTName - name for the 3 JVT attributes (default is "JVT") K_JVFCorrScale - the scale factor for pileup tracks in the JVFCorr calculation (default is 0.01) Z0Cut - Z0 value (in mm) within which tracks associated to no vertex may be assigned to the primary vertex (default is 3.) PUTrkPtCut - the track pT (in MeV) below which tracks associated to no vertex may be assigned to the primary vertex (default is 30000.)

Definition at line 78 of file JetVertexTaggerTool.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

◆ JetVertexTaggerTool()

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

Definition at line 23 of file JetVertexTaggerTool.cxx.

 : asg::AsgTool(name),
   m_jvthisto(nullptr)
 {
 }

◆ ~JetVertexTaggerTool()

JetVertexTaggerTool::~JetVertexTaggerTool ( )

virtual

Definition at line 31 of file JetVertexTaggerTool.cxx.

                                          {
   if(m_jvthisto) delete m_jvthisto;
 }

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

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 99 of file JetVertexTaggerTool.cxx.

                                                                               {
  
   // 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();
     if(!HSvertex) return StatusCode::FAILURE;
   }
  
   // Grab vertices for index bookkeeping
   SG::ReadHandle<xAOD::VertexContainer> vertexHandle = SG::makeHandle (m_vertexContainer_key);
   const xAOD::VertexContainer* vertices = vertexHandle.cptr();
  
   SG::ReadDecorHandle<xAOD::JetContainer, float> jvfCorrHandle(m_jvfCorrKey);
   SG::ReadDecorHandle<xAOD::JetContainer, std::vector<float> > sumPtTrkHandle(m_sumPtTrkKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> jvtHandle(m_jvtKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> rptHandle(m_rptKey);
  
  
  
   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("JetVertexTaggerTool " << name() << " is using OriginVertex at index: " << HSvertex->index());
       }
     }
  
     // Calculate RpT and JVFCorr
     // Default JVFcorr to -1 when no tracks are associated.
     float jvfcorr = jvfCorrHandle(*jet);
     std::vector<float> sumpttrk = sumPtTrkHandle(*jet);
     const float rpt = sumpttrk[HSvertex->index() - (*vertices)[0]->index()]/jet->pt();
     float jvt = evaluateJvt(rpt, jvfcorr);
  
     rptHandle(*jet) = rpt;
     jvtHandle(*jet) = jvt;
     ATH_MSG_VERBOSE("JetVertexTaggerTool " << name() << ": JVT=" << jvt << ", RpT=" << rpt << ", JVFCorr=" << jvfcorr);
   }
  
   if (m_useOriginVertex) { // Compute JVT for jets assuming other vertices as origin
  
     SG::ReadDecorHandle<xAOD::JetContainer, std::vector<float> > jvfCorrVtxHandle(m_jvfCorrVtxKey);
     SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float>> jvtVecHandle(m_jvtVecKey);
     SG::WriteDecorHandle<xAOD::JetContainer, std::vector<float>> rptVecHandle(m_rptVecKey);
  
     std::vector<float> jvtVtx;
     std::vector<float> rptVtx;
  
     for(const xAOD::Jet * jet : jetCont) {      
       jvtVtx.clear();
       rptVtx.clear();
       std::vector<float> sumpttrk = sumPtTrkHandle(*jet);
       std::vector<float> jvfcorrVtx = jvfCorrVtxHandle(*jet);
  
       // Loop over vertices
       for(size_t vtxi=0; vtxi<vertices->size(); ++vtxi) {
  
         float jvfcorr = jvfcorrVtx.at(vtxi);
         const float rpt = sumpttrk[vtxi]/jet->pt();
         float jvt = evaluateJvt(rpt, jvfcorr);
         jvtVtx.push_back(jvt);
         rptVtx.push_back(rpt);
       }
  
       jvtVecHandle(*jet) = jvtVtx;
       rptVecHandle(*jet) = rptVtx;
       // 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; }

◆ evaluateJvt()

float JetVertexTaggerTool::evaluateJvt	(	float	rpt,
		float	jvfcorr
	)		const

Definition at line 184 of file JetVertexTaggerTool.cxx.

                                                                      {
   // Look up JVT value
   float jvt = -999.;
   if ( jvfcorr == -1.0 ) {
     jvt = -0.1;
   } else {
     float rpt_inputtojvt = std::min(rpt, (float) 1. );
     int bin = std::as_const(m_jvthisto)->FindBin(jvfcorr, rpt_inputtojvt);
     jvt = m_jvthisto->GetBinContent(bin);
     jvt = m_jvthisto->Interpolate(jvfcorr, rpt_inputtojvt);
   }
   return jvt;
 }

◆ 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 * JetVertexTaggerTool::findHSVertex ( ) const

Definition at line 234 of file JetVertexTaggerTool.cxx.

 {
   // Get input vertex collection
   SG::ReadHandle<xAOD::VertexContainer> vertexHandle = SG::makeHandle (m_vertexContainer_key);
   if (!vertexHandle.isValid()){
     ATH_MSG_ERROR("Invalid VertexContainer datahandle: " << m_vertexContainer_key.key());
     return nullptr;
   }
   const xAOD::VertexContainer* vertices = vertexHandle.cptr();
   ATH_MSG_DEBUG("Successfully retrieved VertexContainer: " << m_vertexContainer_key.key());
  
   if (vertices->empty() ) {
     ATH_MSG_WARNING("There are no vertices in the container. Exiting");
     return nullptr;
   }
  
   for ( size_t iVertex = 0; iVertex < vertices->size(); ++iVertex ) {
     if(vertices->at(iVertex)->vertexType() == xAOD::VxType::PriVtx) {
  
       ATH_MSG_VERBOSE("JetVertexTaggerTool " << name() << " Found HS vertex at index: "<< iVertex);
       return vertices->at(iVertex);
     }
   }
   ATH_MSG_VERBOSE("There is no vertex of type PriVx. Taking default vertex.");
   return vertices->at(0);
 }

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

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

◆ initialize()

StatusCode JetVertexTaggerTool::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 37 of file JetVertexTaggerTool.cxx.

                                            {
   ATH_MSG_INFO("Initializing JetVertexTaggerTool " << name());
   ATH_MSG_INFO("Using origin vertex: " << m_useOriginVertex);
  
   if(m_jetContainerName.empty()){
     ATH_MSG_ERROR("JetVertexTaggerTool needs to have its input jet container configured!");
     return StatusCode::FAILURE;
   }
  
   // Use the Path Resolver to find the jvt file and retrieve the likelihood histogram
   m_fn =  PathResolverFindCalibFile(m_jvtfileName);
   ATH_MSG_INFO("  Reading JVT file from:\n    " << m_jvtfileName << "\n");
   ATH_MSG_INFO("                     resolved in  :\n    " << m_fn << "\n\n");
  
   std::unique_ptr<TFile> jvtfile {TFile::Open(m_fn)};
   if(!jvtfile){
     ATH_MSG_FATAL("Cannot open JVTLikelihoodFile: " << m_fn);
     return StatusCode::FAILURE;
   }
  
   ATH_MSG_VERBOSE("\n Reading JVT likelihood histogram from:\n    " << m_fn << "\n\n");
  
   m_jvthisto = (TH2F*)jvtfile->Get(std::string(m_jvtlikelihoodHistName).c_str() );
   if(!m_jvthisto){
     ATH_MSG_FATAL( "\n  Found JVT file, but JVT histogram missing. Aborting..." );
     return StatusCode::FAILURE;
   }
   m_jvthisto->SetDirectory (nullptr);
  
   m_jvfCorrKey = m_jetContainerName + "." + m_jvfCorrKey.key();
   m_jvfCorrVtxKey = m_jvfCorrKey.key()+"Vec";
   m_sumPtTrkKey = m_jetContainerName + "." + m_sumPtTrkKey.key();
   m_jvtKey = m_jetContainerName + "." + m_jvtKey.key();
   m_jvtVecKey = m_jvtKey.key()+"Vec";
   m_rptKey = m_jetContainerName + "." + m_rptKey.key();
   m_rptVecKey = m_rptKey.key()+"Vec";
  
 #ifndef XAOD_STANDALONE
   if(m_suppressInputDeps){
     // The user has promised that these will be produced by the same alg running JVT.
     // Tell the scheduler to ignore them to avoid circular dependencies.
     renounce(m_jvfCorrKey);
     renounce(m_sumPtTrkKey);
   }
 #endif
  
   ATH_CHECK(m_vertexContainer_key.initialize());
   ATH_CHECK(m_jvfCorrKey.initialize());
   ATH_CHECK(m_sumPtTrkKey.initialize());
   ATH_CHECK(m_jvtKey.initialize());
   ATH_CHECK(m_rptKey.initialize());
  
   ATH_CHECK(m_jvfCorrVtxKey.initialize(m_useOriginVertex));
   ATH_CHECK(m_jvtVecKey.initialize(m_useOriginVertex));
   ATH_CHECK(m_rptVecKey.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, 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.

◆ updateJvt()

float JetVertexTaggerTool::updateJvt ( const xAOD::Jet & jet ) const

overridevirtual

Calculate the updated JVT.

jet - jet for which JVT is updated The new value for JVT is returned.

Implements IJetUpdateJvt.

Definition at line 200 of file JetVertexTaggerTool.cxx.

                                                              {
   SG::ReadDecorHandle<xAOD::JetContainer, float> jvfCorrHandle(m_jvfCorrKey);
   SG::ReadDecorHandle<xAOD::JetContainer, std::vector<float> > sumPtTrkHandle(m_sumPtTrkKey);
  
   float jvfcorr = jvfCorrHandle(jet);
   std::vector<float> sumpttrk = sumPtTrkHandle(jet);
   
   // Get the vertex to calculate with respect to
   const xAOD::Vertex* HSvertex = nullptr;
   if (!m_useOriginVertex)
     HSvertex = findHSVertex();
   else
   {
     HSvertex = jet.getAssociatedObject<xAOD::Vertex>("OriginVertex");
     if (HSvertex) // nullptr if the attribute doesn't exist, nothing to do as behaviour is same as other method, checked below and return -1
       ATH_MSG_VERBOSE("JetVertexTaggerTool " << name() << " is using OriginVertex at index: " << HSvertex->index());
   }
   
   if(!HSvertex) {
     ATH_MSG_ERROR("No hard scatter vertex found. Returning JVT=-1");
     return -1.;
   }
  
   // Grab vertices for index bookkeeping
   SG::ReadHandle<xAOD::VertexContainer> vertexHandle = SG::makeHandle (m_vertexContainer_key);
   const xAOD::VertexContainer* vertices = vertexHandle.cptr();
  
   const float rptnew = sumpttrk[HSvertex->index() - (*vertices)[0]->index()]/jet.pt();
  
   return evaluateJvt(rptnew, jvfcorr);
 }

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_fn

TString JetVertexTaggerTool::m_fn

private

Definition at line 126 of file JetVertexTaggerTool.h.

◆ m_jetContainerName

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

private

Definition at line 109 of file JetVertexTaggerTool.h.

◆ m_jvfCorrKey

SG::ReadDecorHandleKey<xAOD::JetContainer> JetVertexTaggerTool::m_jvfCorrKey {this, "JVFCorrName", "JVFCorr", "SG key for input JVFCorr decoration"}

private

Definition at line 115 of file JetVertexTaggerTool.h.

◆ m_jvfCorrVtxKey

SG::ReadDecorHandleKey<xAOD::JetContainer> JetVertexTaggerTool::m_jvfCorrVtxKey

private

Definition at line 116 of file JetVertexTaggerTool.h.

◆ m_jvtfileName

Gaudi::Property<std::string> JetVertexTaggerTool::m_jvtfileName {this, "JVTFileName", "JetMomentTools/JVTlikelihood_20140805.root", "JVT likelihood file name"}

private

Definition at line 111 of file JetVertexTaggerTool.h.

◆ m_jvthisto

TH2F* JetVertexTaggerTool::m_jvthisto

private

Definition at line 127 of file JetVertexTaggerTool.h.

◆ m_jvtKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexTaggerTool::m_jvtKey {this, "JVTName", "Jvt", "SG key for output JVT decoration"}

private

Definition at line 118 of file JetVertexTaggerTool.h.

◆ m_jvtlikelihoodHistName

Gaudi::Property<std::string> JetVertexTaggerTool::m_jvtlikelihoodHistName {this, "JVTLikelihoodHistName", "JVTRootCore_kNN100trim_pt20to50_Likelihood", "JVT likelihood histogram name"}

private

Definition at line 110 of file JetVertexTaggerTool.h.

◆ m_jvtVecKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexTaggerTool::m_jvtVecKey

private

Definition at line 119 of file JetVertexTaggerTool.h.

◆ m_rptKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexTaggerTool::m_rptKey {this, "RpTName", "JvtRpt", "SG key for output RpT decoration"}

private

Definition at line 120 of file JetVertexTaggerTool.h.

◆ m_rptVecKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetVertexTaggerTool::m_rptVecKey

private

Definition at line 121 of file JetVertexTaggerTool.h.

◆ m_sumPtTrkKey

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

private

Definition at line 117 of file JetVertexTaggerTool.h.

◆ m_suppressInputDeps

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

private

Definition at line 112 of file JetVertexTaggerTool.h.

◆ m_useOriginVertex

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

private

Definition at line 123 of file JetVertexTaggerTool.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> JetVertexTaggerTool::m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"}

private

Definition at line 114 of file JetVertexTaggerTool.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

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetVertexTaggerTool()

◆ ~JetVertexTaggerTool()

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

◆ evaluateJvt()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ findHSVertex()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateJvt()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_fn

◆ m_jetContainerName

◆ m_jvfCorrKey

◆ m_jvfCorrVtxKey

◆ m_jvtfileName

◆ m_jvthisto

◆ m_jvtKey

◆ m_jvtlikelihoodHistName

◆ m_jvtVecKey

◆ m_rptKey

◆ m_rptVecKey

◆ m_sumPtTrkKey

◆ m_suppressInputDeps

◆ m_useOriginVertex

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka