#include <JetTruthLabelingTool.h>

Inheritance diagram for JetTruthLabelingTool:

Collaboration diagram for JetTruthLabelingTool:

Classes
struct	DecorHandles
	Track internally if the W,Z,Top labels should be done (for large-R). More...

Public Member Functions
	JetTruthLabelingTool (const std::string &name="JetTruthLabelingTool")
	default constructor - to be used in all derived classes
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
StatusCode	decorate (const xAOD::JetContainer &jets) const override
	decorate truth label to a jet collection
void	print () const override
	Print configured parameters.
const std::string &	getLargeRJetTruthLabelName () const
	returns the name of large-R jet truth label
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 Types
enum class	TruthLabelConfiguration { R21Precision_2022v1 , R10TruthLabel_R22v1 , R10WZTruthLabel_R22v1 , R4TruthLabel , R4TruthDressedWZLabel , R4InTimeTruthLabel , Unknown }

Protected Member Functions
StatusCode	labelTruthJets (DecorHandles &dh, const EventContext &ctx) const
	Label truth jet collection.
StatusCode	labelTruthJets (DecorHandles &dh, const xAOD::JetContainer &jets, const EventContext &ctx) const
StatusCode	labelRecoJets (DecorHandles &dh, const xAOD::JetContainer &jets, const EventContext &ctx) const
	Apply labels to all jets in a container.
int	getTruthJetLabelGA (DecorHandles &dh, const xAOD::Jet &jet, const EventContext &ctx) const
	Get truth label using ghost-associated particles.
int	getLabel (DecorHandles &dh, const xAOD::Jet &jet, bool matchH, bool matchW, bool matchZ, bool matchTop, const EventContext &ctx) const
	Get label based on matching and containment criteria.
float	getWZSplit12Cut (float pt) const
	Get W/Z label Split12 cut.
float	getTopSplit23Cut (float pt) const
	Get top label Split23 cut.
int	getNGhostParticles (const xAOD::Jet &jet, const std::string &collection) const
	Get number of ghost associated particles.
TruthLabelConfiguration	parseLabel (const std::string &label)
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
Gaudi::Property< std::string >	m_jetContainerName {this, "RecoJetContainer", "", "Input reco jet container name"}
Gaudi::Property< std::string >	m_truthLabelName {this, "TruthLabelName", "R10TruthLabel_R22v1", "Truth label name"}
Gaudi::Property< bool >	m_isTruthJetCol {this, "IsTruthJetCollection", false, "Flag indicating whether input collection is a truth jet container"}
Gaudi::Property< bool >	m_forceDeltaRMatch {this, "ForceDeltaRMatch", false, "Whether to force dR matching e.g. if GhostTruth is not available"}
SG::ReadHandleKey< xAOD::EventInfo >	m_evtInfoKey {this, "EventInfoKey", "EventInfo", "Name of EventInfo object"}
SG::ReadHandleKey< xAOD::JetContainer >	m_truthJetCollectionKey {this, "TruthJetContainer", "", "Do not configure manually!"}
	parameters for truth labeling
SG::ReadHandleKey< xAOD::JetContainer >	m_truthGroomedJetCollectionKey {this, "TruthGroomedJetContainer", "", "Do not configure manually!"}
bool	m_useGhostJetMatch {}
bool	m_matchUngroomedParent {}
	Use ghost association to match reco to truth jets, dR otherwise.
bool	m_getTruthGroomedJetValues {}
	Use the ungroomed reco jet parent to match to truth jet.
double	m_dRTruthJet {}
	When truth jet matching to ungroomed truth, allow saving properties of groomed truth jets.
double	m_recoGhostFrac {}
	dR to match truth jet to reco jet
double	m_mLowTop {}
	Ghost pT fraction to match truth jet to reco jet.
double	m_mLowW {}
	Lower mass cut for top label.
double	m_mLowZ {}
	Lower mass cut for W label.
bool	m_doLargeRLabels {true}
	Lower mass cut for Z label.
TruthLabelConfiguration	m_truthLabelConfig = TruthLabelConfiguration::Unknown
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_label_truthKey {this, "label_TruthKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_NB_truthKey {this, "NB_TruthKey", "", "Do not configure manually!"}
SG::ReadDecorHandleKey< xAOD::JetContainer >	m_split12_truthKey {this, "Split12_TruthKey", "", "Do not configure manually!"}
SG::ReadDecorHandleKey< xAOD::JetContainer >	m_split23_truthKey {this, "Split23_TruthKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_label_recoKey {this, "label_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_NB_recoKey {this, "NB_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_truthSplit12_recoKey {this, "TruthSplit12_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_truthSplit23_recoKey {this, "TruthSplit23_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthJet_recoKey {this, "MatchedTruthJet_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthJetMass_recoKey {this, "MatchedTruthJetMass_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthJetPt_recoKey {this, "MatchedTruthJetPt_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthJetEta_recoKey { this, "MatchedTruthJetEta_RecoKey", "", "Do not configure manually!" }
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthJetPhi_recoKey { this, "MatchedTruthJetPhi_RecoKey", "", "Do not configure manually!" }
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthJetDR_recoKey { this, "MatchedTruthJetDR_RecoKey", "", "Do not configure manually!" }
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthJetGF_recoKey { this, "MatchedTruthJetGF_RecoKey", "", "Do not configure manually!" }
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthGroomedJetMass_recoKey {this, "MatchedTruthGroomedJetMass_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_matchedTruthGroomedJetPt_recoKey {this, "MatchedTruthGroomedJetPt_RecoKey", "", "Do not configure manually!"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Friends
struct	DecorHandles

Detailed Description

Definition at line 24 of file JetTruthLabelingTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ TruthLabelConfiguration

enum class JetTruthLabelingTool::TruthLabelConfiguration

strongprotected

Enumerator
R21Precision_2022v1
R10TruthLabel_R22v1
R10WZTruthLabel_R22v1
R4TruthLabel
R4TruthDressedWZLabel
R4InTimeTruthLabel
Unknown

Definition at line 128 of file JetTruthLabelingTool.h.

                                     {
      R21Precision_2022v1,
      R10TruthLabel_R22v1,
      R10WZTruthLabel_R22v1,
      R4TruthLabel,
      R4TruthDressedWZLabel,
      R4InTimeTruthLabel,
      Unknown
  };

Constructor & Destructor Documentation

◆ JetTruthLabelingTool()

JetTruthLabelingTool::JetTruthLabelingTool ( const std::string & name = "JetTruthLabelingTool" )

default constructor - to be used in all derived classes

Definition at line 14 of file JetTruthLabelingTool.cxx.

                                                                :
  asg::AsgTool(name)
{}

Member Function Documentation

◆ declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ decorate()

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

overridevirtual

decorate truth label to a jet collection

Apply label to truth jet collections

Copy label to matched reco jets

Implements IJetDecorator.

Definition at line 254 of file JetTruthLabelingTool.cxx.

                                                                            {
  const EventContext& ctx = Gaudi::Hive::currentContext();
  DecorHandles dh (*this, ctx);
  if(m_isTruthJetCol) {
    return labelTruthJets(dh, jets, ctx);
  }
 
  else if (!m_isTruthJetCol && !m_doLargeRLabels) {
      return labelRecoJets(dh, jets, ctx);
  }
  else {
    ATH_CHECK( labelTruthJets(dh, ctx) );
    return labelRecoJets(dh, jets, ctx);
  }
 
  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::Event 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::Event, 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
   }

◆ getLabel()

int JetTruthLabelingTool::getLabel	(	DecorHandles &	dh,
		const xAOD::Jet &	jet,
		bool	matchH,
		bool	matchW,
		bool	matchZ,
		bool	matchTop,
		const EventContext &	ctx ) const

protected

Get label based on matching and containment criteria.

Booleans for containment selections

This method can be expanded to include custom label priorities

If it isn't matched to any heavy particles, is it QCD

Contained H->bb

Contained H->cc

Contained H->tautau

Other from H

Contained top

Contained W from a top

Contained W not from a top

Contained Z->bb

Contained Z->cc

Contained Z->tautau

Contained Z->qq

Uncontained top

Uncontained V

Definition at line 549 of file JetTruthLabelingTool.cxx.

                                                                   {
 
  // store GhostBHadronsFinal count
  int nMatchB = getNGhostParticles( jet, "GhostBHadronsFinal" );
  (*dh.nbHandle)(jet) = nMatchB;
  bool is_bb = false;
  bool is_cc = false;
  bool is_tautauEl = false;
  bool is_tautauMu = false;
  bool is_tautauHad = false;
  bool isTop = false;
  bool isW = false;
  bool isZ = false;
 
  // Use R21Precision_2022v1 definition
  if ( m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1) {
    SG::ReadDecorHandle<xAOD::JetContainer, float> split23Handle(m_split23_truthKey, ctx);
    SG::ReadDecorHandle<xAOD::JetContainer, float> split12Handle(m_split12_truthKey, ctx);
    is_bb = ( nMatchB > 1 );
    isTop = ( matchTop && matchW && nMatchB > 0 && jet.m() / 1000. > m_mLowTop && split23Handle(jet) / 1000. > getTopSplit23Cut( jet.pt() / 1000. ) );
    isW = matchW && nMatchB == 0 && jet.m() / 1000. > m_mLowW && split12Handle(jet) / 1000. > getWZSplit12Cut( jet.pt() / 1000. );
    isZ = matchZ && jet.m() / 1000. > m_mLowZ && split12Handle(jet) / 1000. > getWZSplit12Cut( jet.pt() / 1000. );
  }
 
  // Use R10TruthLabel_R22v1 definition
  if ( m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1) {
    // get extended ghost associated truth label
    int extended_GA_label = -1;
    if (not jet.getAttribute("HadronGhostExtendedTruthLabelID", extended_GA_label)) {
      ATH_MSG_ERROR( "HadronGhostExtendedTruthLabelID not available for " + m_truthJetCollectionKey.key() );
    }
 
    SG::ReadDecorHandle<xAOD::JetContainer, float> split23Handle(m_split23_truthKey, ctx);
    SG::ReadDecorHandle<xAOD::JetContainer, float> split12Handle(m_split12_truthKey, ctx);
    is_bb = ( extended_GA_label == 55 );
    is_cc = ( extended_GA_label == 44 );
    is_tautauEl = ( extended_GA_label == 151511 );
    is_tautauMu = ( extended_GA_label == 151513 );
    is_tautauHad = ( extended_GA_label == 1515 );
    isTop = ( matchTop && matchW && nMatchB > 0 && jet.m() / 1000. > m_mLowTop && split23Handle(jet) / 1000. > getTopSplit23Cut( jet.pt() / 1000. ) );
    isW = matchW && nMatchB == 0 && jet.m() / 1000. > m_mLowW && split12Handle(jet) / 1000. > getWZSplit12Cut( jet.pt() / 1000. );
    isZ = matchZ &&  jet.m() / 1000. > m_mLowZ && split12Handle(jet) / 1000. > getWZSplit12Cut( jet.pt() / 1000. );
  }
 
 
  /* The default priority of labels is:
   * 1) Hbb/cc/tautau
   * 2) Contained top
   * 3) Contained W
   * 4) Contained Zbb/cc/qq/tautau
   * 5) Uncontained top
   * 6) Uncontained V
   */
  if( !(matchTop || matchW || matchZ || matchH) ) {
    return LargeRJetTruthLabel::qcd;
  }
 
  // Higgs
  if ( matchH ) {
    if ( is_bb ) return LargeRJetTruthLabel::Hbb;
    if ( is_cc ) return LargeRJetTruthLabel::Hcc;
    if ( is_tautauEl ) return LargeRJetTruthLabel::HtautauEl;
    if ( is_tautauMu ) return LargeRJetTruthLabel::HtautauMu;
    if ( is_tautauHad ) return LargeRJetTruthLabel::HtautauHad;
    return LargeRJetTruthLabel::other_From_H;
  }
  if ( isTop ) return LargeRJetTruthLabel::tqqb;
 
  if ( isW ) {
    if ( matchTop ) return LargeRJetTruthLabel::Wqq_From_t;
    return LargeRJetTruthLabel::Wqq;
  }
 
  if ( matchZ ) {
    if ( is_bb ) return LargeRJetTruthLabel::Zbb;
    if ( is_cc ) return LargeRJetTruthLabel::Zcc;
    if ( is_tautauEl ) return LargeRJetTruthLabel::ZtautauEl;
    if ( is_tautauMu ) return LargeRJetTruthLabel::ZtautauMu;
    if ( is_tautauHad ) return LargeRJetTruthLabel::ZtautauHad;
  }
  if ( isZ ) {
    return LargeRJetTruthLabel::Zqq;
  }
  if ( matchTop ) return LargeRJetTruthLabel::other_From_t;
  return LargeRJetTruthLabel::other_From_V;
 
}

◆ getLargeRJetTruthLabelName()

const std::string & JetTruthLabelingTool::getLargeRJetTruthLabelName ( ) const

inline

returns the name of large-R jet truth label

Definition at line 43 of file JetTruthLabelingTool.h.

                                                      {
    return m_truthLabelName;
  };

◆ 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::Event 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::Event, 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
   }

◆ getNGhostParticles()

int JetTruthLabelingTool::getNGhostParticles	(	const xAOD::Jet &	jet,
		const std::string &	collection ) const

protected

Get number of ghost associated particles.

Definition at line 533 of file JetTruthLabelingTool.cxx.

                                                                                                     {
 
  int nMatchPart = 0;
 
  if( !jet.getAttribute<int>( collection+"Count", nMatchPart ) ){
 
    std::vector<const xAOD::TruthParticle*> ghostParts;
    if( !jet.getAssociatedObjects<xAOD::TruthParticle>( collection, ghostParts ) ){      
      ATH_MSG_ERROR( collection + " cannot be retrieved! Truth label definition might be wrong" );
    } 
    nMatchPart = ghostParts.size();
  }
 
  return nMatchPart;
}

◆ getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

◆ getTopSplit23Cut()

float JetTruthLabelingTool::getTopSplit23Cut ( float pt ) const

protected

Get top label Split23 cut.

The functional form and parameters come from optimization studies: https://indico.cern.ch/event/931498/contributions/3921872/attachments/2064188/3463746/JSS_25June.pdf

Definition at line 512 of file JetTruthLabelingTool.cxx.

                                                             {
 
  float split23 = -999.0;
 
  if ( m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 ||
       m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 ||
       m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1) {
 
    const float c0 = 3.3;
    const float c1 = -6.98e-4;
 
    split23 = std::exp( c0 + c1 * pt );
 
  }
 
  return split23;
}

◆ getTruthJetLabelGA()

int JetTruthLabelingTool::getTruthJetLabelGA	(	DecorHandles &	dh,
		const xAOD::Jet &	jet,
		const EventContext &	ctx ) const

protected

Get truth label using ghost-associated particles.

Booleans to check ghost-associated heavy particles

Find ghost associated W bosons

Find ghost associated Z bosons

Find ghost associated H bosons

Find ghost associated top quarks

Definition at line 212 of file JetTruthLabelingTool.cxx.

{
  bool matchW = false;
  bool matchZ = false;
  bool matchH = false;
  bool matchTop = false;
  int nMatchW = getNGhostParticles( jet, "GhostWBosons" );
 
  if ( nMatchW ) {
    matchW = true;
  }
  int nMatchZ = getNGhostParticles( jet, "GhostZBosons" );
  
  if ( nMatchZ ) {
    matchZ = true;
  }
  int nMatchH = getNGhostParticles( jet, "GhostHBosons" );
  
  if ( nMatchH ) {
    matchH = true;
  }
  int nMatchTop = getNGhostParticles( jet, "GhostTQuarksFinal" );
 
  if ( nMatchTop ) {
    matchTop = true;
  }
 
  return getLabel( dh, jet, matchH, matchW, matchZ, matchTop, ctx );
 
}

◆ getWZSplit12Cut()

float JetTruthLabelingTool::getWZSplit12Cut ( float pt ) const

protected

Get W/Z label Split12 cut.

The functional form and parameters come from optimization studies: https://cds.cern.ch/record/2777009/files/ATL-PHYS-PUB-2021-029.pdf

Definition at line 494 of file JetTruthLabelingTool.cxx.

                                                            {
 
  float split12 = -999.0;
 
  if ( m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1) {
    const float c0 = 55.25;
    const float c1 = -2.34e-3;
 
    split12 = c0 * std::exp( c1 * pt );
  }
 
  return split12;
 
}

◆ initialize()

StatusCode JetTruthLabelingTool::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...

Check if TruthLabelName is supported. If not, give an error and return FAILURE

Ghost Association values

Hard-code some values for R10TruthLabel_R21Precision_2022v1 and R10TruthLabel_R22v1

Hard-code some values for R10WZTruthLabel_R22v1

Hard code for small-R jets

Reimplemented from asg::AsgTool.

Definition at line 43 of file JetTruthLabelingTool.cxx.

                                           {
 
  ATH_MSG_INFO("Initializing " << name());
 
  m_truthLabelConfig = parseLabel(m_truthLabelName);
  if(m_truthLabelConfig == TruthLabelConfiguration::Unknown) {
    ATH_MSG_ERROR("TruthLabelName " << m_truthLabelName << " is not supported. Exiting...");
    return StatusCode::FAILURE;
  }
  m_useGhostJetMatch = false;
  m_recoGhostFrac = 0.75;
 
  switch(m_truthLabelConfig) {
  case TruthLabelConfiguration::R21Precision_2022v1:
  case TruthLabelConfiguration::R10TruthLabel_R22v1:
    m_truthJetCollectionKey="AntiKt10TruthJets";
    m_matchUngroomedParent = true;
    m_dRTruthJet = 0.75;
    if ( m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1) {
      m_getTruthGroomedJetValues = true;
      m_truthGroomedJetCollectionKey="AntiKt10TruthSoftDropBeta100Zcut10Jets";
    } else {
      m_getTruthGroomedJetValues = false;
    }
    break;
  case TruthLabelConfiguration::R10WZTruthLabel_R22v1:
    m_truthJetCollectionKey="AntiKt10TruthDressedWZJets";
    m_matchUngroomedParent = true;
    m_dRTruthJet = 0.75;
    m_mLowTop = 140.0;
    m_mLowW = 50.0;
    m_mLowZ = 50.0;
    m_getTruthGroomedJetValues = true;
    m_truthGroomedJetCollectionKey="AntiKt10TruthDressedWZSoftDropBeta100Zcut10Jets";
    break;
  case TruthLabelConfiguration::R4TruthLabel:
  case TruthLabelConfiguration::R4TruthDressedWZLabel:
  case TruthLabelConfiguration::R4InTimeTruthLabel:
    switch (m_truthLabelConfig) {
    case TruthLabelConfiguration::R4TruthLabel:
      m_truthJetCollectionKey = "AntiKt4TruthJets";
      break;
    case TruthLabelConfiguration::R4TruthDressedWZLabel:
      m_truthJetCollectionKey = "AntiKt4TruthDressedWZJets";
      break;
    case TruthLabelConfiguration::R4InTimeTruthLabel:
      m_truthJetCollectionKey = "InTimeAntiKt4TruthJets";
      break;
    default: // Cannot hit anything else
      break;
    }
    m_matchUngroomedParent = false;
    m_dRTruthJet = 0.3;
    m_getTruthGroomedJetValues = false;
    m_useGhostJetMatch = true;
    m_doLargeRLabels = false;
    break;
  default:
    ATH_MSG_ERROR(" Unhandled TruthLabelName " << m_truthLabelName << "! Exiting...");
    return StatusCode::FAILURE;
  }
 
  if(m_forceDeltaRMatch) {
    m_useGhostJetMatch = false;
  }
 
  print();
 
  m_label_truthKey   = m_truthJetCollectionKey.key() + "." + m_truthLabelName;
  m_NB_truthKey      = m_truthJetCollectionKey.key() + "." + m_truthLabelName + "_NB";
  m_split12_truthKey = m_truthJetCollectionKey.key() + ".Split12";
  m_split23_truthKey = m_truthJetCollectionKey.key() + ".Split23";
 
  if(!m_isTruthJetCol){
    m_label_recoKey  = m_jetContainerName + "." + m_truthLabelName;
    m_NB_recoKey     = m_jetContainerName + "." + m_truthLabelName + "_NB";
    m_truthSplit12_recoKey = m_jetContainerName + "." + m_truthLabelName + "_TruthJetSplit12";
    m_truthSplit23_recoKey = m_jetContainerName + "." + m_truthLabelName + "_TruthJetSplit23";
 
    m_matchedTruthJet_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthJet";
    m_matchedTruthJetMass_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthJetMass";
    m_matchedTruthJetPt_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthJetPt";
    m_matchedTruthJetEta_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthJetEta";
    m_matchedTruthJetPhi_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthJetPhi";
    m_matchedTruthJetDR_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthJetDR";
    m_matchedTruthJetGF_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthJetGF";
 
    m_matchedTruthGroomedJetMass_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthGroomedJetMass";
    m_matchedTruthGroomedJetPt_recoKey = m_jetContainerName + "." + m_truthLabelName + "_MatchedTruthGroomedJetPt";
  }
 
  ATH_CHECK(m_evtInfoKey.initialize());
  ATH_CHECK(m_truthJetCollectionKey.initialize());
  ATH_CHECK(m_truthGroomedJetCollectionKey.initialize(m_getTruthGroomedJetValues));
 
  ATH_CHECK(m_label_truthKey.initialize());
  ATH_CHECK(m_NB_truthKey.initialize());
  
  ATH_CHECK(m_split12_truthKey.initialize(m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1));
  ATH_CHECK(m_split23_truthKey.initialize(m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1));
 
  ATH_CHECK(m_label_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_NB_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_truthSplit12_recoKey.initialize(!m_isTruthJetCol && (m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1) ));
  ATH_CHECK(m_truthSplit23_recoKey.initialize(!m_isTruthJetCol && (m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1)));
  
  ATH_CHECK(m_matchedTruthJet_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_matchedTruthJetMass_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_matchedTruthJetPt_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_matchedTruthJetEta_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_matchedTruthJetPhi_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_matchedTruthJetDR_recoKey.initialize(!m_isTruthJetCol));
  ATH_CHECK(m_matchedTruthJetGF_recoKey.initialize(!m_isTruthJetCol));
 
  ATH_CHECK(m_matchedTruthGroomedJetMass_recoKey.initialize((!m_isTruthJetCol) && (m_getTruthGroomedJetValues)));
  ATH_CHECK(m_matchedTruthGroomedJetPt_recoKey.initialize((!m_isTruthJetCol) && (m_getTruthGroomedJetValues)));
 
  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.

◆ labelRecoJets()

StatusCode JetTruthLabelingTool::labelRecoJets	(	DecorHandles &	dh,
		const xAOD::JetContainer &	jets,
		const EventContext &	ctx ) const

protected

Apply labels to all jets in a container.

Get parent ungroomed reco jet for matching

Find matched truth jet

If parent jet has been retrieved, calculate dR w.r.t. it instead

If m_dRTruthJet < 0, the closest truth jet is used as matched jet. Otherwise, only match if dR < m_dRTruthJet

Decorate truth label

Decorate additional information used for truth labeling

Definition at line 276 of file JetTruthLabelingTool.cxx.

                                                                              {
    
  SG::ReadHandle<xAOD::JetContainer> truthJets(m_truthJetCollectionKey, ctx);
  SG::ReadHandle<xAOD::JetContainer> truthGroomedJets;
  if ( m_getTruthGroomedJetValues ) {
    truthGroomedJets = SG::makeHandle(m_truthGroomedJetCollectionKey, ctx);
  }
  const SG::AuxElement::Accessor<int> nbAcc (m_truthLabelName + "_NB");
  static const SG::ConstAccessor< ElementLink< xAOD::JetContainer > > ParentAcc ("Parent");
  for(const xAOD::Jet *jet : jets) {
    const xAOD::Jet* parent = nullptr;
    if ( m_matchUngroomedParent ){
      ElementLink<xAOD::JetContainer> element_link = ParentAcc (*jet);
      if ( element_link.isValid() ) {
        parent = *element_link;
      }
      else {
        ATH_MSG_ERROR("Unable to get a link to the parent jet! Returning a NULL pointer."); 
        return StatusCode::FAILURE;
      }
    }
    float dRmin = 9999;
    float ghostFracNominal = 9999;
    const xAOD::Jet* matchTruthJet = nullptr;
    float dRminGroomed = 9999;
    const xAOD::Jet* matchTruthGroomedJet = nullptr;
 
    // Ensure that the reco jet has at least one constituent
    // (and thus a well-defined four-vector)
    if(jet->numConstituents() > 0){
      for ( const xAOD::Jet* truthJet : *truthJets ) {
          // Calculate DR and GF values. Both are used regardless of the matching option.
          // DR
          float dR = jet->p4().DeltaR(truthJet->p4());
          if (parent) dR = parent->p4().DeltaR(truthJet->p4());
          if (m_useGhostJetMatch) {
              // GF
              static const SG::ConstAccessor<float> accGhostTruthPt("GhostTruthPt");
              float ghostTruthPt = accGhostTruthPt(*jet);
              float ghostPtFraction = (ghostTruthPt / (truthJet->pt()));
              // GA matching. Upper bound applied for completeness, but realistically not needed.
              if ((ghostPtFraction >= m_recoGhostFrac) && (ghostPtFraction <= (2 - m_recoGhostFrac))) {
                  if (std::abs(1 - ghostPtFraction) < std::abs(1 - ghostFracNominal)) {
                      matchTruthJet = truthJet;
                      ghostFracNominal = ghostPtFraction;
                  }
              }
          }
          else {
              // If m_dRTruthJet < 0, the closest truth jet is used as matched jet. Otherwise, only match if dR < m_dRTruthJet
              if (m_dRTruthJet < 0 || dR < m_dRTruthJet ) {
                  if (dR < dRmin) {
                      dRmin = dR;
                      matchTruthJet = truthJet;
                  }
              }
          }
 
      }
    }
 
 
    int label = LargeRJetTruthLabel::enumToInt( LargeRJetTruthLabel::notruth );
    int truthJetNB = -1;
    float truthJetSplit12 = -9999;
    float truthJetSplit23 = -9999;
 
    // Defaults to null EL
    ElementLink<xAOD::JetContainer> truthJetEL{};
    float truthJetMass = -9999;
    float truthJetPt = -9999;
    float truthJetEta = -9999;
    float truthJetPhi = -9999;
    float deltaR = -2;
    float ghostFrac = -2;
 
    if ( matchTruthJet ) {
        // Can't use the WriteDecorHandle to read --- the decoration may have
        // been added and locked by a previous algorithm.
        // Not saving Truth jet decorations for small R
        if (m_doLargeRLabels) {
            SG::ConstAccessor<int> labelAcc(dh.labelHandle->auxid());
            label = labelAcc(*matchTruthJet);
            if (m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1) {
                SG::ReadDecorHandle<xAOD::JetContainer, float> split23Handle(m_split23_truthKey, ctx);
                if (split23Handle.isAvailable()) truthJetSplit23 = split23Handle(*matchTruthJet);
                SG::ReadDecorHandle<xAOD::JetContainer, float> split12Handle(m_split12_truthKey, ctx);
                if (split12Handle.isAvailable()) truthJetSplit12 = split12Handle(*matchTruthJet);
            }
            if (nbAcc.isAvailable(*matchTruthJet)) truthJetNB = nbAcc(*matchTruthJet);
        }
        truthJetEL = ElementLink<xAOD::JetContainer>(*truthJets,matchTruthJet->index(),ctx);
        truthJetMass = matchTruthJet->m();
        truthJetPt = matchTruthJet->pt();
        truthJetEta = matchTruthJet->eta();
        truthJetPhi = matchTruthJet->phi();
        ghostFrac = ghostFracNominal;
        deltaR = dRmin;
    }
 
    // Save Groomed Truth Jet variables
    float truthGroomedJetMass = -9999;
    float truthGroomedJetPt = -9999;
    if ( m_getTruthGroomedJetValues ) {
      if ( matchTruthJet ) {
        for ( const xAOD::Jet* truthGroomedJet : *truthGroomedJets ) {
          ElementLink<xAOD::JetContainer> element_link = ParentAcc (*truthGroomedJet);
          if ( !element_link.isValid() ) { continue; }
          if ( matchTruthJet == *element_link ) {
            matchTruthGroomedJet = truthGroomedJet;
            break;
          }
        }
      }
      // If no matched jet found or matched jet has no corresponding groomed jet, use dR matching
      if ( !matchTruthGroomedJet && parent != nullptr) {
        for ( const xAOD::Jet* truthGroomedJet : *truthGroomedJets ) {
            float dR = parent->p4().DeltaR(truthGroomedJet->p4());
            if ( m_dRTruthJet < 0 || dR < m_dRTruthJet ) {
              if ( dR < dRminGroomed ) {
                dRminGroomed = dR;
                matchTruthGroomedJet = truthGroomedJet;
              }
            }
        }
      }
      if ( matchTruthGroomedJet ) {
        truthGroomedJetMass = matchTruthGroomedJet->m();
        truthGroomedJetPt = matchTruthGroomedJet->pt();
      }
    }
    if (m_doLargeRLabels) {
        (*dh.labelRecoHandle)(*jet) = label;
        if (m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1) {
            (*dh.split23Handle)(*jet) = truthJetSplit23;
            (*dh.split12Handle)(*jet) = truthJetSplit12;
        }
 
        (*dh.nbRecoHandle)(*jet) = truthJetNB;
    }
    
    (*dh.matchedTruthJetHandle)(*jet) = truthJetEL;
    (*dh.matchedTruthJetMassHandle)(*jet) = truthJetMass;
    (*dh.matchedTruthJetPtHandle)(*jet) = truthJetPt;
    (*dh.matchedTruthJetEtaHandle)(*jet) = truthJetEta;
    (*dh.matchedTruthJetPhiHandle)(*jet) = truthJetPhi;
    (*dh.matchedTruthJetDRHandle)(*jet) = deltaR;
    (*dh.matchedTruthJetGFHandle)(*jet) = ghostFrac;
 
    if ( m_getTruthGroomedJetValues ) {
      (*dh.matchedTruthGroomedMassHandle)(*jet) = truthGroomedJetMass;
      (*dh.matchedTruthGroomedPtHandle)(*jet) = truthGroomedJetPt;
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ labelTruthJets() [1/2]

StatusCode JetTruthLabelingTool::labelTruthJets	(	DecorHandles &	dh,
		const EventContext &	ctx ) const

protected

Label truth jet collection.

Retrieve appropriate truth jet container

Make sure the truth jet collection has been retrieved

Definition at line 444 of file JetTruthLabelingTool.cxx.

                                                                               {
  SG::ReadHandle<xAOD::JetContainer> truthJets(m_truthJetCollectionKey, ctx);
  if ( !truthJets.isValid() ) {
    ATH_MSG_ERROR("No truth jet container retrieved. Please make sure you are using a supported TruthLabelName.");
    return StatusCode::FAILURE;
  }
 
  return labelTruthJets(dh, *truthJets, ctx);
 
}

◆ labelTruthJets() [2/2]

StatusCode JetTruthLabelingTool::labelTruthJets	(	DecorHandles &	dh,
		const xAOD::JetContainer &	jets,
		const EventContext &	ctx ) const

protected

Make sure there is at least 1 jet in truth collection

Check if the truth jet collection already has labels applied

Get the EventInfo to identify Sherpa samples

Apply label to truth jet

Definition at line 460 of file JetTruthLabelingTool.cxx.

{
  if ( !(truthJets.size()) ) return StatusCode::SUCCESS;
  if(dh.labelHandle->isAvailable()){
    // Beware: if we get here, the configuration is probably not MT-compatible.
    ATH_MSG_DEBUG("labelTruthJets: Truth jet collection already labelled with " << m_truthLabelName);
    return StatusCode::SUCCESS;
  }
  SG::ReadHandle<xAOD::EventInfo> eventInfo(m_evtInfoKey, ctx);
  if(!eventInfo.isValid()){
    ATH_MSG_ERROR("Failed to retrieve event information.");
    return StatusCode::FAILURE;
  }
 
  if(m_doLargeRLabels) {
    int label = LargeRJetTruthLabel::enumToInt(LargeRJetTruthLabel::notruth);
    for ( const xAOD::Jet *jet : truthJets ) {
      ATH_MSG_DEBUG("Getting truth label using ghost-association");
      label = getTruthJetLabelGA(dh, *jet, ctx);
      (*dh.labelHandle)(*jet) = label;
    }
  }
 
  return StatusCode::SUCCESS;
}

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

◆ parseLabel()

JetTruthLabelingTool::TruthLabelConfiguration JetTruthLabelingTool::parseLabel ( const std::string & label )

protected

Definition at line 19 of file JetTruthLabelingTool.cxx.

                                                      {
 
    if (name == "R10TruthLabel_R21Precision_2022v1")
        return TruthLabelConfiguration::R21Precision_2022v1;
 
    if (name == "R10TruthLabel_R22v1")
        return TruthLabelConfiguration::R10TruthLabel_R22v1;
 
    if (name == "R10WZTruthLabel_R22v1")
        return TruthLabelConfiguration::R10WZTruthLabel_R22v1;
 
    if (name == "R4TruthLabel")
        return TruthLabelConfiguration::R4TruthLabel;
 
    if (name == "R4TruthDressedWZLabel")
        return TruthLabelConfiguration::R4TruthDressedWZLabel;
 
    if (name == "R4InTimeTruthLabel")
        return TruthLabelConfiguration::R4InTimeTruthLabel;
 
    return TruthLabelConfiguration::Unknown;
}

◆ print()

void JetTruthLabelingTool::print ( ) const

overridevirtual

Print configured parameters.

Reimplemented from asg::AsgTool.

Definition at line 171 of file JetTruthLabelingTool.cxx.

                                       {
  ATH_MSG_INFO("Parameters for " << name());
 
  ATH_MSG_INFO("xAOD information:");
  ATH_MSG_INFO("TruthLabelName:               " << m_truthLabelName);
  ATH_MSG_INFO("TruthJetCollectionName:         " << m_truthJetCollectionKey.key());
  ATH_MSG_INFO("dRTruthJet:    " << std::to_string(m_dRTruthJet));
 
  if(m_getTruthGroomedJetValues) {
    ATH_MSG_INFO("truthGroomedJetCollectionName: " << m_truthGroomedJetCollectionKey.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);
      }
    }
  }

◆ DecorHandles

friend struct DecorHandles

friend

Definition at line 95 of file JetTruthLabelingTool.h.

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_doLargeRLabels

bool JetTruthLabelingTool::m_doLargeRLabels {true}

protected

Lower mass cut for Z label.

Definition at line 68 of file JetTruthLabelingTool.h.

68{true};

◆ m_dRTruthJet

double JetTruthLabelingTool::m_dRTruthJet {}

protected

When truth jet matching to ungroomed truth, allow saving properties of groomed truth jets.

Definition at line 63 of file JetTruthLabelingTool.h.

63{};

◆ m_evtInfoKey

SG::ReadHandleKey<xAOD::EventInfo> JetTruthLabelingTool::m_evtInfoKey {this, "EventInfoKey", "EventInfo", "Name of EventInfo object"}

protected

Definition at line 55 of file JetTruthLabelingTool.h.

55{this, "EventInfoKey", "EventInfo", "Name of EventInfo object"};

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

Gaudi::Property<bool> JetTruthLabelingTool::m_forceDeltaRMatch {this, "ForceDeltaRMatch", false, "Whether to force dR matching e.g. if GhostTruth is not available"}

protected

Definition at line 53 of file JetTruthLabelingTool.h.

53{this, "ForceDeltaRMatch", false, "Whether to force dR matching e.g. if GhostTruth is not available"};

◆ m_getTruthGroomedJetValues

bool JetTruthLabelingTool::m_getTruthGroomedJetValues {}

protected

Use the ungroomed reco jet parent to match to truth jet.

Definition at line 62 of file JetTruthLabelingTool.h.

62{};

◆ m_isTruthJetCol

Gaudi::Property<bool> JetTruthLabelingTool::m_isTruthJetCol {this, "IsTruthJetCollection", false, "Flag indicating whether input collection is a truth jet container"}

protected

Definition at line 52 of file JetTruthLabelingTool.h.

52{this, "IsTruthJetCollection", false, "Flag indicating whether input collection is a truth jet container"};

◆ m_jetContainerName

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

protected

Definition at line 49 of file JetTruthLabelingTool.h.

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

◆ m_label_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_label_recoKey {this, "label_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 146 of file JetTruthLabelingTool.h.

146{this, "label_RecoKey", "", "Do not configure manually!"};

◆ m_label_truthKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_label_truthKey {this, "label_TruthKey", "", "Do not configure manually!"}

protected

Definition at line 141 of file JetTruthLabelingTool.h.

141{this, "label_TruthKey", "", "Do not configure manually!"};

◆ m_matchedTruthGroomedJetMass_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthGroomedJetMass_recoKey {this, "MatchedTruthGroomedJetMass_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 159 of file JetTruthLabelingTool.h.

159{this, "MatchedTruthGroomedJetMass_RecoKey", "", "Do not configure manually!"};

◆ m_matchedTruthGroomedJetPt_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthGroomedJetPt_recoKey {this, "MatchedTruthGroomedJetPt_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 160 of file JetTruthLabelingTool.h.

160{this, "MatchedTruthGroomedJetPt_RecoKey", "", "Do not configure manually!"};

◆ m_matchedTruthJet_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthJet_recoKey {this, "MatchedTruthJet_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 151 of file JetTruthLabelingTool.h.

151{this, "MatchedTruthJet_RecoKey", "", "Do not configure manually!"};

◆ m_matchedTruthJetDR_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthJetDR_recoKey { this, "MatchedTruthJetDR_RecoKey", "", "Do not configure manually!" }

protected

Definition at line 156 of file JetTruthLabelingTool.h.

156{ this, "MatchedTruthJetDR_RecoKey", "", "Do not configure manually!" };

◆ m_matchedTruthJetEta_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthJetEta_recoKey { this, "MatchedTruthJetEta_RecoKey", "", "Do not configure manually!" }

protected

Definition at line 154 of file JetTruthLabelingTool.h.

154{ this, "MatchedTruthJetEta_RecoKey", "", "Do not configure manually!" };

◆ m_matchedTruthJetGF_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthJetGF_recoKey { this, "MatchedTruthJetGF_RecoKey", "", "Do not configure manually!" }

protected

Definition at line 157 of file JetTruthLabelingTool.h.

157{ this, "MatchedTruthJetGF_RecoKey", "", "Do not configure manually!" };

◆ m_matchedTruthJetMass_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthJetMass_recoKey {this, "MatchedTruthJetMass_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 152 of file JetTruthLabelingTool.h.

152{this, "MatchedTruthJetMass_RecoKey", "", "Do not configure manually!"};

◆ m_matchedTruthJetPhi_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthJetPhi_recoKey { this, "MatchedTruthJetPhi_RecoKey", "", "Do not configure manually!" }

protected

Definition at line 155 of file JetTruthLabelingTool.h.

155{ this, "MatchedTruthJetPhi_RecoKey", "", "Do not configure manually!" };

◆ m_matchedTruthJetPt_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_matchedTruthJetPt_recoKey {this, "MatchedTruthJetPt_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 153 of file JetTruthLabelingTool.h.

153{this, "MatchedTruthJetPt_RecoKey", "", "Do not configure manually!"};

◆ m_matchUngroomedParent

bool JetTruthLabelingTool::m_matchUngroomedParent {}

protected

Use ghost association to match reco to truth jets, dR otherwise.

Definition at line 61 of file JetTruthLabelingTool.h.

61{};

◆ m_mLowTop

double JetTruthLabelingTool::m_mLowTop {}

protected

Ghost pT fraction to match truth jet to reco jet.

Definition at line 65 of file JetTruthLabelingTool.h.

65{};

◆ m_mLowW

double JetTruthLabelingTool::m_mLowW {}

protected

Lower mass cut for top label.

Definition at line 66 of file JetTruthLabelingTool.h.

66{};

◆ m_mLowZ

double JetTruthLabelingTool::m_mLowZ {}

protected

Lower mass cut for W label.

Definition at line 67 of file JetTruthLabelingTool.h.

67{};

◆ m_NB_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_NB_recoKey {this, "NB_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 147 of file JetTruthLabelingTool.h.

147{this, "NB_RecoKey", "", "Do not configure manually!"};

◆ m_NB_truthKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_NB_truthKey {this, "NB_TruthKey", "", "Do not configure manually!"}

protected

Definition at line 142 of file JetTruthLabelingTool.h.

142{this, "NB_TruthKey", "", "Do not configure manually!"};

◆ m_recoGhostFrac

double JetTruthLabelingTool::m_recoGhostFrac {}

protected

dR to match truth jet to reco jet

Definition at line 64 of file JetTruthLabelingTool.h.

64{};

◆ m_split12_truthKey

SG::ReadDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_split12_truthKey {this, "Split12_TruthKey", "", "Do not configure manually!"}

protected

Definition at line 143 of file JetTruthLabelingTool.h.

143{this, "Split12_TruthKey", "", "Do not configure manually!"};

◆ m_split23_truthKey

SG::ReadDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_split23_truthKey {this, "Split23_TruthKey", "", "Do not configure manually!"}

protected

Definition at line 144 of file JetTruthLabelingTool.h.

144{this, "Split23_TruthKey", "", "Do not configure manually!"};

◆ m_truthGroomedJetCollectionKey

SG::ReadHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_truthGroomedJetCollectionKey {this, "TruthGroomedJetContainer", "", "Do not configure manually!"}

protected

Definition at line 59 of file JetTruthLabelingTool.h.

59{this, "TruthGroomedJetContainer", "", "Do not configure manually!"};

◆ m_truthJetCollectionKey

SG::ReadHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_truthJetCollectionKey {this, "TruthJetContainer", "", "Do not configure manually!"}

protected

parameters for truth labeling

Definition at line 58 of file JetTruthLabelingTool.h.

58{this, "TruthJetContainer", "", "Do not configure manually!"};

◆ m_truthLabelConfig

TruthLabelConfiguration JetTruthLabelingTool::m_truthLabelConfig = TruthLabelConfiguration::Unknown

protected

Definition at line 139 of file JetTruthLabelingTool.h.

◆ m_truthLabelName

Gaudi::Property<std::string> JetTruthLabelingTool::m_truthLabelName {this, "TruthLabelName", "R10TruthLabel_R22v1", "Truth label name"}

protected

Definition at line 50 of file JetTruthLabelingTool.h.

50{this, "TruthLabelName", "R10TruthLabel_R22v1", "Truth label name"};

◆ m_truthSplit12_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_truthSplit12_recoKey {this, "TruthSplit12_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 148 of file JetTruthLabelingTool.h.

148{this, "TruthSplit12_RecoKey", "", "Do not configure manually!"};

◆ m_truthSplit23_recoKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetTruthLabelingTool::m_truthSplit23_recoKey {this, "TruthSplit23_RecoKey", "", "Do not configure manually!"}

protected

Definition at line 149 of file JetTruthLabelingTool.h.

149{this, "TruthSplit23_RecoKey", "", "Do not configure manually!"};

◆ m_useGhostJetMatch

bool JetTruthLabelingTool::m_useGhostJetMatch {}

protected

Definition at line 60 of file JetTruthLabelingTool.h.

60{};

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ TruthLabelConfiguration

Constructor & Destructor Documentation

◆ JetTruthLabelingTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ decorate()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getLabel()

◆ getLargeRJetTruthLabelName()

◆ getName()

◆ getNGhostParticles()

◆ getProperty()

◆ getTopSplit23Cut()

◆ getTruthJetLabelGA()

◆ getWZSplit12Cut()

◆ initialize()

◆ inputHandles()

◆ labelRecoJets()

◆ labelTruthJets() [1/2]

◆ labelTruthJets() [2/2]

◆ modify()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ parseLabel()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Friends And Related Symbol Documentation

◆ DecorHandles

Member Data Documentation

◆ m_detStore

◆ m_doLargeRLabels

◆ m_dRTruthJet

◆ m_evtInfoKey

◆ m_evtStore

◆ m_forceDeltaRMatch

◆ m_getTruthGroomedJetValues

◆ m_isTruthJetCol

◆ m_jetContainerName

◆ m_label_recoKey

◆ m_label_truthKey

◆ m_matchedTruthGroomedJetMass_recoKey

◆ m_matchedTruthGroomedJetPt_recoKey

◆ m_matchedTruthJet_recoKey

◆ m_matchedTruthJetDR_recoKey

◆ m_matchedTruthJetEta_recoKey

◆ m_matchedTruthJetGF_recoKey

◆ m_matchedTruthJetMass_recoKey

◆ m_matchedTruthJetPhi_recoKey

◆ m_matchedTruthJetPt_recoKey

◆ m_matchUngroomedParent

◆ m_mLowTop

◆ m_mLowW

◆ m_mLowZ

◆ m_NB_recoKey

◆ m_NB_truthKey

◆ m_recoGhostFrac

◆ m_split12_truthKey