ATLAS Offline Software
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
PanTau::Tool_InformationStore Class Reference

#include <Tool_InformationStore.h>

Inheritance diagram for PanTau::Tool_InformationStore:
Collaboration diagram for PanTau::Tool_InformationStore:

Public Types

typedef std::map< std::string, std::string > MapString
 
typedef std::map< std::string, std::vector< std::string > > MapVecString
 
typedef std::map< std::string, int > MapInt
 
typedef std::map< std::string, double > MapDouble
 
typedef std::map< std::string, std::vector< double > > MapVecDouble
 

Public Member Functions

 Tool_InformationStore (const std::string &name)
 
virtual ~Tool_InformationStore ()
 
virtual void ABRDefaultInit ()
 
virtual StatusCode initialize ()
 Dummy implementation of the initialisation function. More...
 
virtual StatusCode getInfo_Int (const std::string &varName, int &value) const
 
virtual StatusCode getInfo_Double (const std::string &varName, double &value) const
 
virtual StatusCode getInfo_VecDouble (const std::string &varName, std::vector< double > &value) const
 
virtual StatusCode getInfo_String (const std::string &varName, std::string &value) const
 
virtual StatusCode getInfo_VecString (const std::string &varName, std::vector< std::string > &value) const
 
bool isInitialized ()
 
virtual void print () const
 Print the state of the tool. More...
 
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & evtStore () const
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
 
virtual StatusCode sysInitialize () override
 Perform system initialization for an algorithm. More...
 
virtual StatusCode sysStart () override
 Handle START transition. More...
 
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles. More...
 
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles. More...
 
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T > &t)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc="none")
 Declare a new Gaudi property. More...
 
void updateVHKA (Gaudi::Details::PropertyBase &)
 
MsgStream & msg () const
 
MsgStream & msg (const MSG::Level lvl) const
 
bool msgLvl (const MSG::Level lvl) const
 

Protected Member Functions

void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution More...
 
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. More...
 

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
 specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
 specialization for handling Gaudi::Property<SG::VarHandleBase> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
 specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
 

Private Attributes

MapString m_Infos_String
 named strings, ints etc... for configuration More...
 
MapVecString m_Infos_VecString
 
MapInt m_Infos_Int
 
MapDouble m_Infos_Double
 
MapVecDouble m_Infos_VecDouble
 
std::string m_Name_Container_eflowRec
 other information More...
 
std::string m_Name_Container_TauRec
 
std::string m_Name_Container_Tracks
 
bool m_init =false
 
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default) More...
 
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default) More...
 
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 25 of file Tool_InformationStore.h.

Member Typedef Documentation

◆ MapDouble

typedef std::map<std::string, double> PanTau::ITool_InformationStore::MapDouble
inherited

Definition at line 32 of file ITool_InformationStore.h.

◆ MapInt

typedef std::map<std::string, int> PanTau::ITool_InformationStore::MapInt
inherited

Definition at line 31 of file ITool_InformationStore.h.

◆ MapString

typedef std::map<std::string, std::string> PanTau::ITool_InformationStore::MapString
inherited

Definition at line 29 of file ITool_InformationStore.h.

◆ MapVecDouble

typedef std::map<std::string, std::vector<double> > PanTau::ITool_InformationStore::MapVecDouble
inherited

Definition at line 33 of file ITool_InformationStore.h.

◆ MapVecString

typedef std::map<std::string, std::vector<std::string> > PanTau::ITool_InformationStore::MapVecString
inherited

Definition at line 30 of file ITool_InformationStore.h.

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ Tool_InformationStore()

PanTau::Tool_InformationStore::Tool_InformationStore ( const std::string &  name)

Definition at line 126 of file Tool_InformationStore.cxx.

126  :
128 {
129  declareProperty("Infos_String", m_Infos_String, "Map with string type infos");
130  declareProperty("Infos_VecString", m_Infos_VecString, "Map with vector<string> type infos");
131  declareProperty("Infos_Int", m_Infos_Int, "Map with int type infos");
132  declareProperty("Infos_Double", m_Infos_Double, "Map with double type infos");
133  declareProperty("Infos_VecDouble", m_Infos_VecDouble, "Map with double type infos");
134 }

◆ ~Tool_InformationStore()

PanTau::Tool_InformationStore::~Tool_InformationStore ( )
virtualdefault

Member Function Documentation

◆ ABRDefaultInit()

void PanTau::Tool_InformationStore::ABRDefaultInit ( )
virtual

Definition at line 9 of file Tool_InformationStore.cxx.

9  {
10 #ifdef XAOD_ANALYSIS
11 
12  // Boolean values
13  MapInt m01 = {
14  {"UseDefaultCellBasedConfig",1},//is this one necessary
15  {"TauConstituents_UsePionMass",1},
16  {"FeatureExtractor_UseEmptySeeds",0},
17  {"TauConstituents_eflowRec_UseMomentumAsEnergy",0},
18  {"TauConstituents_UseShrinkingCone",0}
19  };
20  setMapInt(m01);
21 
22  // double values
23  MapDouble m02 = {
24  {"eflowRec_Assoc_DeltaR",0.4},
25  {"TauConstituents_Types_DeltaRCore",0.2},
26  {"TauConstituents_MaxEta",9.9},
27  {"TauConstituents_PreselectionMinEnergy",500.},
28  {"TauConstituents_eflowRec_BDTThreshold_Pi0Neut",-0.04},
29  // PanTau BDT Cut values --- CellBased
30  {"DecayModeDeterminator_BDTCutValue_R10X_CellBased",0.52},
31  {"DecayModeDeterminator_BDTCutValue_R11X_CellBased",-0.33},
32  {"DecayModeDeterminator_BDTCutValue_R110_CellBased",0.47},
33  {"DecayModeDeterminator_BDTCutValue_R1XX_CellBased",-0.21},
34  {"DecayModeDeterminator_BDTCutValue_R30X_CellBased",-0.13},
35  {"DecayModeDeterminator_BDTCutValue_R3XX_CellBased",-0.08},
36  // PanTau BDT Cut values --- eflowRec
37  {"DecayModeDeterminator_BDTCutValue_R10X_eflowRec",-0.15},
38  {"DecayModeDeterminator_BDTCutValue_R11X_eflowRec",-0.60},
39  {"DecayModeDeterminator_BDTCutValue_R110_eflowRec",-0.08},
40  {"DecayModeDeterminator_BDTCutValue_R1XX_eflowRec",0.03},
41  {"DecayModeDeterminator_BDTCutValue_R30X_eflowRec",-0.25},
42  {"DecayModeDeterminator_BDTCutValue_R3XX_eflowRec",-0.23}
43  };
44 
45  setMapDouble(m02);
46 
47  // String values
48  MapString m03 = {
49  {"Name_TauRecContainer","TauJets"},
50  {"Name_eflowRecContainer","eflowObjects_tauMode"},
51  {"Name_TrackParticleContainer","TrackParticleCandidate"},
52  {"Name_PanTauSeedsContainer","PanTau_OutputSeeds"},
53  {"ModeDiscriminator_ReaderOption","!Color:Silent"},
54  {"ModeDiscriminator_TMVAMethod","BDTG"},
55  {"FeatureExtractor_VarTypeName_varTypeName_Sum", "Sum"},
56  {"FeatureExtractor_VarTypeName_varTypeName_Ratio", "Ratio"},
57  {"FeatureExtractor_VarTypeName_varTypeName_EtInRing", "EtInRing"},
58  {"FeatureExtractor_VarTypeName_varTypeName_Isolation", "Isolation"},
59  {"FeatureExtractor_VarTypeName_varTypeName_Num", "Num"},
60  {"FeatureExtractor_VarTypeName_varTypeName_Mean", "Mean"},
61  {"FeatureExtractor_VarTypeName_varTypeName_StdDev", "StdDev"},
62  {"FeatureExtractor_VarTypeName_varTypeName_HLV", "HLV"},
63  {"FeatureExtractor_VarTypeName_varTypeName_Angle", "Angle"},
64  {"FeatureExtractor_VarTypeName_varTypeName_DeltaR", "DeltaR"},
65  {"FeatureExtractor_VarTypeName_varTypeName_JetMoment", "JetMoment"},
66  {"FeatureExtractor_VarTypeName_varTypeName_Combined", "Combined"},
67  {"FeatureExtractor_VarTypeName_varTypeName_JetShape", "JetShape"},
68  {"FeatureExtractor_VarTypeName_varTypeName_ImpactParams", "ImpactParams"},
69  {"FeatureExtractor_VarTypeName_varTypeName_Basic", "Basic"},
70  {"FeatureExtractor_VarTypeName_varTypeName_PID", "PID"},
71  {"FeatureExtractor_VarTypeName_varTypeName_Shots", "Shots"},
72  };
73  setMapString(m03);
74 
75  // vector<double> values
76  // In Config_PanTau.py, this was called "vector<float> values". This was changed to "double".
77  // The "Units.GeV" (import AthenaCommon.SystemOfUnits as Units) was now replaced by "GeV" (#include "CLHEP/Units/SystemOfUnits.h", using CLHEP::GeV)
78  MapVecDouble m04 = {
79  {"TauConstituents_BinEdges_Eta",{0.000, 0.800, 1.400, 1.500, 1.900, 9.900}},
80  {"TauConstituents_Selection_Neutral_EtaBinned_EtCut",{2.1*GeV, 2.5*GeV, 2.6*GeV, 2.4*GeV, 1.9*GeV}},
81  {"TauConstituents_Selection_Pi0Neut_EtaBinned_EtCut",{2.1*GeV, 2.5*GeV, 2.6*GeV, 2.4*GeV, 1.9*GeV}},
82  {"TauConstituents_Selection_Charged_EtaBinned_EtCut",{1.0*GeV, 1.0*GeV, 1.0*GeV, 1.0*GeV, 1.0*GeV}},
83  {"TauConstituents_Selection_OutNeut_EtaBinned_EtCut",{1.0*GeV, 1.0*GeV, 1.0*GeV, 1.0*GeV, 1.0*GeV}},
84  {"TauConstituents_Selection_OutChrg_EtaBinned_EtCut",{1.0*GeV, 1.0*GeV, 1.0*GeV, 1.0*GeV, 1.0*GeV}},
85  {"TauConstituents_Selection_NeutLowA_EtaBinned_EtCut",{1.85*GeV, 2.25*GeV, 2.35*GeV, 2.15*GeV, 1.65*GeV}},
86  {"TauConstituents_Selection_NeutLowB_EtaBinned_EtCut",{1.6*GeV, 2.0*GeV, 2.1*GeV, 1.9*GeV, 1.4*GeV}},
87  {"eflowRec_Selection_Pi0Neut_EtaBinned_EtCut_1prong",{2.5*GeV, 2.5*GeV, 1.9*GeV, 2.5*GeV, 2.3*GeV}},
88  {"eflowRec_Selection_Pi0Neut_EtaBinned_EtCut_3prong",{2.5*GeV, 2.5*GeV, 2.5*GeV, 2.5*GeV, 2.5*GeV}},
89  // Eta Binned P I 0 - B D T C U T S
90  {"CellBased_BinEdges_Eta",{0.000, 0.800, 1.400, 1.500, 1.900, 9.900}},
91  {"CellBased_EtaBinned_Pi0MVACut_1prong",{0.46, 0.39, 0.51, 0.47, 0.54}},
92  {"CellBased_EtaBinned_Pi0MVACut_3prong",{0.47, 0.52, 0.60, 0.55, 0.50}},
93  {"eflowRec_BinEdges_Eta",{0.000, 0.800, 1.400, 1.500, 1.900, 9.900}},
94  {"eflowRec_EtaBinned_Pi0MVACut_1prong",{0.09, 0.09, 0.09, 0.08, 0.05}},
95  {"eflowRec_EtaBinned_Pi0MVACut_3prong",{0.09, 0.09, 0.09, 0.09, 0.07}},
96  // P T B I N S
97  {"ModeDiscriminator_BinEdges_Pt",{10*GeV, 100000*GeV}},
98  {"ModeDiscriminator_BDTVariableDefaults_CellBased_1p0n_vs_1p1n", {-9.0, -0.2, -10.0, -0.2, -2.0}},
99  {"ModeDiscriminator_BDTVariableDefaults_CellBased_1p1n_vs_1pXn", {-9.0, -200.0, -0.2, -5.0, -2.0}},
100  {"ModeDiscriminator_BDTVariableDefaults_CellBased_3p0n_vs_3pXn", {-0.2, -9.0, -0.2, -2.0, -200.0}},
101  };
102  setMapVecDouble(m04);
103 
104  // vector<string> values
105  MapVecString m05 = {
106  {"Names_InputAlgorithms",{"CellBased"}},
107  {"Names_ModeCases",{"1p0n_vs_1p1n","1p1n_vs_1pXn","3p0n_vs_3pXn"}},
108  // ---> eflowRec BDT variables
109  {"ModeDiscriminator_BDTVariableNames_eflowRec_1p0n_vs_1p1n",{"Charged_Ratio_EtOverEtAllConsts","Basic_NPi0NeutConsts","Neutral_PID_BDTValues_EtSort_1","Combined_DeltaR1stNeutralTo1stCharged"}},
110  {"ModeDiscriminator_BDTVariableNames_eflowRec_1p1n_vs_1pXn",{"Neutral_PID_BDTValues_BDTSort_2","Neutral_Ratio_EtOverEtAllConsts","Basic_NNeutralConsts","Neutral_HLV_SumM"}},
111  {"ModeDiscriminator_BDTVariableNames_eflowRec_3p0n_vs_3pXn",{"Basic_NPi0NeutConsts","Neutral_PID_BDTValues_BDTSort_1","Charged_HLV_SumPt","Charged_Ratio_EtOverEtAllConsts","Neutral_Mean_DRToLeading_WrtEtAllConsts"}},
112  // ---> CellBased BDT variables
113  {"ModeDiscriminator_BDTVariableNames_CellBased_1p0n_vs_1p1n",{"Neutral_PID_BDTValues_BDTSort_1","Neutral_Ratio_1stBDTEtOverEtAllConsts","Combined_DeltaR1stNeutralTo1stCharged","Charged_JetMoment_EtDRxTotalEt","Neutral_Shots_NPhotonsInSeed"}},
114  {"ModeDiscriminator_BDTVariableNames_CellBased_1p1n_vs_1pXn",{"Neutral_PID_BDTValues_BDTSort_2","Neutral_HLV_SumM","Neutral_Ratio_EtOverEtAllConsts","Basic_NNeutralConsts","Neutral_Shots_NPhotonsInSeed"}},
115  {"ModeDiscriminator_BDTVariableNames_CellBased_3p0n_vs_3pXn",{"Neutral_Ratio_EtOverEtAllConsts","Neutral_PID_BDTValues_BDTSort_1","Charged_StdDev_Et_WrtEtAllConsts","Neutral_Shots_NPhotonsInSeed","Charged_HLV_SumM"}},
116  {"ModeDiscriminator_BDTVariableTypes_CellBased_1p0n_vs_1p1n", {"F","F","F","F","F"}},
117  {"ModeDiscriminator_BDTVariableTypes_CellBased_1p1n_vs_1pXn", {"F","F","F","F","F"}},
118  {"ModeDiscriminator_BDTVariableTypes_CellBased_3p0n_vs_3pXn", {"F","F","F","F","F"}},
119  };
120  setMapVecString(m05);
121 
122 #endif
123 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

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

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

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t,
const SG::NotHandleType  
)
inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleBase hndl,
const std::string &  doc,
const SG::VarHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKey hndl,
const std::string &  doc,
const SG::VarHandleKeyType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKeyArray hndArr,
const std::string &  doc,
const SG::VarHandleKeyArrayType  
)
inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc,
const SG::NotHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc = "none" 
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

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

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

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

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

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

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

Definition at line 90 of file AthCommonDataStore.h.

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

◆ getInfo_Double()

StatusCode PanTau::Tool_InformationStore::getInfo_Double ( const std::string &  varName,
double &  value 
) const
virtual

Implements PanTau::ITool_InformationStore.

Definition at line 161 of file Tool_InformationStore.cxx.

161  {
162  MapDouble::const_iterator it = m_Infos_Double.find(varName);
163  if(it == m_Infos_Double.end()) {
164  ATH_MSG_ERROR("getInfo_Double: No double information called " << varName << " present in InformationStore");
165  return StatusCode::FAILURE;
166  }
167  value = it->second;
168  return StatusCode::SUCCESS;
169 }

◆ getInfo_Int()

StatusCode PanTau::Tool_InformationStore::getInfo_Int ( const std::string &  varName,
int &  value 
) const
virtual

Implements PanTau::ITool_InformationStore.

Definition at line 151 of file Tool_InformationStore.cxx.

151  {
152  MapInt::const_iterator it = m_Infos_Int.find(varName);
153  if(it == m_Infos_Int.end()) {
154  ATH_MSG_ERROR("getInfo_Int: No integer information called " << varName << " present in InformationStore");
155  return StatusCode::FAILURE;
156  }
157  value = it->second;
158  return StatusCode::SUCCESS;
159 }

◆ getInfo_String()

StatusCode PanTau::Tool_InformationStore::getInfo_String ( const std::string &  varName,
std::string &  value 
) const
virtual

Implements PanTau::ITool_InformationStore.

Definition at line 181 of file Tool_InformationStore.cxx.

181  {
182  MapString::const_iterator it = m_Infos_String.find(varName);
183  if(it == m_Infos_String.end()) {
184  ATH_MSG_ERROR("getInfo_String: No string information called " << varName << " present in InformationStore");
185  return StatusCode::FAILURE;
186  }
187  value = it->second;
188  return StatusCode::SUCCESS;
189 }

◆ getInfo_VecDouble()

StatusCode PanTau::Tool_InformationStore::getInfo_VecDouble ( const std::string &  varName,
std::vector< double > &  value 
) const
virtual

Implements PanTau::ITool_InformationStore.

Definition at line 171 of file Tool_InformationStore.cxx.

171  {
172  MapVecDouble::const_iterator it = m_Infos_VecDouble.find(varName);
173  if(it == m_Infos_VecDouble.end()) {
174  ATH_MSG_ERROR("getInfo_VecDouble: No double information called " << varName << " present in InformationStore");
175  return StatusCode::FAILURE;
176  }
177  value = it->second;
178  return StatusCode::SUCCESS;
179 }

◆ getInfo_VecString()

StatusCode PanTau::Tool_InformationStore::getInfo_VecString ( const std::string &  varName,
std::vector< std::string > &  value 
) const
virtual

Implements PanTau::ITool_InformationStore.

Definition at line 191 of file Tool_InformationStore.cxx.

191  {
192  MapVecString::const_iterator it = m_Infos_VecString.find(varName);
193  if(it == m_Infos_VecString.end()) {
194  ATH_MSG_ERROR("getInfo_VecString: No std::string information called " << varName << " present in InformationStore");
195  return StatusCode::FAILURE;
196  }
197  value = it->second;
198  return StatusCode::SUCCESS;
199 }

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

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

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

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

◆ 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_InformationStore::initialize ( )
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 138 of file Tool_InformationStore.cxx.

138  {
139  ATH_MSG_INFO( name() << " initialize()" );
140  m_init=true;
141 
142  //This function does nothing in athena
143  ABRDefaultInit();
144 
145  ATH_CHECK( this->getInfo_String("Name_TauRecContainer", m_Name_Container_TauRec) );
146  ATH_CHECK( this->getInfo_String("Name_TrackParticleContainer", m_Name_Container_Tracks) );
147 
148  return StatusCode::SUCCESS;
149 }

◆ 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_InformationStore::isInitialized ( )
inlinevirtual

Implements PanTau::ITool_InformationStore.

Definition at line 70 of file Tool_InformationStore.h.

70 {return m_init;}

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

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

101  {
102 
103  return MSG::name( msg().level() );
104  }

◆ msgLvl()

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

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

◆ 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

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

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

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

364  {
365  handlesArray.renounce();
366  }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

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_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_Infos_Double

MapDouble PanTau::Tool_InformationStore::m_Infos_Double
private

Definition at line 58 of file Tool_InformationStore.h.

◆ m_Infos_Int

MapInt PanTau::Tool_InformationStore::m_Infos_Int
private

Definition at line 57 of file Tool_InformationStore.h.

◆ m_Infos_String

MapString PanTau::Tool_InformationStore::m_Infos_String
private

named strings, ints etc... for configuration

Definition at line 55 of file Tool_InformationStore.h.

◆ m_Infos_VecDouble

MapVecDouble PanTau::Tool_InformationStore::m_Infos_VecDouble
private

Definition at line 59 of file Tool_InformationStore.h.

◆ m_Infos_VecString

MapVecString PanTau::Tool_InformationStore::m_Infos_VecString
private

Definition at line 56 of file Tool_InformationStore.h.

◆ m_init

bool PanTau::Tool_InformationStore::m_init =false
private

Definition at line 67 of file Tool_InformationStore.h.

◆ m_Name_Container_eflowRec

std::string PanTau::Tool_InformationStore::m_Name_Container_eflowRec
private

other information

Definition at line 63 of file Tool_InformationStore.h.

◆ m_Name_Container_TauRec

std::string PanTau::Tool_InformationStore::m_Name_Container_TauRec
private

Definition at line 64 of file Tool_InformationStore.h.

◆ m_Name_Container_Tracks

std::string PanTau::Tool_InformationStore::m_Name_Container_Tracks
private

Definition at line 65 of file Tool_InformationStore.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:
asg::AsgTool
Base class for the dual-use tool implementation classes.
Definition: AsgTool.h:47
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
PanTau::ITool_InformationStore::MapString
std::map< std::string, std::string > MapString
Definition: ITool_InformationStore.h:29
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
PanTau::ITool_InformationStore::MapVecDouble
std::map< std::string, std::vector< double > > MapVecDouble
Definition: ITool_InformationStore.h:33
PanTau::ITool_InformationStore::MapInt
std::map< std::string, int > MapInt
Definition: ITool_InformationStore.h:31
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
PanTau::Tool_InformationStore::m_Infos_VecString
MapVecString m_Infos_VecString
Definition: Tool_InformationStore.h:56
PanTau::Tool_InformationStore::m_Infos_String
MapString m_Infos_String
named strings, ints etc... for configuration
Definition: Tool_InformationStore.h:55
skel.it
it
Definition: skel.GENtoEVGEN.py:396
PanTau::Tool_InformationStore::m_init
bool m_init
Definition: Tool_InformationStore.h:67
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
athena.value
value
Definition: athena.py:124
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
dbg::ptr
void * ptr(T *p)
Definition: SGImplSvc.cxx:74
PanTau::ITool_InformationStore::MapVecString
std::map< std::string, std::vector< std::string > > MapVecString
Definition: ITool_InformationStore.h:30
PanTau::Tool_InformationStore::m_Name_Container_Tracks
std::string m_Name_Container_Tracks
Definition: Tool_InformationStore.h:65
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
PixelAthClusterMonAlgCfg.varName
string varName
end cluster ToT and charge
Definition: PixelAthClusterMonAlgCfg.py:125
PanTau::Tool_InformationStore::m_Infos_Int
MapInt m_Infos_Int
Definition: Tool_InformationStore.h:57
python.xAODType.dummy
dummy
Definition: xAODType.py:4
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
PanTau::Tool_InformationStore::getInfo_String
virtual StatusCode getInfo_String(const std::string &varName, std::string &value) const
Definition: Tool_InformationStore.cxx:181
GeV
#define GeV
Definition: Tool_InformationStore.cxx:7
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
PanTau::Tool_InformationStore::ABRDefaultInit
virtual void ABRDefaultInit()
Definition: Tool_InformationStore.cxx:9
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
a
TList * a
Definition: liststreamerinfos.cxx:10
h
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:623
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
PanTau::Tool_InformationStore::m_Infos_VecDouble
MapVecDouble m_Infos_VecDouble
Definition: Tool_InformationStore.h:59
PanTau::Tool_InformationStore::m_Name_Container_TauRec
std::string m_Name_Container_TauRec
Definition: Tool_InformationStore.h:64
SG::DataProxy
Definition: DataProxy.h:45
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
PanTau::ITool_InformationStore::MapDouble
std::map< std::string, double > MapDouble
Definition: ITool_InformationStore.h:32
fitman.k
k
Definition: fitman.py:528
PanTau::Tool_InformationStore::m_Infos_Double
MapDouble m_Infos_Double
Definition: Tool_InformationStore.h:58