#include <IRCSafeLabelTool.h>

Inheritance diagram for IRCSafeLabelTool:

Collaboration diagram for IRCSafeLabelTool:

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

Protected Member Functions
std::vector< std::vector< fastjet::PseudoJet > >	getJetInputs (const xAOD::TruthParticleContainer &parts, const xAOD::TruthParticleContainer &label_bs, const xAOD::TruthParticleContainer &label_cs) const
std::vector< std::vector< const fastjet::PseudoJet * > >	match (std::vector< fastjet::PseudoJet > &tagged_jets, const xAOD::JetContainer &jets) const
	Function matching truth pseudojets to reco jets.
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
ParticleJetTools::IRCSafeLabelNames	m_ircsafelabelnames
	Name of jet label attributes.
std::unique_ptr< ParticleJetTools::IRCSafeLabelDecorators >	m_ircsafelabeldecs
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_bottomPartCollectionKey {this,"BParticleCollection","","ReadHandleKey for bottomPartCollection"}
	Read handles particle collections for labeling. We need all inputs used for jet clustering.
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_charmPartCollectionKey {this,"CParticleCollection","","ReadHandleKey for charmPartCollection"}
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_outTruthPartKey {this, "TruthParticleCollection","", "ReadHandleKey of the TruthParticle collection"}
double	m_truthjetptmin
	Minimum pT for truth jet to be matched (in MeV)
double	m_jetptmin
	Minimum pT for jet selection (in MeV)
double	m_drmax
	Maximum dR for matching criterion.
double	m_truthR
	Radius of truth jets with undecayed B and D hadrons.
std::vector< std::string >	m_enabledAlgos
	Enabled algorithms (subset of: IFN, CMP, GHS, SDF, AKT)
bool	m_doIFN {true}
bool	m_doCMP {true}
bool	m_doGHS {true}
bool	m_doSDF {true}
bool	m_doAKT {true}
std::unique_ptr< fastjet::Selector >	m_selectPt
std::unique_ptr< fastjet::contrib::FlavRecombiner >	m_flavRecombiner
std::unique_ptr< fastjet::JetDefinition >	m_aktJetDef
std::unique_ptr< fastjet::JetDefinition >	m_ifnJetDef
std::unique_ptr< fastjet::JetDefinition >	m_cmpJetDef

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

Detailed Description

Definition at line 21 of file IRCSafeLabelTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ IRCSafeLabelTool()

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

Constructor.

Definition at line 140 of file IRCSafeLabelTool.cxx.

                                                        : AsgTool(name) {
    m_ircsafelabelnames.IFNsingleint = "IRCSafeLabelIFN";
    m_ircsafelabelnames.CMPsingleint = "IRCSafeLabelCMP";
    m_ircsafelabelnames.GHSsingleint = "IRCSafeLabelGHS";
    m_ircsafelabelnames.SDFsingleint = "IRCSafeLabelSDFlav";
    m_ircsafelabelnames.AKTsingleint = "IRCSafeLabelAKT";
 
    declareProperty("LabelNameIFN", m_ircsafelabelnames.IFNsingleint, "Name of the jet label attribute to be added (IFN)");
    declareProperty("LabelNameCMP", m_ircsafelabelnames.CMPsingleint, "Name of the jet label attribute to be added (CMP)");
    declareProperty("LabelNameGHS", m_ircsafelabelnames.GHSsingleint, "Name of the jet label attribute to be added (GHS)");
    declareProperty("LabelNameSDF", m_ircsafelabelnames.SDFsingleint, "Name of the jet label attribute to be added (SDF, Marzani et al.)");
    declareProperty("LabelNameAKT", m_ircsafelabelnames.AKTsingleint, "Name of the jet label attribute to be added (anti-kt with net flavour - NOT IRC SAFE)");
    declareProperty("EnabledAlgorithms", m_enabledAlgos = {"IFN","CMP","GHS","SDF","AKT"}, "Subset of IRCSafe algorithms to run (IFN, CMP, GHS, SDF, AKT)");
    declareProperty("TruthJetPtMin", m_truthjetptmin=5000, "Minimum pT of truth jets that are matched to reco for labeling [MeV]");
    declareProperty("JetPtMin", m_jetptmin=10000, "Minimum pT of reco jets to be labeled [MeV]");
    declareProperty("DRMax", m_drmax=0.3, "Maximum deltaR between a particle and jet to be labeled");
    declareProperty("TruthR", m_truthR=0.4, "Radius with which truth particles will be clustered when determining the flavour "
                                            "(should be equal to the radius of the tagged jets)");
 
}

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

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 406 of file IRCSafeLabelTool.cxx.

                                                                    {
 
  ATH_MSG_VERBOSE("In " << name() << "::modify()");
  // Retrieve the particle and jet containers
  SG::ReadHandle<xAOD::TruthParticleContainer> truthPartReadHandle(m_outTruthPartKey);
  SG::ReadHandle<xAOD::TruthParticleContainer> truthbsReadHandle(m_bottomPartCollectionKey);
  SG::ReadHandle<xAOD::TruthParticleContainer> truthcsReadHandle(m_charmPartCollectionKey);
  if (!truthbsReadHandle.isValid()){
    ATH_MSG_DEBUG(" Invalid ReadHandle for xAOD::ParticleContainer with key: " << truthbsReadHandle.key());
    return StatusCode::FAILURE;
  }
  if (!truthcsReadHandle.isValid()){
    ATH_MSG_DEBUG(" Invalid ReadHandle for xAOD::ParticleContainer with key: " << truthcsReadHandle.key());
    return StatusCode::FAILURE;
  }
  if (!truthPartReadHandle.isValid()){
    ATH_MSG_DEBUG(" Invalid ReadHandle for xAOD::ParticleContainer with key: " << truthPartReadHandle.key());
    return StatusCode::FAILURE;
  }
 
  vector< vector<PseudoJet> > all_pseudojets = getJetInputs(*truthPartReadHandle, *truthbsReadHandle, *truthcsReadHandle);
  vector<PseudoJet> btagged_pseudojetsIFN, ctagged_pseudojetsIFN;
  vector<PseudoJet> btagged_pseudojetsCMP, ctagged_pseudojetsCMP;
  vector<PseudoJet> btagged_pseudojetsGHS, ctagged_pseudojetsGHS;
  vector<PseudoJet> btagged_pseudojetsSDF, ctagged_pseudojetsSDF;
  vector<PseudoJet> btagged_pseudojetsAKT, ctagged_pseudojetsAKT;
 
  vector<PseudoJet> selected_pseudojets = all_pseudojets[0];
  for (unsigned int i_jets = 0; i_jets < selected_pseudojets.size(); i_jets++) {
    PseudoJet p = selected_pseudojets[i_jets];
    if(p.user_info<FlavHistory>().current_flavour()[5] != 0) btagged_pseudojetsIFN.push_back(p);
    if(p.user_info<FlavHistory>().current_flavour()[4] != 0) ctagged_pseudojetsIFN.push_back(p);
  }
 
  selected_pseudojets = all_pseudojets[1];
  for (unsigned int i_jets = 0; i_jets < selected_pseudojets.size(); i_jets++) {
    PseudoJet p = selected_pseudojets[i_jets];
    if(p.user_info<FlavHistory>().current_flavour()[5] != 0) btagged_pseudojetsCMP.push_back(p);
    if(p.user_info<FlavHistory>().current_flavour()[4] != 0) ctagged_pseudojetsCMP.push_back(p);
  }
 
  selected_pseudojets = all_pseudojets[2];
  for (unsigned int i_jets = 0; i_jets < selected_pseudojets.size(); i_jets++) {
    PseudoJet p = selected_pseudojets[i_jets];
    if(p.user_info<FlavHistory>().current_flavour()[5] != 0) btagged_pseudojetsGHS.push_back(p);
    if(p.user_info<FlavHistory>().current_flavour()[4] != 0) ctagged_pseudojetsGHS.push_back(p);
  }
 
  selected_pseudojets = all_pseudojets[3];
  for (unsigned int i_jets = 0; i_jets < selected_pseudojets.size(); i_jets++) {
    PseudoJet p = selected_pseudojets[i_jets];
    if(p.user_info<FlavHistory>().current_flavour()[5] != 0) btagged_pseudojetsSDF.push_back(p);
    if(p.user_info<FlavHistory>().current_flavour()[4] != 0) ctagged_pseudojetsSDF.push_back(p);
  }
 
  selected_pseudojets = all_pseudojets[4];
  for (unsigned int i_jets = 0; i_jets < selected_pseudojets.size(); i_jets++) {
    PseudoJet p = selected_pseudojets[i_jets];
    if(p.user_info<FlavHistory>().current_flavour()[5] != 0) btagged_pseudojetsAKT.push_back(p);
    if(p.user_info<FlavHistory>().current_flavour()[4] != 0) ctagged_pseudojetsAKT.push_back(p);
  }
 
  // match the tagged pseudojets to reco jets
  vector< vector<const PseudoJet*> > jetlabelIFN_b = m_doIFN ? match(btagged_pseudojetsIFN, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelIFN_c = m_doIFN ? match(ctagged_pseudojetsIFN, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelCMP_b = m_doCMP ? match(btagged_pseudojetsCMP, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelCMP_c = m_doCMP ? match(ctagged_pseudojetsCMP, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelGHS_b = m_doGHS ? match(btagged_pseudojetsGHS, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelGHS_c = m_doGHS ? match(ctagged_pseudojetsGHS, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelSDF_b = m_doSDF ? match(btagged_pseudojetsSDF, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelSDF_c = m_doSDF ? match(ctagged_pseudojetsSDF, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelAKT_b = m_doAKT ? match(btagged_pseudojetsAKT, jets) : vector< vector<const PseudoJet*> >(jets.size());
  vector< vector<const PseudoJet*> > jetlabelAKT_c = m_doAKT ? match(ctagged_pseudojetsAKT, jets) : vector< vector<const PseudoJet*> >(jets.size());
 
  for (unsigned int iJet = 0; iJet < jets.size(); iJet++) {
    const Jet& jet = *jets.at(iJet);
    if (jet.pt() < m_jetptmin) {
      m_ircsafelabeldecs->IFNsingleint(jet) = 0;
      m_ircsafelabeldecs->CMPsingleint(jet) = 0;
      m_ircsafelabeldecs->GHSsingleint(jet) = 0;
      m_ircsafelabeldecs->SDFsingleint(jet) = 0;
      m_ircsafelabeldecs->AKTsingleint(jet) = 0;
      continue;
    }
 
    // set truth label for jets above pt threshold
    // hierarchy: b > c > light
    ParticleJetTools::Tag_PseudoJets tag_pjet;
    tag_pjet.IFN_b = jetlabelIFN_b.at(iJet);
    tag_pjet.IFN_c = jetlabelIFN_c.at(iJet);
 
    tag_pjet.CMP_b = jetlabelCMP_b.at(iJet);
    tag_pjet.CMP_c = jetlabelCMP_c.at(iJet);
 
    tag_pjet.GHS_b = jetlabelGHS_b.at(iJet);
    tag_pjet.GHS_c = jetlabelGHS_c.at(iJet);
 
    tag_pjet.SDF_b = jetlabelSDF_b.at(iJet);
    tag_pjet.SDF_c = jetlabelSDF_c.at(iJet);
 
    tag_pjet.AKT_b = jetlabelAKT_b.at(iJet);
    tag_pjet.AKT_c = jetlabelAKT_c.at(iJet);
 
    setJetIRCSafeLabels(jet, tag_pjet, *m_ircsafelabeldecs, m_doIFN, m_doCMP, m_doGHS, m_doSDF, m_doAKT);
  }
 
  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

◆ getJetInputs()

vector< vector< PseudoJet > > IRCSafeLabelTool::getJetInputs	(	const xAOD::TruthParticleContainer &	parts,
		const xAOD::TruthParticleContainer &	label_bs,
		const xAOD::TruthParticleContainer &	label_cs ) const

protected

Definition at line 161 of file IRCSafeLabelTool.cxx.

                                                                                                        {
 
  // collect all particles needed
  vector<const TruthParticle*> bs, cs, truthparts;
  for (TruthParticleContainer::const_iterator part_itr = parts.begin();
          part_itr != parts.end(); ++part_itr) {
            const TruthParticle* part = (*part_itr);
            truthparts.push_back(part);
  }
  for (TruthParticleContainer::const_iterator labels_itr = label_bs.begin();
          labels_itr != label_bs.end(); ++labels_itr) {
            const TruthParticle* part = (*labels_itr);
            bs.push_back(part);
  }
  for (TruthParticleContainer::const_iterator labels_itr = label_cs.begin();
          labels_itr != label_cs.end(); ++labels_itr) {
            const TruthParticle* part = (*labels_itr);
            cs.push_back(part);
  }
  // remove all children of B and D hadrons
  using ParticleJetTools::childrenRemoved;
  childrenRemoved(bs, bs);
  childrenRemoved(bs, cs);
  childrenRemoved(bs, truthparts);
  childrenRemoved(cs, cs);
  childrenRemoved(cs, truthparts);
 
  // add original B and D hadrons to the truth particles
  if (bs.size() > 0) truthparts.insert(truthparts.end(), bs.begin(), bs.end());
  if (cs.size() > 0) truthparts.insert(truthparts.end(), cs.begin(), cs.end());
 
  // now, create the PseudoJet event from them
  vector<PseudoJet> fullevent(truthparts.size());
  for (unsigned int ip = 0; ip < truthparts.size(); ip++) {
    const TruthParticle* part = truthparts[ip];
    double px = part->px();
    double py = part->py();
    double pz = part->pz();
    double E  = part->e();
    fullevent[ip] = PseudoJet(px,py,pz,E);
    FlavInfo partFlavInfo = HeavyFlavourContent(part->pdgId());
    fullevent[ip].set_user_info(new FlavInfo(partFlavInfo));
  }
 
  vector< vector<PseudoJet> > all_pseudojets(5);
  if (!(m_doIFN || m_doCMP || m_doGHS || m_doSDF || m_doAKT)) {
    return all_pseudojets;
  }
 
  const Selector& selectpt = *m_selectPt;
  const FlavRecombiner& flav_recombiner = *m_flavRecombiner;
  const JetDefinition& akt_jet_def = *m_aktJetDef;
 
  if (m_doIFN) {
    const JetDefinition& ifn_jet_def = *m_ifnJetDef;
    all_pseudojets[0] = selectpt(ifn_jet_def(fullevent));
  }
 
  if (m_doCMP) {
    const JetDefinition& cmp_jet_def = *m_cmpJetDef;
    all_pseudojets[1] = selectpt(cmp_jet_def(fullevent));
  }
 
  vector<PseudoJet> base_jets;
  if (m_doAKT || m_doGHS || m_doSDF) {
    base_jets = selectpt(akt_jet_def(fullevent));
  }
 
  // GHS parameters:
  double GHS_alpha = 1.0; // < flav-kt distance parameter alpha
  double GHS_omega = 0.0; // < omega parameter for GHS_Omega (omega = 0 uses DeltaR_ij^2)
  double ptcut = 5000.0; // < overall ptcut which is an input to GHS; same as the cut on truth-level jets
  if (m_doGHS) {
    all_pseudojets[2] = run_GHS(base_jets, ptcut, GHS_alpha, GHS_omega, flav_recombiner);
  }
 
  if (m_doSDF) {
    SDFlavourCalc sdFlavCalc;
    vector<PseudoJet> SDF_jets = base_jets;
    sdFlavCalc(SDF_jets);
    all_pseudojets[3] = std::move(SDF_jets);
  }
 
  if (m_doAKT) {
    all_pseudojets[4] = std::move(base_jets);
  }
 
  return all_pseudojets;
 
}

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

◆ getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode IRCSafeLabelTool::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 278 of file IRCSafeLabelTool.cxx.

                                       {
 
  ATH_MSG_DEBUG(" Initializing... ");
  // initialize truth jet inputs key
  ATH_CHECK(m_outTruthPartKey.initialize());
  ATH_CHECK(m_bottomPartCollectionKey.initialize());
  ATH_CHECK(m_charmPartCollectionKey.initialize());
  // build label decorators
  m_ircsafelabeldecs =
    std::make_unique<ParticleJetTools::IRCSafeLabelDecorators>(m_ircsafelabelnames);
 
  std::unordered_set<std::string> enabled;
  for (auto name : m_enabledAlgos) {
    std::transform(name.begin(), name.end(), name.begin(),
                   [](unsigned char c){ return std::tolower(c); });
    enabled.insert(name);
  }
  m_doIFN = enabled.count("ifn") > 0;
  m_doCMP = enabled.count("cmp") > 0;
  m_doGHS = enabled.count("ghs") > 0;
  m_doSDF = enabled.count("sdf") > 0 || enabled.count("sdflav") > 0;
  m_doAKT = enabled.count("akt") > 0;
 
  for (const auto& name : m_enabledAlgos) {
    std::string lowered = name;
    std::transform(lowered.begin(), lowered.end(), lowered.begin(),
                   [](unsigned char c){ return std::tolower(c); });
    if (!(lowered == "ifn" || lowered == "cmp" || lowered == "ghs" ||
          lowered == "sdf" || lowered == "sdflav" || lowered == "akt")) {
      ATH_MSG_WARNING("Unknown algorithm in EnabledAlgorithms: " << name);
    }
  }
 
  if (!(m_doIFN || m_doCMP || m_doGHS || m_doSDF || m_doAKT)) {
    ATH_MSG_WARNING("EnabledAlgorithms is empty; no IRCSafe labelling will be performed.");
    return StatusCode::SUCCESS;
  }
 
  // build algos and other fastjet objects:
  // pt-cut selector and flavour recombination scheme (b + bbar = no flavour, b + b = 2b)
  // another option if modulo_2 (b + bbar = b + b = no flavour), but the CMP and SDFlav algorithms are 
  // not set up to work with it.
  m_selectPt = std::make_unique<Selector>(SelectorPtMin(m_truthjetptmin));
  m_flavRecombiner = std::make_unique<FlavRecombiner>(FlavRecombiner::net);
  // anti-kt with net flavour
  m_aktJetDef = std::make_unique<JetDefinition>(antikt_algorithm, m_truthR);
  m_aktJetDef->set_recombiner(m_flavRecombiner.get());
  // interleaved flavour neutralisation - IFN (2306.07314)
  if (m_doIFN) {
    auto ifn_plugin = std::make_unique<IFNPlugin>(*m_aktJetDef, 1.0, 2.0, FlavRecombiner::net);
    m_ifnJetDef = std::make_unique<JetDefinition>(ifn_plugin.get());
    m_ifnJetDef->delete_plugin_when_unused();
    ifn_plugin.release();
  }
  // Czakon, Mitov, Poncelet (CMP) algorithm - flavour anti-kt (2205.11879)
  if (m_doCMP) {
    const double CMP_a = 0.1;
    // correction to original CMP algo: do not change this if you want IRC safety!
    const CMPPlugin::CorrectionType CMP_corr = CMPPlugin::CorrectionType::OverAllCoshyCosPhi_a2;
    // Dynamic definition of ktmax
    const CMPPlugin::ClusteringType CMP_clust = CMPPlugin::ClusteringType::DynamicKtMax;
    auto cmp_plugin = std::make_unique<CMPPlugin>(m_truthR, CMP_a, CMP_corr, CMP_clust);
    m_cmpJetDef = std::make_unique<JetDefinition>(cmp_plugin.get());
    // enable it to track flavours (default is net flavour)
    m_cmpJetDef->set_recombiner(m_flavRecombiner.get());
    m_cmpJetDef->delete_plugin_when_unused();
    cmp_plugin.release();
  }
  // Other algorithms - Gauld, Huss, Stagnitto (GHS) - flavour dressing (2208.11138) and
  // SDFlav (Caletti, Larkoski, Marzani, Reichelt, 2205.01109) are simple functions of 
  // final-state particles and don't need to be set up externally.
  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.

◆ match()

vector< vector< const PseudoJet * > > IRCSafeLabelTool::match	(	std::vector< fastjet::PseudoJet > &	tagged_jets,
		const xAOD::JetContainer &	jets ) const

protected

Function matching truth pseudojets to reco jets.

Definition at line 353 of file IRCSafeLabelTool.cxx.

                                                                                           {
  ATH_MSG_VERBOSE("In " << name() << "::match()");
 
  vector< vector<const PseudoJet*> > jetlabelparts(jets.size(), vector<const PseudoJet*>());
 
  // loop over pseudojets and find the best matched jet
  for (unsigned int i_tj = 0; i_tj < tagged_pseudojets.size(); i_tj++) {
 
    const PseudoJet* tag_pjet = static_cast<const PseudoJet*>(&tagged_pseudojets[i_tj]);
 
    double mindr = DBL_MAX;
    double maxpt = 0;
    int mindrjetidx = -1;
    int maxptjetidx = -1;
    for (unsigned int iJet = 0; iJet < jets.size(); iJet++) {
 
      const Jet& jet = *jets.at(iJet);
 
      double pt = jet.pt();
      if (pt < m_jetptmin)
          continue;
 
      double drap = abs(jet.rapidity() - tag_pjet->rap());
      double dphi = abs(jet.phi() - tag_pjet->phi());
      if (dphi > numbers::pi) dphi = 2*numbers::pi - dphi;
      double dr = pow(drap*drap + dphi*dphi, 0.5);
      // too far for matching criterion
      if (dr > m_drmax)
          continue;
 
      // store the matched jet
      if (dr < mindr) {
          mindr = dr;
          mindrjetidx = iJet;
      }
 
      if (pt > maxpt) {
          maxpt = pt;
          maxptjetidx = iJet;
      }
 
    }
 
    // store the label particle with the jet
    if (mindrjetidx >= 0) jetlabelparts.at(mindrjetidx).push_back(tag_pjet);
    else if (maxptjetidx >= 0) jetlabelparts.at(maxptjetidx).push_back(tag_pjet);
    }
 
    return jetlabelparts;
 
}

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32{return decorate(jets);};

IJetDecorator::decorate

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

Decorate a jet collection without otherwise modifying it.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

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

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

◆ renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_aktJetDef

std::unique_ptr<fastjet::JetDefinition> IRCSafeLabelTool::m_aktJetDef

protected

Definition at line 78 of file IRCSafeLabelTool.h.

◆ m_bottomPartCollectionKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> IRCSafeLabelTool::m_bottomPartCollectionKey {this,"BParticleCollection","","ReadHandleKey for bottomPartCollection"}

protected

Read handles particle collections for labeling. We need all inputs used for jet clustering.

Definition at line 50 of file IRCSafeLabelTool.h.

50{this,"BParticleCollection","","ReadHandleKey for bottomPartCollection"};

◆ m_charmPartCollectionKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> IRCSafeLabelTool::m_charmPartCollectionKey {this,"CParticleCollection","","ReadHandleKey for charmPartCollection"}

protected

Definition at line 51 of file IRCSafeLabelTool.h.

51{this,"CParticleCollection","","ReadHandleKey for charmPartCollection"};

◆ m_cmpJetDef

std::unique_ptr<fastjet::JetDefinition> IRCSafeLabelTool::m_cmpJetDef

protected

Definition at line 80 of file IRCSafeLabelTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doAKT

bool IRCSafeLabelTool::m_doAKT {true}

protected

Definition at line 73 of file IRCSafeLabelTool.h.

73{true};

◆ m_doCMP

bool IRCSafeLabelTool::m_doCMP {true}

protected

Definition at line 70 of file IRCSafeLabelTool.h.

70{true};

◆ m_doGHS

bool IRCSafeLabelTool::m_doGHS {true}

protected

Definition at line 71 of file IRCSafeLabelTool.h.

71{true};

◆ m_doIFN

bool IRCSafeLabelTool::m_doIFN {true}

protected

Definition at line 69 of file IRCSafeLabelTool.h.

69{true};

◆ m_doSDF

bool IRCSafeLabelTool::m_doSDF {true}

protected

Definition at line 72 of file IRCSafeLabelTool.h.

72{true};

◆ m_drmax

double IRCSafeLabelTool::m_drmax

protected

Maximum dR for matching criterion.

Definition at line 61 of file IRCSafeLabelTool.h.

◆ m_enabledAlgos

std::vector<std::string> IRCSafeLabelTool::m_enabledAlgos

protected

Enabled algorithms (subset of: IFN, CMP, GHS, SDF, AKT)

Definition at line 67 of file IRCSafeLabelTool.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_flavRecombiner

std::unique_ptr<fastjet::contrib::FlavRecombiner> IRCSafeLabelTool::m_flavRecombiner

protected

Definition at line 77 of file IRCSafeLabelTool.h.

◆ m_ifnJetDef

std::unique_ptr<fastjet::JetDefinition> IRCSafeLabelTool::m_ifnJetDef

protected

Definition at line 79 of file IRCSafeLabelTool.h.

◆ m_ircsafelabeldecs

std::unique_ptr<ParticleJetTools::IRCSafeLabelDecorators> IRCSafeLabelTool::m_ircsafelabeldecs

protected

Definition at line 47 of file IRCSafeLabelTool.h.

◆ m_ircsafelabelnames

ParticleJetTools::IRCSafeLabelNames IRCSafeLabelTool::m_ircsafelabelnames

protected

Name of jet label attributes.

Definition at line 46 of file IRCSafeLabelTool.h.

◆ m_jetptmin

double IRCSafeLabelTool::m_jetptmin

protected

Minimum pT for jet selection (in MeV)

Definition at line 58 of file IRCSafeLabelTool.h.

◆ m_outTruthPartKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> IRCSafeLabelTool::m_outTruthPartKey {this, "TruthParticleCollection","", "ReadHandleKey of the TruthParticle collection"}

protected

Definition at line 52 of file IRCSafeLabelTool.h.

52{this, "TruthParticleCollection","", "ReadHandleKey of the TruthParticle collection"};

◆ m_selectPt

std::unique_ptr<fastjet::Selector> IRCSafeLabelTool::m_selectPt

protected

Definition at line 76 of file IRCSafeLabelTool.h.

◆ m_truthjetptmin

double IRCSafeLabelTool::m_truthjetptmin

protected

Minimum pT for truth jet to be matched (in MeV)

Definition at line 55 of file IRCSafeLabelTool.h.

◆ m_truthR

double IRCSafeLabelTool::m_truthR

protected

Radius of truth jets with undecayed B and D hadrons.

Definition at line 64 of file IRCSafeLabelTool.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:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ IRCSafeLabelTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ decorate()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getJetInputs()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ match()

◆ modify()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_aktJetDef

◆ m_bottomPartCollectionKey

◆ m_charmPartCollectionKey

◆ m_cmpJetDef

◆ m_detStore

◆ m_doAKT

◆ m_doCMP

◆ m_doGHS

◆ m_doIFN

◆ m_doSDF

◆ m_drmax

◆ m_enabledAlgos

◆ m_evtStore

◆ m_flavRecombiner

◆ m_ifnJetDef

◆ m_ircsafelabeldecs

◆ m_ircsafelabelnames

◆ m_jetptmin

◆ m_outTruthPartKey

◆ m_selectPt

◆ m_truthjetptmin

◆ m_truthR

◆ m_varHandleArraysDeclared

◆ m_vhka