PanTau::Tool_DecayModeDeterminator Class Reference

Tool to store information needed in PanTau Algorithms. More...

#include <Tool_DecayModeDeterminator.h>

Inheritance diagram for PanTau::Tool_DecayModeDeterminator:

Collaboration diagram for PanTau::Tool_DecayModeDeterminator:

Public Types
enum	DecayModeTest {   t_1p0n_vs_1p1n , t_1p1n_vs_1pXn , t_3p0n_vs_3pXn , t_UnknownTest ,   t_nTests }

Public Member Functions
	Tool_DecayModeDeterminator (const std::string &name)
virtual	~Tool_DecayModeDeterminator ()
virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function.
virtual StatusCode	execute (PanTau::PanTauSeed *inSeed) const
bool	isInitialized ()
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
ToolHandle< PanTau::ITool_InformationStore >	m_Tool_InformationStore {this, "Tool_InformationStore", "PanTau::Tool_InformationStore/Tool_InformationStore", "Tool handle to the information store tool"}
ToolHandle< PanTau::ITool_ModeDiscriminator >	m_Tool_ModeDiscriminator_1p0n_vs_1p1n {this, "Tool_ModeDiscriminator_1p0n_vs_1p1n", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 1p0n_vs_1p1n"}
ToolHandle< PanTau::ITool_ModeDiscriminator >	m_Tool_ModeDiscriminator_1p1n_vs_1pXn {this, "Tool_ModeDiscriminator_1p1n_vs_1pXn", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 1p1n_vs_1pXn"}
ToolHandle< PanTau::ITool_ModeDiscriminator >	m_Tool_ModeDiscriminator_3p0n_vs_3pXn {this, "Tool_ModeDiscriminator_3p0n_vs_3pXn", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 3p0n_vs_3pXn"}
Gaudi::Property< std::string >	m_Tool_InformationStoreName {this, "Tool_InformationStoreName", "", "Tool handle to the information store tool"}
Gaudi::Property< std::string >	m_Tool_ModeDiscriminator_1p0n_vs_1p1nName {this, "Tool_ModeDiscriminator_1p0n_vs_1p1nName", "", "Handle to the ModeDiscriminator tool for 1p0n_vs_1p1n"}
Gaudi::Property< std::string >	m_Tool_ModeDiscriminator_1p1n_vs_1pXnName {this, "Tool_ModeDiscriminator_1p1n_vs_1pXnName", "", "Handle to the ModeDiscriminator tool for 1p1n_vs_1pXn"}
Gaudi::Property< std::string >	m_Tool_ModeDiscriminator_3p0n_vs_3pXnName {this, "Tool_ModeDiscriminator_3p0n_vs_3pXnName", "", "Handle to the ModeDiscriminator tool for 3p0n_vs_3pXn"}
std::string	m_varTypeName_Prefix_Basic
double	m_BDTCutValue_R10X_CellBased = 0.0
double	m_BDTCutValue_R11X_CellBased = 0.0
double	m_BDTCutValue_R110_CellBased = 0.0
double	m_BDTCutValue_R1XX_CellBased = 0.0
double	m_BDTCutValue_R30X_CellBased = 0.0
double	m_BDTCutValue_R3XX_CellBased = 0.0
bool	m_init =false
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

Tool to store information needed in PanTau Algorithms.

Author

Christian Limbach (limba.nosp@m.ch@p.nosp@m.hysik.nosp@m..uni.nosp@m.-bonn.nosp@m..de)

Definition at line 29 of file Tool_DecayModeDeterminator.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

DecayModeTest

enum PanTau::Tool_DecayModeDeterminator::DecayModeTest

Enumerator
t_1p0n_vs_1p1n
t_1p1n_vs_1pXn
t_3p0n_vs_3pXn
t_UnknownTest
t_nTests

Definition at line 35 of file Tool_DecayModeDeterminator.h.

                           {
            t_1p0n_vs_1p1n,
            t_1p1n_vs_1pXn,
            t_3p0n_vs_3pXn,
            t_UnknownTest,
            t_nTests
        };

Constructor & Destructor Documentation

Tool_DecayModeDeterminator()

PanTau::Tool_DecayModeDeterminator::Tool_DecayModeDeterminator

(

const std::string &

name

)

Definition at line 10 of file Tool_DecayModeDeterminator.cxx.

                                                                                  :
  asg::AsgTool(name)
{}

~Tool_DecayModeDeterminator()

PanTau::Tool_DecayModeDeterminator::~Tool_DecayModeDeterminator ( )

virtualdefault

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

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

execute()

StatusCode PanTau::Tool_DecayModeDeterminator::execute ( PanTau::PanTauSeed * inSeed ) const

virtual

Implements PanTau::ITool_PanTauTools.

Definition at line 47 of file Tool_DecayModeDeterminator.cxx.

                                                                                   {
    
  PanTau::TauFeature* features    = inSeed->getFeatures();
    
  //check for invalid input seed
  bool    noValidInput        = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_NoValidInputTau);
  bool    noAnyConstituents   = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_NoConstituentsAtAll);
  bool    noSelConstituents   = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_NoSelectedConstituents);
  bool    badPt               = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_BadPtValue);
  bool    invalidForDecayMode = (noValidInput || noAnyConstituents || noSelConstituents || badPt);
 
  int decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtModeNotSet;
  xAOD::TauJet* tauJet = inSeed->getTauJet();
 
  if(invalidForDecayMode) {
    ATH_MSG_DEBUG("Seed has no constituents assigned and/or input seed has no substructure info - use NotSet mode for this");
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTau", xAOD::TauJetParameters::Mode_NotSet);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTauExtended", PanTau::PanTauSeed::t_ExtModeNotSet);
    tauJet->setPanTauDetail(xAOD::TauJetParameters::PanTauDetails::PanTau_DecayModeExtended, decayMode_PanTauExtended);
    return StatusCode::SUCCESS;
  }
    
  //get the mode as it was determined by the subalgorithm
  int decayMode_SubAlg = inSeed->getDecayModeBySubAlg();
  int decayMode_PanTau = xAOD::TauJetParameters::Mode_NotSet;
 
  //and calc the number of additional neutrals, not tagged as pi0
  int nPi0Neut_SubAlg     = inSeed->getNumberOfConstituentsOfType(PanTau::TauConstituent::t_Pi0Neut);
  int nNeutrals_SubAlg    = inSeed->getNumberOfConstituentsOfType(PanTau::TauConstituent::t_Neutral);
  int AdditionalNeutrals = nNeutrals_SubAlg - nPi0Neut_SubAlg;
    
  //based on the subAlg decay mode, pass to corresponding PanTau BDT...
  double          bdtResponse = -5;
  DecayModeTest   bdtTest     = t_UnknownTest;
  // 1p0n mode
  if(decayMode_SubAlg == xAOD::TauJetParameters::Mode_1p0n) {
               
    //1 prong, and no other objects at all -> use 1p0n
    if(AdditionalNeutrals == 0) {
      decayMode_PanTau = xAOD::TauJetParameters::Mode_1p0n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode100;
      bdtResponse = -3.;
            
      //if there are neutrals which are not pi0-tagged, check BDT to maybe set 1p1n
    }
    else {
      bool    isOK        = false;
      bdtResponse = m_Tool_ModeDiscriminator_1p0n_vs_1p1n->getResponse(inSeed, isOK);
      bdtTest     = t_1p0n_vs_1p1n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode10X;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING: problems getting bdt response for 1p0n + X-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse >  m_BDTCutValue_R10X_CellBased) ? xAOD::TauJetParameters::Mode_1p0n : xAOD::TauJetParameters::Mode_1p1n;
      }
    }   
  }//end 1p0n    
    
  //1p1n mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_1p1n) {        
    //1prong, 1pi0 and no other neutrals. check 1p0n-vs-1p1n
    if(AdditionalNeutrals == 0) {
      bool    isOK        = false;
      bdtResponse = m_Tool_ModeDiscriminator_1p0n_vs_1p1n->getResponse(inSeed, isOK);
      bdtTest     = t_1p0n_vs_1p1n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode110;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING problems getting bdt response for 1p1n + 0-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse <= m_BDTCutValue_R110_CellBased) ? xAOD::TauJetParameters::Mode_1p1n : xAOD::TauJetParameters::Mode_1p0n;
      }      
      //1prong, 1pi0 and additional neutrals. check 1p1n vs 1pXn
    } 
    else {
      //NOTE: May investigate chain of decisions here: first check 1p0n-1p1n, and then (in case of 1p1n) 1p1n-1pXn
      bool    isOK        = false;
      bdtResponse = m_Tool_ModeDiscriminator_1p1n_vs_1pXn->getResponse(inSeed, isOK);
      bdtTest     = t_1p1n_vs_1pXn;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode11X;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING problems getting bdt response for 1p1n + X-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse >  m_BDTCutValue_R11X_CellBased) ? xAOD::TauJetParameters::Mode_1p1n: xAOD::TauJetParameters::Mode_1pXn;     
      }
    }      
  }//end 1p1n
        
  //1pXn mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_1pXn) {
    //1prong, Xpi0. check 1p1n-vs-1pXn
    bool    isOK        = false;
    bdtResponse = m_Tool_ModeDiscriminator_1p1n_vs_1pXn->getResponse(inSeed, isOK);
    bdtTest     = t_1p1n_vs_1pXn;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode1XX;
    if(!isOK) {
      ATH_MSG_WARNING("WARNING problems getting bdt response for 1p1n + X-neutrals. use subAlg mode");
      decayMode_PanTau = decayMode_SubAlg;
    } else {
      decayMode_PanTau = (bdtResponse > m_BDTCutValue_R1XX_CellBased) ? xAOD::TauJetParameters::Mode_1p1n : xAOD::TauJetParameters::Mode_1pXn;
    }        
  }//end 1pXn      
    
  //3p0n mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_3p0n) {        
    //no additional neutrals. 
    if(AdditionalNeutrals == 0) {
      decayMode_PanTau = xAOD::TauJetParameters::Mode_3p0n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode300;
      bdtResponse = -2.5;            
      //additional neutrals
    } 
    else {            
      bool isOK = false;
      bdtResponse = m_Tool_ModeDiscriminator_3p0n_vs_3pXn->getResponse(inSeed, isOK);
      bdtTest = t_3p0n_vs_3pXn;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode30X;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING problems getting bdt response for 3p0n + X-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse > m_BDTCutValue_R30X_CellBased) ? xAOD::TauJetParameters::Mode_3p0n : xAOD::TauJetParameters::Mode_3pXn;
      }
    }        
  }//end 3p0n
 
  //3pXn mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_3pXn) {       
    //3prong, Xpi0. check 3p0n-vs-3pXn
    bool    isOK        = false;
    bdtResponse = m_Tool_ModeDiscriminator_3p0n_vs_3pXn->getResponse(inSeed, isOK);
    bdtTest     = t_3p0n_vs_3pXn;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode3XX;
    if(!isOK) {
      ATH_MSG_WARNING("WARNING problems getting bdt response for 3p0n + X-neutrals. use subAlg mode");
      decayMode_PanTau = decayMode_SubAlg;
    }
    else {
      decayMode_PanTau = (bdtResponse >  m_BDTCutValue_R3XX_CellBased) ? xAOD::TauJetParameters::Mode_3p0n: xAOD::TauJetParameters::Mode_3pXn;
    }
  } //end 3pXn          
    
  //it's none of 1p0n, 1p1n, 1pXn, 3p0n, 3pXn -> set other mode
  else {
    decayMode_PanTau = xAOD::TauJetParameters::Mode_Other;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtModeOther;
    bdtResponse = -4;
    bdtTest     = t_UnknownTest;
  }
    
  // this overrides Pantau BDT 1p1n decision in the following case:
  // if cell based counted 1 charged, 1 pi0neut, and number of hits in EM1 for the pi0neut is 3 or larger, set 1pXn;
  if(inSeed->getNumberOfConstituentsOfType(PanTau::TauConstituent::t_Charged) == 1 && nPi0Neut_SubAlg == 1) {
    //check for shots in EM1
    bool isOK = false;
    PanTau::TauConstituent* pi0Neut = inSeed->getConstituentsOfType(PanTau::TauConstituent::t_Pi0Neut, isOK).at(0);
    if(isOK) {
      double nPhotons = 0.;
      std::vector<PanTau::TauConstituent*> shots = pi0Neut->getShots();
 
      for(unsigned int iShot=0; iShot<shots.size(); iShot++) {
    nPhotons = nPhotons + static_cast<double>(shots.at(iShot)->getNPhotonsInShot());
      }
 
      if(nPhotons > 2.) {
    decayMode_SubAlg = xAOD::TauJetParameters::Mode_1pXn;
    decayMode_PanTau = xAOD::TauJetParameters::Mode_1pXn;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode11shots;
    inSeed->setModeHackedByCellBased(true);
    bdtResponse = -2.;
      }            
      //end check for pi0 neutrals were found
    }
    else {
      ATH_MSG_WARNING("Could not find expected CellBased neutral -> don't check for photons in cluster");
    }
  } //end hack check for 1p1n
  
  //update mode of seed and store in features
  inSeed->setDecayModeByPanTau(decayMode_PanTau);
  features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode", static_cast<double>(decayMode_SubAlg));
  features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTau", static_cast<double>(decayMode_PanTau));
  features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTauExtended", static_cast<double>(decayMode_PanTauExtended));
 
  tauJet->setPanTauDetail(xAOD::TauJetParameters::PanTauDetails::PanTau_DecayModeExtended, decayMode_PanTauExtended);
    
  if(bdtTest == t_1p0n_vs_1p1n) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", bdtResponse);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", -5.);
  }
  if(bdtTest == t_1p1n_vs_1pXn) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", bdtResponse);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", -5.);
  }
  if(bdtTest == t_3p0n_vs_3pXn) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", bdtResponse);
  }
  if(bdtTest == t_UnknownTest) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", -5.);
  }
 
  return StatusCode::SUCCESS;    
}

extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

getKey()

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

inherited

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

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

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

See also

asg::AsgTool::getName

Parameters

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

Returns

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

Definition at line 119 of file AsgTool.cxx.

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

getName()

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

inherited

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

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

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

See also

asg::AsgTool::getKey

Parameters

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

Returns

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

Definition at line 106 of file AsgTool.cxx.

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

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

initialize()

StatusCode PanTau::Tool_DecayModeDeterminator::initialize ( void )

virtual

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 18 of file Tool_DecayModeDeterminator.cxx.

                                                        {
 
  m_init=true;
 
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_InformationStore, m_Tool_InformationStoreName) );
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_ModeDiscriminator_1p0n_vs_1p1n, m_Tool_ModeDiscriminator_1p0n_vs_1p1nName) );
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_ModeDiscriminator_1p1n_vs_1pXn, m_Tool_ModeDiscriminator_1p1n_vs_1pXnName) );
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_ModeDiscriminator_3p0n_vs_3pXn, m_Tool_ModeDiscriminator_3p0n_vs_3pXnName) );
 
  //get the discri tools
  ATH_CHECK(m_Tool_ModeDiscriminator_1p0n_vs_1p1n.retrieve());
  ATH_CHECK(m_Tool_ModeDiscriminator_1p1n_vs_1pXn.retrieve());
  ATH_CHECK(m_Tool_ModeDiscriminator_3p0n_vs_3pXn.retrieve());
    
  //get the variable prefix
  ATH_CHECK( m_Tool_InformationStore->getInfo_String("FeatureExtractor_VarTypeName_varTypeName_Basic",        m_varTypeName_Prefix_Basic) );
 
  //get the BDT cut values
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R10X_CellBased",        m_BDTCutValue_R10X_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R11X_CellBased",        m_BDTCutValue_R11X_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R110_CellBased",        m_BDTCutValue_R110_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R1XX_CellBased",        m_BDTCutValue_R1XX_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R30X_CellBased",        m_BDTCutValue_R30X_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R3XX_CellBased",        m_BDTCutValue_R3XX_CellBased) );
 
  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.

isInitialized()

bool PanTau::Tool_DecayModeDeterminator::isInitialized ( )

inlinevirtual

Implements PanTau::ITool_PanTauTools.

Definition at line 77 of file Tool_DecayModeDeterminator.h.

{return m_init;}

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, KtDeltaRTool, and LundVariablesTool.

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_BDTCutValue_R10X_CellBased

double PanTau::Tool_DecayModeDeterminator::m_BDTCutValue_R10X_CellBased = 0.0

private

Definition at line 68 of file Tool_DecayModeDeterminator.h.

m_BDTCutValue_R110_CellBased

double PanTau::Tool_DecayModeDeterminator::m_BDTCutValue_R110_CellBased = 0.0

private

Definition at line 70 of file Tool_DecayModeDeterminator.h.

m_BDTCutValue_R11X_CellBased

double PanTau::Tool_DecayModeDeterminator::m_BDTCutValue_R11X_CellBased = 0.0

private

Definition at line 69 of file Tool_DecayModeDeterminator.h.

m_BDTCutValue_R1XX_CellBased

double PanTau::Tool_DecayModeDeterminator::m_BDTCutValue_R1XX_CellBased = 0.0

private

Definition at line 71 of file Tool_DecayModeDeterminator.h.

m_BDTCutValue_R30X_CellBased

double PanTau::Tool_DecayModeDeterminator::m_BDTCutValue_R30X_CellBased = 0.0

private

Definition at line 72 of file Tool_DecayModeDeterminator.h.

m_BDTCutValue_R3XX_CellBased

double PanTau::Tool_DecayModeDeterminator::m_BDTCutValue_R3XX_CellBased = 0.0

private

Definition at line 73 of file Tool_DecayModeDeterminator.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_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_init

bool PanTau::Tool_DecayModeDeterminator::m_init =false

private

Definition at line 75 of file Tool_DecayModeDeterminator.h.

m_Tool_InformationStore

ToolHandle<PanTau::ITool_InformationStore> PanTau::Tool_DecayModeDeterminator::m_Tool_InformationStore {this, "Tool_InformationStore", "PanTau::Tool_InformationStore/Tool_InformationStore", "Tool handle to the information store tool"}

private

Definition at line 52 of file Tool_DecayModeDeterminator.h.

{this, "Tool_InformationStore", "PanTau::Tool_InformationStore/Tool_InformationStore", "Tool handle to the information store tool"};        

m_Tool_InformationStoreName

Gaudi::Property<std::string> PanTau::Tool_DecayModeDeterminator::m_Tool_InformationStoreName {this, "Tool_InformationStoreName", "", "Tool handle to the information store tool"}

private

Definition at line 57 of file Tool_DecayModeDeterminator.h.

{this, "Tool_InformationStoreName", "", "Tool handle to the information store tool"};

m_Tool_ModeDiscriminator_1p0n_vs_1p1n

ToolHandle<PanTau::ITool_ModeDiscriminator> PanTau::Tool_DecayModeDeterminator::m_Tool_ModeDiscriminator_1p0n_vs_1p1n {this, "Tool_ModeDiscriminator_1p0n_vs_1p1n", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 1p0n_vs_1p1n"}

private

Definition at line 53 of file Tool_DecayModeDeterminator.h.

{this, "Tool_ModeDiscriminator_1p0n_vs_1p1n", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 1p0n_vs_1p1n"};

m_Tool_ModeDiscriminator_1p0n_vs_1p1nName

Gaudi::Property<std::string> PanTau::Tool_DecayModeDeterminator::m_Tool_ModeDiscriminator_1p0n_vs_1p1nName {this, "Tool_ModeDiscriminator_1p0n_vs_1p1nName", "", "Handle to the ModeDiscriminator tool for 1p0n_vs_1p1n"}

private

Definition at line 58 of file Tool_DecayModeDeterminator.h.

{this, "Tool_ModeDiscriminator_1p0n_vs_1p1nName", "", "Handle to the ModeDiscriminator tool for 1p0n_vs_1p1n"};

m_Tool_ModeDiscriminator_1p1n_vs_1pXn

ToolHandle<PanTau::ITool_ModeDiscriminator> PanTau::Tool_DecayModeDeterminator::m_Tool_ModeDiscriminator_1p1n_vs_1pXn {this, "Tool_ModeDiscriminator_1p1n_vs_1pXn", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 1p1n_vs_1pXn"}

private

Definition at line 54 of file Tool_DecayModeDeterminator.h.

{this, "Tool_ModeDiscriminator_1p1n_vs_1pXn", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 1p1n_vs_1pXn"};

m_Tool_ModeDiscriminator_1p1n_vs_1pXnName

Gaudi::Property<std::string> PanTau::Tool_DecayModeDeterminator::m_Tool_ModeDiscriminator_1p1n_vs_1pXnName {this, "Tool_ModeDiscriminator_1p1n_vs_1pXnName", "", "Handle to the ModeDiscriminator tool for 1p1n_vs_1pXn"}

private

Definition at line 59 of file Tool_DecayModeDeterminator.h.

{this, "Tool_ModeDiscriminator_1p1n_vs_1pXnName", "", "Handle to the ModeDiscriminator tool for 1p1n_vs_1pXn"};

m_Tool_ModeDiscriminator_3p0n_vs_3pXn

ToolHandle<PanTau::ITool_ModeDiscriminator> PanTau::Tool_DecayModeDeterminator::m_Tool_ModeDiscriminator_3p0n_vs_3pXn {this, "Tool_ModeDiscriminator_3p0n_vs_3pXn", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 3p0n_vs_3pXn"}

private

Definition at line 55 of file Tool_DecayModeDeterminator.h.

{this, "Tool_ModeDiscriminator_3p0n_vs_3pXn", "PanTau::Tool_ModeDiscriminator/Tool_ModeDiscriminator", "Handle to the ModeDiscriminator tool for 3p0n_vs_3pXn"};

m_Tool_ModeDiscriminator_3p0n_vs_3pXnName

Gaudi::Property<std::string> PanTau::Tool_DecayModeDeterminator::m_Tool_ModeDiscriminator_3p0n_vs_3pXnName {this, "Tool_ModeDiscriminator_3p0n_vs_3pXnName", "", "Handle to the ModeDiscriminator tool for 3p0n_vs_3pXn"}

private

Definition at line 60 of file Tool_DecayModeDeterminator.h.

{this, "Tool_ModeDiscriminator_3p0n_vs_3pXnName", "", "Handle to the ModeDiscriminator tool for 3p0n_vs_3pXn"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_varTypeName_Prefix_Basic

std::string PanTau::Tool_DecayModeDeterminator::m_varTypeName_Prefix_Basic

private

Definition at line 65 of file Tool_DecayModeDeterminator.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:

• Tool_DecayModeDeterminator.h
• Tool_DecayModeDeterminator.cxx