JetTruthLabelingTool Class Reference

#include <JetTruthLabelingTool.h>

Inheritance diagram for JetTruthLabelingTool:

Collaboration diagram for JetTruthLabelingTool:

Classes
struct	DecorHandles
	Upper mass cut for Z label. 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 {   R21Consolidated , R21Precision , R21Precision_2022v1 , R10TruthLabel_R22v1 ,   R10WZTruthLabel_R22v1 , R4TruthLabel , 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	getTruthJetLabelDR (DecorHandles &dh, const xAOD::Jet &jet, const std::vector< std::pair< TLorentzVector, int > > &tlv_truthParts, const EventContext &ctx) const
	Get truth label using dR-matched particles.
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, std::string collection) const
	Get number of ghost associated particles.
bool	getIsSherpa (const int DSID) const
	Check for Sherpa DSIDs.
void	getTLVs (std::vector< std::pair< TLorentzVector, int > > &tlvs, const xAOD::TruthParticleContainer *truthBosons, const xAOD::TruthParticleContainer *truthTop, bool isSherpa=false) const
	Extract heavy particle 4-vectors from truth record.
bool	selectTruthParticle (const xAOD::TruthParticle *tp, int pdgId) const
	Check if truth particle has correct DSID and isn't self decay.
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_R21Consolidated", "Truth label name"}
Gaudi::Property< bool >	m_isTruthJetCol {this, "IsTruthJetCollection", false, "Flag indicating whether input collection is a truth jet container"}
SG::ReadHandleKey< xAOD::EventInfo >	m_evtInfoKey {this, "EventInfoKey", "EventInfo", "Name of EventInfo object"}
Gaudi::Property< bool >	m_useTRUTH3 {this, "UseTRUTH3", false, "True for TRUTH3 format, false for TRUTH1"}
	TRUTH1 or TRUTH3.
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthParticleContainerName {this, "TruthParticleContainerName", "TruthParticles", "Truth particle container name"}
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthBosonContainerName {this, "TruthBosonContainerName", "TruthBosonsWithDecayParticles", "Truth boson container name"}
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthTopQuarkContainerName {this, "TruthTopQuarkContainerName", "TruthTopQuarkWithDecayParticles", "Truth top container name"}
SG::ReadHandleKey< xAOD::JetContainer >	m_truthJetCollectionName {this, "TruthJetContainer", "", "Do not configure manually!"}
	parameters for truth labeling
SG::ReadHandleKey< xAOD::JetContainer >	m_truthGroomedJetCollectionName {this, "TruthGroomedJetContainer", "", "Do not configure manually!"}
bool	m_useDRMatch {}
bool	m_useWZMassHigh {}
	Use dR to match partons to truth jet.
bool	m_useGhostJetMatch {}
	Use upper mass cut for W/Z labels.
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_dRTruthPart {}
	Ghost pT fraction to match truth jet to reco jet.
double	m_mLowTop {}
	dR to match truth particles to truth jet
double	m_mLowW {}
	Lower mass cut for top label.
double	m_mHighW {}
	Lower mass cut for W label.
double	m_mLowZ {}
	Upper mass cut for W label.
double	m_mHighZ {}
	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_dR_W_truthKey {this, "dR_W_TruthKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_dR_Z_truthKey {this, "dR_Z_TruthKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_dR_H_truthKey {this, "dR_H_TruthKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_dR_Top_truthKey {this, "dR_Top_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_dR_W_recoKey {this, "dR_W_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_dR_Z_recoKey {this, "dR_Z_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_dR_H_recoKey {this, "dR_H_RecoKey", "", "Do not configure manually!"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_dR_Top_recoKey {this, "dR_Top_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_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 23 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
R21Consolidated
R21Precision
R21Precision_2022v1
R10TruthLabel_R22v1
R10WZTruthLabel_R22v1
R4TruthLabel
Unknown

Definition at line 164 of file JetTruthLabelingTool.h.

                                     {
      R21Consolidated,
      R21Precision,
      R21Precision_2022v1,
      R10TruthLabel_R22v1,
      R10WZTruthLabel_R22v1,
      R4TruthLabel,
      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 384 of file JetTruthLabelingTool.cxx.

                                                                            {
  const EventContext& ctx = Gaudi::Hive::currentContext();
  DecorHandles dh (*this, ctx);

  if(m_isTruthJetCol) {
    return labelTruthJets(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.

{ return m_detStore; }

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.

{ 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

getIsSherpa()

bool JetTruthLabelingTool::getIsSherpa ( const int DSID ) const

inlineprotected

Check for Sherpa DSIDs.

Definition at line 148 of file JetTruthLabelingTool.h.

                                           {
    if(
        (304307 <= DSID && DSID <= 304309) || // Sherpa 2.2.1 W+jets
        (304707 <= DSID && DSID <= 304709) // Sherpa 2.2.1 Z+jets
    ) { 
      return true;
    }
    return false;
  };

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

Use R21Consolidated definition

Use R21Precision definition

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

  if ( m_truthLabelConfig == TruthLabelConfiguration::R21Consolidated) {
    is_bb = ( nMatchB > 1 );
    isTop = ( matchTop && nMatchB > 0 && jet.m() / 1000. > m_mLowTop );
    isW = matchW && nMatchB == 0 && jet.m() / 1000. > m_mLowW && jet.m() / 1000. < m_mHighW;
    isZ = matchZ && jet.m() / 1000. > m_mLowZ && jet.m() / 1000. < m_mHighZ;
  }

  if ( m_truthLabelConfig == TruthLabelConfiguration::R21Precision) {
    SG::ReadDecorHandle<xAOD::JetContainer, float> split23Handle(m_split23_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 && jet.m() / 1000. < m_mHighW;
    isZ = matchZ && jet.m() / 1000. > m_mLowZ && jet.m() / 1000. < m_mHighZ;
  }
 
  // 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_truthJetCollectionName.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 42 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, std::string collection ) const

protected

Get number of ghost associated particles.

Definition at line 860 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.

getTLVs()

void JetTruthLabelingTool::getTLVs ( std::vector< std::pair< TLorentzVector, int > > & tlvs, const xAOD::TruthParticleContainer * truthBosons, const xAOD::TruthParticleContainer * truthTop, bool isSherpa = false ) const

protected

Extract heavy particle 4-vectors from truth record.

Sherpa W/Z+jets samples need special treatment

Decay products

W candidate

Flag for W or Z candidates

Flag to check if qq' pair is in the mass window

Skip decayed/stable

Skip anything that isn't a light quark

We want to look at first 2 partons except beam particles. Sometimes beam particles are dropped from DxAODs...

Keep particles as first daughter

Find the next particle in the list with status == 3

Skip decayed/stable

Skip anything that isn't a light quark

Daughters of Z decay should be same-flavor but opposite charge

W+ daughters should have a positive u or c

W+ daughters should have a positive u or c

If p1 is a daughter of W/Z decay, the next one is the other daughter

~98% efficiency to W/Z signals. (95% if it is changed to [65, 105]GeV and 90% if [70,100]GeV)

Store W/Z/H bosons

Save 4-vector and pdgId

Store top quarks

Save 4-vector and pdgId

Definition at line 698 of file JetTruthLabelingTool.cxx.

                                                                                                                                                                                                  {
 
  tlvs.clear();

  if(isSherpa) {
    int countStatus3 = 0;

    TLorentzVector p1(0,0,0,0);
    TLorentzVector p2(0,0,0,0);

    TLorentzVector WZCand(0,0,0,0);

    bool isWPCand = false;
    bool isWMCand = false;
    bool isZCand = false;

    bool inMassWindow = false;
 
    for ( unsigned int ipart = 0; ipart < truthBosons->size(); ipart++ ){
 
      const xAOD::TruthParticle* part1 = truthBosons->at(ipart);

      if ( MC::isPhysical(part1) ) continue;

      if ( std::abs(part1->pdgId()) > MC::BQUARK ) continue;
 
      countStatus3++;
      if ( countStatus3 > 3 ) continue;
      p1 = part1->p4();

      for ( unsigned int jpart = ipart+1; jpart < truthBosons->size(); jpart++ ) {
 
        const xAOD::TruthParticle* part2 = truthBosons->at(jpart);

        if (  MC::isPhysical(part2) ) continue;

        if ( std::abs(part2->pdgId()) > MC::BQUARK ) continue;
 
        p2 = part2->p4();

        if ( part1->pdgId() + part2->pdgId() == 0 ) {
          isZCand = true;
        }
        else if ( part1->pdgId() == MC::UQUARK || part1->pdgId() == MC::CQUARK || part2->pdgId() == MC::UQUARK || part2->pdgId() == MC::CQUARK ) {
          isWPCand = true;
        }
        else {
          isWMCand = true;
        }

        break;
 
      }
 
      WZCand = p1 + p2;

      if ( 60000 < WZCand.M() && WZCand.M() < 140000. ) {
        inMassWindow = true;
        break;
      }
 
    }
 
    if ( inMassWindow && (isWPCand || isWMCand || isZCand) ) {
      std::pair<TLorentzVector,int> WZ;
      if ( isZCand ) {
        WZ = std::make_pair(WZCand,23);
      }
      if ( isWPCand ) {
        WZ = std::make_pair(WZCand,24);
      }
      if ( isWMCand ) {
        WZ = std::make_pair(WZCand,-24);
      }
      tlvs.push_back(WZ);
    }
 
  }

  for ( const xAOD::TruthParticle* part : *truthBosons ) {
    if ( !(selectTruthParticle(part,MC::Z0BOSON) || selectTruthParticle(part,MC::WPLUSBOSON) || selectTruthParticle(part,MC::HIGGSBOSON)) ) continue;
    tlvs.push_back(std::make_pair(part->p4(),part->pdgId()));
  }

  for ( const xAOD::TruthParticle* part : *truthTop ) {
    if ( !selectTruthParticle(part,MC::TQUARK) ) continue;
    tlvs.push_back(std::make_pair(part->p4(),part->pdgId()));
  }
 
}

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 838 of file JetTruthLabelingTool.cxx.

                                                             {

 
  float split23 = -999.0;
 
  if ( m_truthLabelConfig == TruthLabelConfiguration::R21Precision ||
       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;
}

getTruthJetLabelDR()

int JetTruthLabelingTool::getTruthJetLabelDR ( DecorHandles & dh, const xAOD::Jet & jet, const std::vector< std::pair< TLorentzVector, int > > & tlv_truthParts, const EventContext & ctx ) const

protected

Get truth label using dR-matched particles.

Booleans to check associated heavy particles

Distances to truth particles

Add matching criteria decorations

Definition at line 288 of file JetTruthLabelingTool.cxx.

                                                                             {

  bool matchW = false;
  bool matchZ = false;
  bool matchH = false;
  bool matchTop = false;

  float dR_W = 9999;
  float dR_Z = 9999;
  float dR_H = 9999;
  float dR_Top = 9999;
 
  for (const auto& tlv_truth : tlv_truthParts) {
    float dR = tlv_truth.first.DeltaR(jet.p4());
    if( dR < m_dRTruthPart ) {
 
      if ( MC::isZ(tlv_truth.second) && !matchZ ) {
        dR_Z = dR;
        matchZ = true;
      }
 
      if ( MC::isW(tlv_truth.second) && !matchW ) {
        dR_W = dR;
        matchW = true;
      }
 
      if ( MC::isHiggs(tlv_truth.second) && !matchH ) {
        dR_H = dR;
        matchH = true;
      }
 
      if ( MC::isTop(tlv_truth.second) && !matchTop ) {
        dR_Top = dR;
        matchTop = true;
      }
 
    }
  }

  (*dh.dRWHandle)(jet) = dR_W;
  (*dh.dRZHandle)(jet) = dR_Z;
  (*dh.dRHHandle)(jet) = dR_H;
  (*dh.dRTopHandle)(jet) = dR_Top;
 
  return getLabel( dh, jet, matchH, matchW, matchZ, matchTop, ctx );
 
}

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

Ghost Association values

Hard-code some values for R10TruthLabel_R21Consolidated
Functionality to customize labeling will be added later

Hard-code some values for R10TruthLabel_R21Precision

Hard-code some values for R10TruthLabel_R21Precision_2022v1 and R10TruthLabel_R22v1

Hard-code some values for R10WZTruthLabel_R22v1

Hard code for small-R jets

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

Reimplemented from asg::AsgTool.

Definition at line 43 of file JetTruthLabelingTool.cxx.

                                           {
 
  ATH_MSG_INFO("Initializing " << name());
 
  m_truthLabelConfig = parseLabel(m_truthLabelName);

  m_useGhostJetMatch = false;
  m_recoGhostFrac = 0.75;
  if(m_truthLabelConfig == TruthLabelConfiguration::R21Consolidated) {
    m_truthJetCollectionName="AntiKt10TruthTrimmedPtFrac5SmallR20Jets";
    m_matchUngroomedParent = false;
    m_dRTruthJet = 0.75;
    m_useDRMatch = true;
    m_dRTruthPart = 0.75;
    m_useWZMassHigh = true;
    m_mLowTop = 140.0;
    m_mLowW = 50.0;
    m_mHighW = 100.0;
    m_mLowZ = 60.0;
    m_mHighZ = 110.0;
    m_getTruthGroomedJetValues = false;
 
  }
  else if(m_truthLabelConfig == TruthLabelConfiguration::R21Precision) {
    m_truthJetCollectionName="AntiKt10TruthJets";
    m_matchUngroomedParent = true;
    m_dRTruthJet = 0.75;
    m_useDRMatch = false;
    m_useWZMassHigh = true;
    m_mLowTop = 140.0;
    m_mLowW = 50.0;
    m_mHighW = 100.0;
    m_mLowZ = 60.0;
    m_mHighZ = 110.0;
    m_getTruthGroomedJetValues = false;
  }
  else if(m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 or m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1) {
    m_truthJetCollectionName="AntiKt10TruthJets";
    m_matchUngroomedParent = true;
    m_dRTruthJet = 0.75;
    m_useDRMatch = false;
    m_useWZMassHigh = false;
    m_mLowTop = 140.0;
    m_mLowW = 50.0;
    m_mLowZ = 50.0;
    if ( m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1) {
      m_getTruthGroomedJetValues = true;
      m_truthGroomedJetCollectionName = "AntiKt10TruthSoftDropBeta100Zcut10Jets";
    } else {
      m_getTruthGroomedJetValues = false;
    }
  }
  else if( m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1 ) {
    m_truthJetCollectionName="AntiKt10TruthDressedWZJets";
    m_matchUngroomedParent = true;
    m_dRTruthJet = 0.75;
    m_useDRMatch = false;
    m_useWZMassHigh = false;
    m_mLowTop = 140.0;
    m_mLowW = 50.0;
    m_mLowZ = 50.0;
    m_getTruthGroomedJetValues = true;
    m_truthGroomedJetCollectionName = "AntiKt10TruthDressedWZSoftDropBeta100Zcut10Jets";
  } 

  else if (m_truthLabelConfig == TruthLabelConfiguration::R4TruthLabel ) {
      m_truthJetCollectionName = "AntiKt4TruthJets";
      // m_truthJetCollectionName = "AntiKt4TruthDressedWZJets";
      // Dressed option not working as of 2026-04-17, using regular.
      m_matchUngroomedParent = false;
      m_dRTruthJet = 0.3;
      m_useDRMatch = false;
      m_useWZMassHigh = true;
      m_mLowTop = 140.0;
      m_mLowW = 50.0;
      m_mHighW = 100.0;
      m_mLowZ = 60.0;
      m_mHighZ = 110.0;
      m_getTruthGroomedJetValues = false;
      m_useGhostJetMatch = true;
  }
 
  print();

  
  bool isSupportedLabel = false;
  isSupportedLabel = isSupportedLabel || (m_truthLabelConfig == TruthLabelConfiguration::R21Consolidated);
  isSupportedLabel = isSupportedLabel || (m_truthLabelConfig == TruthLabelConfiguration::R21Precision);
  isSupportedLabel = isSupportedLabel || (m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1);
  isSupportedLabel = isSupportedLabel || (m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1);
  isSupportedLabel = isSupportedLabel || (m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1);
  isSupportedLabel = isSupportedLabel || (m_truthLabelConfig == TruthLabelConfiguration::R4TruthLabel);
 
  if(!isSupportedLabel) {
    ATH_MSG_ERROR("TruthLabelName " << m_truthLabelName << " is not supported. Exiting...");
    return StatusCode::FAILURE;
  }
 
  m_label_truthKey   = m_truthJetCollectionName.key() + "." + m_truthLabelName;
  m_dR_W_truthKey    = m_truthJetCollectionName.key() + "." + m_truthLabelName + "_dR_W";
  m_dR_Z_truthKey    = m_truthJetCollectionName.key() + "." + m_truthLabelName + "_dR_Z";
  m_dR_H_truthKey    = m_truthJetCollectionName.key() + "." + m_truthLabelName + "_dR_H";
  m_dR_Top_truthKey  = m_truthJetCollectionName.key() + "." + m_truthLabelName + "_dR_Top";
  m_NB_truthKey      = m_truthJetCollectionName.key() + "." + m_truthLabelName + "_NB";
  m_split12_truthKey = m_truthJetCollectionName.key() + ".Split12";
  m_split23_truthKey = m_truthJetCollectionName.key() + ".Split23";
 
  if(!m_isTruthJetCol){
    m_label_recoKey  = m_jetContainerName + "." + m_truthLabelName;
    m_dR_W_recoKey   = m_jetContainerName + "." + m_truthLabelName + "_dR_W";
    m_dR_Z_recoKey   = m_jetContainerName + "." + m_truthLabelName + "_dR_Z";
    m_dR_H_recoKey   = m_jetContainerName + "." + m_truthLabelName + "_dR_H";
    m_dR_Top_recoKey = m_jetContainerName + "." + m_truthLabelName + "_dR_Top";
    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_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_truthParticleContainerName.initialize(!m_useTRUTH3));
  ATH_CHECK(m_truthBosonContainerName.initialize(m_useTRUTH3));
  ATH_CHECK(m_truthTopQuarkContainerName.initialize(m_useTRUTH3));
  ATH_CHECK(m_truthJetCollectionName.initialize());
  ATH_CHECK(m_truthGroomedJetCollectionName.initialize(m_getTruthGroomedJetValues));
 
  ATH_CHECK(m_label_truthKey.initialize());
  ATH_CHECK(m_dR_W_truthKey.initialize(m_useDRMatch));
  ATH_CHECK(m_dR_Z_truthKey.initialize(m_useDRMatch));
  ATH_CHECK(m_dR_H_truthKey.initialize(m_useDRMatch));
  ATH_CHECK(m_dR_Top_truthKey.initialize(m_useDRMatch));
  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 || 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_dR_W_recoKey.initialize(!m_isTruthJetCol && m_useDRMatch));
  ATH_CHECK(m_dR_Z_recoKey.initialize(!m_isTruthJetCol && m_useDRMatch));
  ATH_CHECK(m_dR_H_recoKey.initialize(!m_isTruthJetCol && m_useDRMatch));
  ATH_CHECK(m_dR_Top_recoKey.initialize(!m_isTruthJetCol && m_useDRMatch));
  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 || m_truthLabelConfig == TruthLabelConfiguration::R21Precision_2022v1 || m_truthLabelConfig == TruthLabelConfiguration::R10TruthLabel_R22v1 || m_truthLabelConfig == TruthLabelConfiguration::R10WZTruthLabel_R22v1)));
  
  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 402 of file JetTruthLabelingTool.cxx.

                                                                              {
    
  SG::ReadHandle<xAOD::JetContainer> truthJets(m_truthJetCollectionName, ctx);
  SG::ReadHandle<xAOD::JetContainer> truthGroomedJets;
  if ( m_getTruthGroomedJetValues ) {
    truthGroomedJets = SG::makeHandle(m_truthGroomedJetCollectionName, 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());
          // GF
          static const SG::ConstAccessor<float> accGhostTruthPt("GhostTruthPt");
          float ghostTruthPt = accGhostTruthPt(*jet);
          float ghostPtFraction = (ghostTruthPt / (truthJet->pt()));
          if (m_useGhostJetMatch) {
              // 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 );
    float dR_truthJet_W = 9999;
    float dR_truthJet_Z = 9999;
    float dR_truthJet_Top = 9999;
    float dR_truthJet_H = 9999;
    int truthJetNB = -1;
    float truthJetSplit12 = -9999;
    float truthJetSplit23 = -9999;
 
    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.
        SG::ConstAccessor<int> labelAcc (dh.labelHandle->auxid());
        label = labelAcc(*matchTruthJet);
        if ( m_useDRMatch ) {
          if(dh.dRWHandle->isAvailable()) dR_truthJet_W = (*dh.dRWHandle)(*matchTruthJet);
          if(dh.dRZHandle->isAvailable()) dR_truthJet_Z = (*dh.dRZHandle)(*matchTruthJet);
          if(dh.dRHHandle->isAvailable()) dR_truthJet_H = (*dh.dRHHandle)(*matchTruthJet);
          if(dh.dRTopHandle->isAvailable()) dR_truthJet_Top = (*dh.dRTopHandle)(*matchTruthJet);
        }
        if ( m_truthLabelConfig == TruthLabelConfiguration::R21Precision) {
          SG::ReadDecorHandle<xAOD::JetContainer, float> split23Handle(m_split23_truthKey, ctx);
          if(split23Handle.isAvailable()) truthJetSplit23 = split23Handle(*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);
        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 ) {
        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();
      }
    }

    (*dh.labelRecoHandle)(*jet) = label;

    if ( m_useDRMatch ) {
      (*dh.dRWRecoHandle)(*jet) = dR_truthJet_W;
      (*dh.dRZRecoHandle)(*jet) = dR_truthJet_Z;
      (*dh.dRHRecoHandle)(*jet) = dR_truthJet_H;
      (*dh.dRTopRecoHandle)(*jet) = dR_truthJet_Top;
    }
    if ( m_truthLabelConfig == TruthLabelConfiguration::R21Precision) {
      (*dh.split23Handle)(*jet) = truthJetSplit23;
    }
 
    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.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 587 of file JetTruthLabelingTool.cxx.

                                                                               {

  SG::ReadHandle<xAOD::JetContainer> truthJets(m_truthJetCollectionName, 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 MC channel number

Get the EventInfo to identify Sherpa samples

Vectors of W/Z/H/Top TLorentzVectors

Get truth particles directly if using dR matching

Check if it is a Sherpa sample

TRUTH3

Check for boson container

Check for top quark container

Get truth particle TLVs

TRUTH1

Get truth particle TLVs

Apply label to truth jet

Definition at line 603 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;
  }

  int channelNumber = -999;

  SG::ReadHandle<xAOD::EventInfo> eventInfo(m_evtInfoKey, ctx);
  if(!eventInfo.isValid()){
    ATH_MSG_ERROR("Failed to retrieve event information.");
    return StatusCode::FAILURE;
  }

  std::vector<std::pair<TLorentzVector,int> > tlv_truthParts;

  if ( m_useDRMatch ) {
  
    channelNumber = eventInfo->mcChannelNumber();
 
    if ( channelNumber < 0 ) {
      ATH_MSG_ERROR("Channel number was not set correctly");
      return StatusCode::FAILURE;
    }

    bool isSherpa = getIsSherpa(channelNumber);
 
    if ( m_useTRUTH3 && isSherpa ) {
      ATH_MSG_ERROR("Cannot apply truth labels to Sherpa 2.2.1 samples using TRUTH3 containers");
      return StatusCode::FAILURE;
    }

    if( m_useTRUTH3 ) {
      SG::ReadHandle<xAOD::TruthParticleContainer> truthPartsBoson(m_truthBosonContainerName, ctx);
      if(!truthPartsBoson.isValid()){
        ATH_MSG_ERROR("Unable to find " << m_truthBosonContainerName.key() << ". Please check the content of your input file.");
        return StatusCode::FAILURE;
      }
      SG::ReadHandle<xAOD::TruthParticleContainer> truthPartsTop(m_truthTopQuarkContainerName, ctx);
      if(!truthPartsTop.isValid()){
        ATH_MSG_ERROR("Unable to find " << m_truthTopQuarkContainerName.key() << ". Please check the content of your input file.");
        return StatusCode::FAILURE;
      }
      getTLVs(tlv_truthParts, truthPartsBoson.cptr(), truthPartsTop.cptr(), isSherpa);
    }

    else {
      SG::ReadHandle<xAOD::TruthParticleContainer> truthParts(m_truthParticleContainerName, ctx);
      if(!truthParts.isValid()){
        ATH_MSG_ERROR("Unable to find " << m_truthParticleContainerName << ". Please check the content of your input file.");
        return StatusCode::FAILURE;
      }
      getTLVs(tlv_truthParts, truthParts.cptr(), truthParts.cptr(), isSherpa);
    }
  }
 
  int label = LargeRJetTruthLabel::enumToInt(LargeRJetTruthLabel::notruth);
  for ( const xAOD::Jet *jet : truthJets ) {
 
    if ( m_useDRMatch ) {
      ATH_MSG_DEBUG("Getting truth label using dR matching");
      label = getTruthJetLabelDR(dh, *jet, tlv_truthParts, ctx);
    }
    
    else {
      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.

{return decorate(jets);};

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_R21Consolidated")
        return TruthLabelConfiguration::R21Consolidated;
 
    if (name == "R10TruthLabel_R21Precision")
        return TruthLabelConfiguration::R21Precision;
 
    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;
 
    return TruthLabelConfiguration::Unknown;
}

print()

void JetTruthLabelingTool::print ( ) const

overridevirtual

Print configured parameters.

Reimplemented from asg::AsgTool.

Definition at line 218 of file JetTruthLabelingTool.cxx.

                                       {
  ATH_MSG_INFO("Parameters for " << name());
 
  ATH_MSG_INFO("xAOD information:");
  ATH_MSG_INFO("TruthLabelName:               " << m_truthLabelName);
  ATH_MSG_INFO("UseTRUTH3:                    " << ( m_useTRUTH3 ? "True" : "False"));
  
  if(m_useTRUTH3) {
    ATH_MSG_INFO("TruthBosonContainerName:      " << m_truthBosonContainerName);
    ATH_MSG_INFO("TruthTopQuarkContainerName:   " << m_truthTopQuarkContainerName);
  }
  else {
    ATH_MSG_INFO("TruthParticleContainerName:   " << m_truthParticleContainerName);
  }
  
  ATH_MSG_INFO("TruthJetCollectionName:         " << m_truthJetCollectionName.key());
  ATH_MSG_INFO("dRTruthJet:    " << std::to_string(m_dRTruthJet));
 
  if ( m_useDRMatch ) {
    ATH_MSG_INFO("dRTruthPart:   " << std::to_string(m_dRTruthPart));
  }
 
  ATH_MSG_INFO("mLowTop:       " << std::to_string(m_mLowTop));
  ATH_MSG_INFO("mLowW:         " << std::to_string(m_mLowW));
  if(m_useWZMassHigh)
    ATH_MSG_INFO("mHighW:        " << std::to_string(m_mHighW));
  ATH_MSG_INFO("mLowZ:         " << std::to_string(m_mLowZ));
  if(m_useWZMassHigh)
    ATH_MSG_INFO("mHighZ:        " << std::to_string(m_mHighZ));
 
  if(m_getTruthGroomedJetValues) {
    ATH_MSG_INFO("truthGroomedJetCollectionName: " << m_truthGroomedJetCollectionName.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();
  }

selectTruthParticle()

bool JetTruthLabelingTool::selectTruthParticle ( const xAOD::TruthParticle * tp, int pdgId ) const

protected

Check if truth particle has correct DSID and isn't self decay.

Definition at line 810 of file JetTruthLabelingTool.cxx.

                                                                                             {
  if ( std::abs(tp->pdgId()) != pdgId ) return false;
  for ( unsigned int iChild = 0; iChild < tp->nChildren(); iChild++ ) {
    const xAOD::TruthParticle *child = tp->child(iChild);
    if ( !child ) continue;
    if ( child->pdgId() == tp->pdgId() ) return false;
  }
  return true;
}

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

Friends And Related Symbol Documentation

DecorHandles

friend struct DecorHandles

friend

Definition at line 108 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_dR_H_recoKey

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

protected

Definition at line 189 of file JetTruthLabelingTool.h.

{this, "dR_H_RecoKey", "", "Do not configure manually!"};

m_dR_H_truthKey

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

protected

Definition at line 180 of file JetTruthLabelingTool.h.

{this, "dR_H_TruthKey", "", "Do not configure manually!"};

m_dR_Top_recoKey

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

protected

Definition at line 190 of file JetTruthLabelingTool.h.

{this, "dR_Top_RecoKey", "", "Do not configure manually!"};

m_dR_Top_truthKey

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

protected

Definition at line 181 of file JetTruthLabelingTool.h.

{this, "dR_Top_TruthKey", "", "Do not configure manually!"};

m_dR_W_recoKey

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

protected

Definition at line 187 of file JetTruthLabelingTool.h.

{this, "dR_W_RecoKey", "", "Do not configure manually!"};

m_dR_W_truthKey

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

protected

Definition at line 178 of file JetTruthLabelingTool.h.

{this, "dR_W_TruthKey", "", "Do not configure manually!"};

m_dR_Z_recoKey

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

protected

Definition at line 188 of file JetTruthLabelingTool.h.

{this, "dR_Z_RecoKey", "", "Do not configure manually!"};

m_dR_Z_truthKey

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

protected

Definition at line 179 of file JetTruthLabelingTool.h.

{this, "dR_Z_TruthKey", "", "Do not configure manually!"};

m_dRTruthJet

double JetTruthLabelingTool::m_dRTruthJet {}

protected

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

Definition at line 69 of file JetTruthLabelingTool.h.

{}; 

m_dRTruthPart

double JetTruthLabelingTool::m_dRTruthPart {}

protected

Ghost pT fraction to match truth jet to reco jet.

Definition at line 71 of file JetTruthLabelingTool.h.

{}; 

m_evtInfoKey

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

protected

Definition at line 53 of file JetTruthLabelingTool.h.

{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_getTruthGroomedJetValues

bool JetTruthLabelingTool::m_getTruthGroomedJetValues {}

protected

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

Definition at line 68 of file JetTruthLabelingTool.h.

{}; 

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 51 of file JetTruthLabelingTool.h.

{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 48 of file JetTruthLabelingTool.h.

{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 186 of file JetTruthLabelingTool.h.

{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 177 of file JetTruthLabelingTool.h.

{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 202 of file JetTruthLabelingTool.h.

{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 203 of file JetTruthLabelingTool.h.

{this, "MatchedTruthGroomedJetPt_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 199 of file JetTruthLabelingTool.h.

{ 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 197 of file JetTruthLabelingTool.h.

{ 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 200 of file JetTruthLabelingTool.h.

{ 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 195 of file JetTruthLabelingTool.h.

{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 198 of file JetTruthLabelingTool.h.

{ 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 196 of file JetTruthLabelingTool.h.

{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 67 of file JetTruthLabelingTool.h.

{}; 

m_mHighW

double JetTruthLabelingTool::m_mHighW {}

protected

Lower mass cut for W label.

Definition at line 74 of file JetTruthLabelingTool.h.

{}; 

m_mHighZ

double JetTruthLabelingTool::m_mHighZ {}

protected

Lower mass cut for Z label.

Definition at line 76 of file JetTruthLabelingTool.h.

{}; 

m_mLowTop

double JetTruthLabelingTool::m_mLowTop {}

protected

dR to match truth particles to truth jet

Definition at line 72 of file JetTruthLabelingTool.h.

{}; 

m_mLowW

double JetTruthLabelingTool::m_mLowW {}

protected

Lower mass cut for top label.

Definition at line 73 of file JetTruthLabelingTool.h.

{}; 

m_mLowZ

double JetTruthLabelingTool::m_mLowZ {}

protected

Upper mass cut for W label.

Definition at line 75 of file JetTruthLabelingTool.h.

{}; 

m_NB_recoKey

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

protected

Definition at line 191 of file JetTruthLabelingTool.h.

{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 182 of file JetTruthLabelingTool.h.

{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 70 of file JetTruthLabelingTool.h.

{}; 

m_split12_truthKey

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

protected

Definition at line 183 of file JetTruthLabelingTool.h.

{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 184 of file JetTruthLabelingTool.h.

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

m_truthBosonContainerName

SG::ReadHandleKey<xAOD::TruthParticleContainer> JetTruthLabelingTool::m_truthBosonContainerName {this, "TruthBosonContainerName", "TruthBosonsWithDecayParticles", "Truth boson container name"}

protected

Definition at line 58 of file JetTruthLabelingTool.h.

{this, "TruthBosonContainerName", "TruthBosonsWithDecayParticles", "Truth boson container name"};

m_truthGroomedJetCollectionName

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

protected

Definition at line 63 of file JetTruthLabelingTool.h.

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

m_truthJetCollectionName

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

protected

parameters for truth labeling

Definition at line 62 of file JetTruthLabelingTool.h.

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

m_truthLabelConfig

TruthLabelConfiguration JetTruthLabelingTool::m_truthLabelConfig = TruthLabelConfiguration::Unknown

protected

Definition at line 175 of file JetTruthLabelingTool.h.

m_truthLabelName

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

protected

Definition at line 49 of file JetTruthLabelingTool.h.

{this, "TruthLabelName", "R10TruthLabel_R21Consolidated", "Truth label name"};

m_truthParticleContainerName

SG::ReadHandleKey<xAOD::TruthParticleContainer> JetTruthLabelingTool::m_truthParticleContainerName {this, "TruthParticleContainerName", "TruthParticles", "Truth particle container name"}

protected

Definition at line 57 of file JetTruthLabelingTool.h.

{this, "TruthParticleContainerName", "TruthParticles", "Truth particle container name"};

m_truthSplit12_recoKey

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

protected

Definition at line 192 of file JetTruthLabelingTool.h.

{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 193 of file JetTruthLabelingTool.h.

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

m_truthTopQuarkContainerName

SG::ReadHandleKey<xAOD::TruthParticleContainer> JetTruthLabelingTool::m_truthTopQuarkContainerName {this, "TruthTopQuarkContainerName", "TruthTopQuarkWithDecayParticles", "Truth top container name"}

protected

Definition at line 59 of file JetTruthLabelingTool.h.

{this, "TruthTopQuarkContainerName", "TruthTopQuarkWithDecayParticles", "Truth top container name"};

m_useDRMatch

bool JetTruthLabelingTool::m_useDRMatch {}

protected

Definition at line 64 of file JetTruthLabelingTool.h.

{}; 

m_useGhostJetMatch

bool JetTruthLabelingTool::m_useGhostJetMatch {}

protected

Use upper mass cut for W/Z labels.

Definition at line 66 of file JetTruthLabelingTool.h.

{}; 

m_useTRUTH3

Gaudi::Property<bool> JetTruthLabelingTool::m_useTRUTH3 {this, "UseTRUTH3", false, "True for TRUTH3 format, false for TRUTH1"}

protected

TRUTH1 or TRUTH3.

Definition at line 56 of file JetTruthLabelingTool.h.

{this, "UseTRUTH3", false, "True for TRUTH3 format, false for TRUTH1"};

m_useWZMassHigh

bool JetTruthLabelingTool::m_useWZMassHigh {}

protected

Use dR to match partons to truth jet.

Definition at line 65 of file JetTruthLabelingTool.h.

{}; 

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:

• JetTruthLabelingTool.h
• JetTruthLabelingTool.cxx