#include <JetPileupLabelingTool.h>

Inheritance diagram for JetPileupLabelingTool:

Collaboration diagram for JetPileupLabelingTool:

Public Member Functions
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate hard-scatter and pileup labels to a jet collection.
void	print () const override
	Print configured parameters.
	AsgTool (const std::string &name)
	Constructor specifying the tool instance's name.
	AsgTool (const AsgTool &)=delete
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier.
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::string >	m_jetContainerName {this, "RecoJetContainer", "AntiKt4EMPFlowJets", "Input reco jet container name"}
Gaudi::Property< bool >	m_suppressOutputDeps {this, "SuppressOutputDependence", false, "Ignore creating the output decoration dependency for data flow; for analysis"}
Gaudi::Property< float >	m_hsMaxDR {this, "isHSMaxDR", 0.3, "Tag a reco jet as HS if it is at most this distance from a truth jet"}
Gaudi::Property< float >	m_hsMinPt {this, "isHSMinPt", 10e3, "Only consider truth jets above this pT for HS tagging"}
Gaudi::Property< float >	m_puMinDR {this, "isPUMinDR", 0.6, "Tag a reco jet as PU if it is at least this distance from any truth jet"}
Gaudi::Property< float >	m_puMinPt {this, "isPUMinPt", 0, "Only consider truth jets above this pT to veto jets for being PU tagged"}
SG::ReadHandleKey< xAOD::JetContainer >	m_truthJetsKey {this, "TruthJetContainer", "AntiKt4TruthDressedWZJets", "SG key for input Truth HS jets"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_decIsHSKey {this, "isHSLabel", "isJvtHS", "SG key for label of HS jets"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_decIsPUKey {this, "isPULabel", "isJvtPU", "SG key for label of PU jets"}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 20 of file JetPileupLabelingTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ AsgTool() [1/2]

asg::AsgTool::AsgTool ( const AsgTool & )

delete

◆ AsgTool() [2/2]

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

Constructor specifying the tool instance's name.

Definition at line 51 of file AsgTool.cxx.

      : AsgToolBase(
#ifndef XAOD_STANDALONE
                    ::getType(name), ::getName(name), ::getParent(name)
#else // not XAOD_STANDALONE
                    name
#endif // not XAOD_STANDALONE
                    )
#ifdef XAOD_STANDALONE
      , m_event()
#endif // XAOD_STANDALONE
   {
      ToolStore::put( this ).ignore(); // Register the tool in the ToolStore
   }

◆ declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ decorate()

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

overridevirtual

Decorate hard-scatter and pileup labels to a jet collection.

Implements IJetDecorator.

Definition at line 43 of file JetPileupLabelingTool.cxx.

                                                                             {
 
  // Get collection of HS Truth Jets
  SG::ReadHandle<xAOD::JetContainer> truthHSJetsHandle = SG::makeHandle (m_truthJetsKey);
  if (!truthHSJetsHandle.isValid()){
    ATH_MSG_ERROR("Invalid JetContainer datahandle: " << m_truthJetsKey.key());
    return StatusCode::FAILURE;
  }
  const xAOD::JetContainer* truthHSJets = truthHSJetsHandle.cptr();
 
  SG::WriteDecorHandle<xAOD::JetContainer, char> isHSJetHandle (m_decIsHSKey);
  SG::WriteDecorHandle<xAOD::JetContainer, char> isPUJetHandle (m_decIsPUKey);
 
  for (const xAOD::Jet* jet : jets){
      bool isHS = false;
      bool isPU = true;
      for (const xAOD::Jet *truthJet : *truthHSJets) {
          float dr = jet->p4().DeltaR(truthJet->p4());
          if (dr < m_hsMaxDR && truthJet->pt() > m_hsMinPt)
              isHS = true;
          if (dr < m_puMinDR && truthJet->pt() > m_puMinPt)
              isPU = false;
          if (isHS && !isPU)
              break;
      }
      isHSJetHandle(*jet) = isHS;
      isPUJetHandle(*jet) = isPU;
  }
 
  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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ 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 JetPileupLabelingTool::initialize ( void )

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 12 of file JetPileupLabelingTool.cxx.

                                            {
 
  ATH_MSG_INFO("Initializing " << name());
  print();
 
  m_decIsHSKey = m_jetContainerName + "." + m_decIsHSKey.key();
  m_decIsPUKey = m_jetContainerName + "." + m_decIsPUKey.key();
 
  ATH_CHECK(m_truthJetsKey.initialize());
#ifndef XAOD_STANDALONE
  if(m_suppressOutputDeps) {
    // For analysis applications, may not enforce scheduling via data deps
      renounce(m_decIsHSKey);
      renounce(m_decIsPUKey);
  }
#endif
  ATH_CHECK(m_decIsHSKey.initialize());
  ATH_CHECK(m_decIsPUKey.initialize());
 
  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);};

IJetDecorator::decorate

virtual StatusCode decorate(const xAOD::JetContainer &jets) const =0

Decorate a jet collection without otherwise modifying it.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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 JetPileupLabelingTool::print ( ) const

overridevirtual

Print configured parameters.

Reimplemented from asg::AsgTool.

Definition at line 34 of file JetPileupLabelingTool.cxx.

                                        {
 
  ATH_MSG_INFO("Parameters for " << name() << " :");
  ATH_MSG_INFO("HS Truth Jet Container:           " << m_truthJetsKey.key());
  ATH_MSG_INFO("Name of isHS Label Decoration:    " << m_decIsHSKey.key());
  ATH_MSG_INFO("Name of isPU Label Decoration:    " << m_decIsPUKey.key());
}

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_decIsHSKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetPileupLabelingTool::m_decIsHSKey {this, "isHSLabel", "isJvtHS", "SG key for label of HS jets"}

private

Definition at line 52 of file JetPileupLabelingTool.h.

52{this, "isHSLabel", "isJvtHS", "SG key for label of HS jets"};

◆ m_decIsPUKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetPileupLabelingTool::m_decIsPUKey {this, "isPULabel", "isJvtPU", "SG key for label of PU jets"}

private

Definition at line 53 of file JetPileupLabelingTool.h.

53{this, "isPULabel", "isJvtPU", "SG key for label of PU jets"};

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

Gaudi::Property<float> JetPileupLabelingTool::m_hsMaxDR {this, "isHSMaxDR", 0.3, "Tag a reco jet as HS if it is at most this distance from a truth jet"}

private

Definition at line 45 of file JetPileupLabelingTool.h.

45{this, "isHSMaxDR", 0.3, "Tag a reco jet as HS if it is at most this distance from a truth jet"};

◆ m_hsMinPt

Gaudi::Property<float> JetPileupLabelingTool::m_hsMinPt {this, "isHSMinPt", 10e3, "Only consider truth jets above this pT for HS tagging"}

private

Definition at line 46 of file JetPileupLabelingTool.h.

46{this, "isHSMinPt", 10e3, "Only consider truth jets above this pT for HS tagging"};

CheckAppliedSFs.e3

e3

Definition CheckAppliedSFs.py:264

◆ m_jetContainerName

Gaudi::Property<std::string> JetPileupLabelingTool::m_jetContainerName {this, "RecoJetContainer", "AntiKt4EMPFlowJets", "Input reco jet container name"}

private

Definition at line 41 of file JetPileupLabelingTool.h.

41{this, "RecoJetContainer", "AntiKt4EMPFlowJets", "Input reco jet container name"};

◆ m_puMinDR

Gaudi::Property<float> JetPileupLabelingTool::m_puMinDR {this, "isPUMinDR", 0.6, "Tag a reco jet as PU if it is at least this distance from any truth jet"}

private

Definition at line 47 of file JetPileupLabelingTool.h.

47{this, "isPUMinDR", 0.6, "Tag a reco jet as PU if it is at least this distance from any truth jet"};

◆ m_puMinPt

Gaudi::Property<float> JetPileupLabelingTool::m_puMinPt {this, "isPUMinPt", 0, "Only consider truth jets above this pT to veto jets for being PU tagged"}

private

Definition at line 48 of file JetPileupLabelingTool.h.

48{this, "isPUMinPt", 0, "Only consider truth jets above this pT to veto jets for being PU tagged"};

◆ m_suppressOutputDeps

Gaudi::Property<bool> JetPileupLabelingTool::m_suppressOutputDeps {this, "SuppressOutputDependence", false, "Ignore creating the output decoration dependency for data flow; for analysis"}

private

Definition at line 43 of file JetPileupLabelingTool.h.

43{this, "SuppressOutputDependence", false, "Ignore creating the output decoration dependency for data flow; for analysis"};

◆ m_truthJetsKey

SG::ReadHandleKey<xAOD::JetContainer> JetPileupLabelingTool::m_truthJetsKey {this, "TruthJetContainer", "AntiKt4TruthDressedWZJets", "SG key for input Truth HS jets"}

private

Definition at line 50 of file JetPileupLabelingTool.h.

50{this, "TruthJetContainer", "AntiKt4TruthDressedWZJets", "SG key for input Truth HS jets"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ AsgTool() [1/2]

◆ AsgTool() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ decorate()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ modify()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_decIsHSKey

◆ m_decIsPUKey

◆ m_detStore

◆ m_evtStore

◆ m_hsMaxDR

◆ m_hsMinPt

◆ m_jetContainerName

◆ m_puMinDR

◆ m_puMinPt

◆ m_suppressOutputDeps

◆ m_truthJetsKey

◆ m_varHandleArraysDeclared

◆ m_vhka