ATLAS Offline Software
Loading...
Searching...
No Matches
TauElectronVetoVariables Class Reference

Calculate variables sensitive on electrons. More...

#include <TauElectronVetoVariables.h>

Inheritance diagram for TauElectronVetoVariables:
Collaboration diagram for TauElectronVetoVariables:

Public Member Functions

 TauElectronVetoVariables (const std::string &name)
virtual ~TauElectronVetoVariables ()=default
virtual StatusCode initialize () override
 Tool initializer.
virtual StatusCode execute (xAOD::TauJet &pTau) const override
 Execute - called for each tau candidate.
virtual StatusCode eventInitialize () override
 Event initializer - called at the beginning of each event.
virtual StatusCode executePi0CreateROI (xAOD::TauJet &pTau, CaloConstCellContainer &caloCellContainer, boost::dynamic_bitset<> &map) const override
virtual StatusCode executeVertexFinder (xAOD::TauJet &pTau, const xAOD::VertexContainer *vertexContainer=nullptr) const override
virtual StatusCode executeTrackFinder (xAOD::TauJet &pTau, xAOD::TauTrackContainer &tauTrackContainer) const override
virtual StatusCode executeTrackClassifier (xAOD::TauJet &pTau, xAOD::TauTrackContainer &tauTrackContainer) const override
virtual StatusCode executeShotFinder (xAOD::TauJet &pTau, xAOD::CaloClusterContainer &shotClusterContainer, xAOD::PFOContainer &PFOContainer) const override
virtual StatusCode executePi0ClusterCreator (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer, xAOD::PFOContainer &hadronicPFOContainer, const xAOD::CaloClusterContainer &pCaloClusterContainer) const override
virtual StatusCode executeVertexVariables (xAOD::TauJet &pTau, xAOD::VertexContainer &vertexContainer) const override
virtual StatusCode executePi0ClusterScaler (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer, xAOD::PFOContainer &chargedPFOContainer) const override
virtual StatusCode executePi0nPFO (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer) const override
virtual StatusCode executePanTau (xAOD::TauJet &pTau, xAOD::ParticleContainer &particleContainer, xAOD::PFOContainer &neutralPFOContainer) const override
virtual StatusCode eventFinalize () override
 Event finalizer - called at the end of each event.
virtual StatusCode finalize () override
 Finalizer.
std::string find_file (const std::string &fname) const
virtual StatusCode readConfig () override
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

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

Protected Attributes

Gaudi::Property< bool > m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}
Gaudi::Property< bool > m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}
Gaudi::Property< bool > m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}
Gaudi::Property< std::string > m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_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

Gaudi::Property< bool > m_doVertexCorrection {this, "VertexCorrection", true, "switch of vertex correction"}
Gaudi::Property< bool > m_useOldCalo {this,"useOldCalo",false,"If true, it uses the CaloExtensionTool for calculating track extrapolation. Otherwise, it allows the code to read from the cache created by CaloExtensionBuilderalg."}
ToolHandle< Trk::IParticleCaloExtensionToolm_caloExtensionTool
SG::ReadHandleKey< CaloExtensionCollectionm_ParticleCacheKey
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

Calculate variables sensitive on electrons.

The variables are mainly used by the electron veto in the TauDiscriminant package.

Author
Zofia Czyczula

Definition at line 27 of file TauElectronVetoVariables.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

◆ TauElectronVetoVariables()

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

Definition at line 24 of file TauElectronVetoVariables.cxx.

24 :
25TauRecToolBase(name) {}
TauRecToolBase(const std::string &name)

◆ ~TauElectronVetoVariables()

virtual TauElectronVetoVariables::~TauElectronVetoVariables ( )
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.

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

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

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

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

◆ eventFinalize()

StatusCode TauRecToolBase::eventFinalize ( )
overridevirtualinherited

Event finalizer - called at the end of each event.

Implements ITauToolBase.

Definition at line 202 of file TauRecToolBase.cxx.

202 {
203 return StatusCode::SUCCESS;
204}

◆ eventInitialize()

StatusCode TauRecToolBase::eventInitialize ( )
overridevirtualinherited

Event initializer - called at the beginning of each event.

Implements ITauToolBase.

Definition at line 133 of file TauRecToolBase.cxx.

133 {
134 return StatusCode::SUCCESS;
135}

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

◆ execute()

StatusCode TauElectronVetoVariables::execute ( xAOD::TauJet & pTau) const
overridevirtual

Execute - called for each tau candidate.

Reimplemented from TauRecToolBase.

Definition at line 39 of file TauElectronVetoVariables.cxx.

39 {
40 if (pTau.nTracks() < 1) {
41 return StatusCode::SUCCESS;
42 }
43 ATH_MSG_DEBUG("in execute()");
44 float detPhiTrk = 0.;
45 float detEtaTrk = 0.;
46 float sumETCellsLAr = 0.;
47 float eta0cut = 0.075;
48 float eta1cut = 0.0475;
49 float eta2cut = 0.075;
50 float eta3cut = 1.5;
51 float phi0cut = 0.3;
52 float phi1cut = 0.3;
53 float phi2cut = 0.075;
54 float phi3cut = 0.075;
55 const CaloCell *pCell;
56 int trackIndex = -1;
57
58 //---------------------------------------------------------------------
59 // Calculate eta, phi impact point of leading track at calorimeter layers EM 0,1,2,3
60 //---------------------------------------------------------------------
61 Trk::TrackParametersIdHelper parsIdHelper;
62 constexpr size_t numberOfEM_Layers{4};
63 constexpr double invalidCoordinate{-11111.};
64 constexpr double invalidCoordinateThreshold{-11110.};
65 std::array<double, numberOfEM_Layers> extrapolatedEta{};
66 std::array<double, numberOfEM_Layers> extrapolatedPhi{};
67 extrapolatedEta.fill(invalidCoordinate);
68 extrapolatedPhi.fill(invalidCoordinate);
69
70 /*get the CaloExtension object*/
71 const Trk::CaloExtension * caloExtension = nullptr;
72 std::unique_ptr<Trk::CaloExtension> uniqueExtension ;
73 const xAOD::TrackParticle *orgTrack = pTau.track(0)->track();
74 trackIndex = orgTrack->index();
75 if (m_useOldCalo) {
76 /* If CaloExtensionBuilder is unavailable, use the calo extension tool */
77 ATH_MSG_VERBOSE("Using the CaloExtensionTool");
78 uniqueExtension = m_caloExtensionTool->caloExtension(
79 Gaudi::Hive::currentContext(), *orgTrack);
80 caloExtension = uniqueExtension.get();
81 } else {
82 /*get the CaloExtension object*/
83 ATH_MSG_VERBOSE("Using the CaloExtensionBuilder Cache");
84 SG::ReadHandle<CaloExtensionCollection> particleCache {m_ParticleCacheKey};
85 caloExtension = (*particleCache)[trackIndex];
86 ATH_MSG_VERBOSE("Getting element " << trackIndex << " from the particleCache");
87 if( not caloExtension ){
88 ATH_MSG_VERBOSE("Cache does not contain a calo extension -> Calculating with the a CaloExtensionTool" );
89 uniqueExtension = m_caloExtensionTool->caloExtension(
90 Gaudi::Hive::currentContext(), *orgTrack);
91 caloExtension = uniqueExtension.get();
92 }
93 }
94 if( not caloExtension){
95 ATH_MSG_DEBUG("extrapolation of leading track to calo surfaces failed : caloExtension is nullptr" );
96 return StatusCode::RECOVERABLE;
97 }
98 const std::vector<Trk::CurvilinearParameters>& clParametersVector = caloExtension->caloLayerIntersections();
99 if(clParametersVector.empty() ){
100 ATH_MSG_DEBUG("extrapolation of leading track to calo surfaces failed : caloLayerIntersection is empty" );
101 return StatusCode::RECOVERABLE;
102 }
103 // loop over calo layers
104 for( const Trk::CurvilinearParameters& cur : clParametersVector ){
105 // only use entry layer
106 if( !parsIdHelper.isEntryToVolume(cur.cIdentifier()) ) continue;
107 CaloSampling::CaloSample sample = parsIdHelper.caloSample(cur.cIdentifier());
108 int index = -1;
109 if( sample == CaloSampling::PreSamplerE || sample == CaloSampling::PreSamplerB ) index = 0;
110 else if( sample == CaloSampling::EME1 || sample == CaloSampling::EMB1 ) index = 1;
111 else if( sample == CaloSampling::EME2 || sample == CaloSampling::EMB2 ) index = 2;
112 else if( sample == CaloSampling::EME3 || sample == CaloSampling::EMB3 ) index = 3;
113 if( index < 0 ) continue;
114 extrapolatedEta[index] = cur.position().eta();
115 extrapolatedPhi[index] = cur.position().phi();
116 }
117 for (size_t i = 0; i < numberOfEM_Layers; ++i) {
118 if ( extrapolatedEta[i] < invalidCoordinateThreshold || extrapolatedPhi[i] < invalidCoordinateThreshold ){
119 ATH_MSG_DEBUG("extrapolation of leading track to calo surfaces failed for sampling : " << i );
120 return StatusCode::SUCCESS;
121 }
122 }
123
124 // Loop through jets, get links to clusters
125 std::bitset<200000> cellSeen{};
126 const std::unordered_map<int, int> samplingLookup{
127 {4,0}, {5,1}, {6,2}, {7,3}, {8,12},
128 {15, 12}, {16,13}, {17,14}, {18,12}, {19, 13}, {20,14}
129 };
130 const auto notFound{samplingLookup.end()};
131
132 std::vector<xAOD::CaloVertexedTopoCluster> vertexedClusterList = pTau.vertexedClusters();
133 for (const xAOD::CaloVertexedTopoCluster& vertexedCluster : vertexedClusterList){
134
135 const xAOD::CaloCluster& cluster = vertexedCluster.clust();
136 auto cell_links = cluster.getCellLinks();
137 if (cell_links == nullptr) {
138 ATH_MSG_DEBUG("NO Cell links found for cluster with pT " << cluster.pt());
139 continue;
140 }
141 CaloClusterCellLink::const_iterator pCellIter = cluster.getCellLinks()->begin();
142 CaloClusterCellLink::const_iterator pCellIterE = cluster.getCellLinks()->end();
143 for (; pCellIter != pCellIterE; ++pCellIter) {
144 double cellEta{}, cellPhi{}, cellET{};
145 pCell = *pCellIter;
146 if (cellSeen.test(pCell->caloDDE()->calo_hash())) continue;
147 else cellSeen.set(pCell->caloDDE()->calo_hash());
148 if (m_doVertexCorrection && pTau.vertex()!=nullptr) {
149 CaloVertexedCell vxCell (*pCell, pTau.vertex()->position());
150 cellPhi = vxCell.phi();
151 cellEta = vxCell.eta();
152 cellET = vxCell.et();
153 } else {
154 cellPhi = pCell->phi();
155 cellEta = pCell->eta();
156 cellET = pCell->et();
157 }
158 int sampling = pCell->caloDDE()->getSampling();
159 if (const auto & pElement {samplingLookup.find(sampling)};pElement != notFound){
160 sampling = pElement->second;
161 }
162 int i = 2;
163 if (sampling < 4) i = sampling;
164 if (sampling == 12 || sampling == 13 || sampling == 14) i = 3;
165 detPhiTrk = TVector2::Phi_mpi_pi(cellPhi-extrapolatedPhi[i]);
166 detEtaTrk = std::abs( cellEta - extrapolatedEta[i] );
167 if ((sampling == 0 && detEtaTrk < eta0cut && detPhiTrk < phi0cut) ||
168 (sampling == 1 && detEtaTrk < eta1cut && detPhiTrk < phi1cut) ||
169 (sampling == 2 && detEtaTrk < eta2cut && detPhiTrk < phi2cut) ||
170 (sampling == 3 && detEtaTrk < eta3cut && detPhiTrk < phi3cut)) {
171 sumETCellsLAr += cellET;
172 }
173 } //end cell loop
174 }// end jet constituent loop
175
176 pTau.setDetail(xAOD::TauJetParameters::sumEMCellEtOverLeadTrkPt , static_cast<float>( ( sumETCellsLAr / ( pTau.track(0)->pt() ) ) ) );
177 return StatusCode::SUCCESS;
178}
#define ATH_MSG_VERBOSE(x)
#define ATH_MSG_DEBUG(x)
virtual double phi() const override final
get phi (through CaloDetDescrElement)
Definition CaloCell.h:375
const CaloDetDescrElement * caloDDE() const
get pointer to CaloDetDescrElement (data member)
Definition CaloCell.h:321
virtual double eta() const override final
get eta (through CaloDetDescrElement)
Definition CaloCell.h:382
virtual double et() const override final
get et
Definition CaloCell.h:423
CaloCell_ID::CaloSample getSampling() const
cell sampling
size_t index() const
Return the index of this element within its container.
SG::ReadHandleKey< CaloExtensionCollection > m_ParticleCacheKey
Gaudi::Property< bool > m_useOldCalo
ToolHandle< Trk::IParticleCaloExtensionTool > m_caloExtensionTool
Gaudi::Property< bool > m_doVertexCorrection
bool isEntryToVolume(TrackParametersIdentifier id) const
returns true if the id belongs to the volume entrance
CaloSampling::CaloSample caloSample(TrackParametersIdentifier id) const
CaloSample encoded in id, returns CaloSampling::Unknown if id is not valid.
const CaloClusterCellLink * getCellLinks() const
Get a pointer to the CaloClusterCellLink object (const version)
virtual double pt() const
The transverse momentum ( ) of the particle (negative for negative-energy clusters)
std::vector< xAOD::CaloVertexedTopoCluster > vertexedClusters() const
const TauTrack * track(size_t i, TauJetParameters::TauTrackFlag flag=TauJetParameters::TauTrackFlag::classifiedCharged, int *container_index=0) const
Get the pointer to a given tauTrack associated with this tau /*container index needed by trackNonCons...
void setDetail(TauJetParameters::Detail detail, int value)
const Vertex * vertex() const
size_t nTracks(TauJetParameters::TauTrackFlag flag=TauJetParameters::TauTrackFlag::classifiedCharged) const
virtual double pt() const
The transverse momentum ( ) of the particle.
const TrackParticle * track() const
const Amg::Vector3D & position() const
Returns the 3-pos.
str index
Definition DeMoScan.py:362
CurvilinearParametersT< TrackParametersDim, Charged, PlaneSurface > CurvilinearParameters
CaloCluster_v1 CaloCluster
Define the latest version of the calorimeter cluster class.
TrackParticle_v1 TrackParticle
Reference the current persistent version:

◆ executePanTau()

StatusCode TauRecToolBase::executePanTau ( xAOD::TauJet & pTau,
xAOD::ParticleContainer & particleContainer,
xAOD::PFOContainer & neutralPFOContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in PanTau::PanTauProcessor.

Definition at line 197 of file TauRecToolBase.cxx.

197 {
198 ATH_MSG_ERROR("function not implemented");
199 return StatusCode::FAILURE;
200}
#define ATH_MSG_ERROR(x)

◆ executePi0ClusterCreator()

StatusCode TauRecToolBase::executePi0ClusterCreator ( xAOD::TauJet & pTau,
xAOD::PFOContainer & neutralPFOContainer,
xAOD::PFOContainer & hadronicPFOContainer,
const xAOD::CaloClusterContainer & pCaloClusterContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauPi0ClusterCreator.

Definition at line 175 of file TauRecToolBase.cxx.

177 {
178 ATH_MSG_ERROR("function not implemented");
179 return StatusCode::FAILURE;
180}

◆ executePi0ClusterScaler()

StatusCode TauRecToolBase::executePi0ClusterScaler ( xAOD::TauJet & pTau,
xAOD::PFOContainer & neutralPFOContainer,
xAOD::PFOContainer & chargedPFOContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauPi0ClusterScaler.

Definition at line 187 of file TauRecToolBase.cxx.

187 {
188 ATH_MSG_ERROR("function not implemented");
189 return StatusCode::FAILURE;
190}

◆ executePi0CreateROI()

StatusCode TauRecToolBase::executePi0CreateROI ( xAOD::TauJet & pTau,
CaloConstCellContainer & caloCellContainer,
boost::dynamic_bitset<> & map ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauPi0CreateROI.

Definition at line 149 of file TauRecToolBase.cxx.

149 {
150 ATH_MSG_ERROR("function not implemented");
151 return StatusCode::FAILURE;
152}

◆ executePi0nPFO()

StatusCode TauRecToolBase::executePi0nPFO ( xAOD::TauJet & pTau,
xAOD::PFOContainer & neutralPFOContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauPi0ScoreCalculator, and TauPi0Selector.

Definition at line 192 of file TauRecToolBase.cxx.

192 {
193 ATH_MSG_ERROR("function not implemented");
194 return StatusCode::FAILURE;
195}

◆ executeShotFinder()

StatusCode TauRecToolBase::executeShotFinder ( xAOD::TauJet & pTau,
xAOD::CaloClusterContainer & shotClusterContainer,
xAOD::PFOContainer & PFOContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauShotFinder.

Definition at line 170 of file TauRecToolBase.cxx.

170 {
171 ATH_MSG_ERROR("function not implemented");
172 return StatusCode::FAILURE;
173}

◆ executeTrackClassifier()

StatusCode TauRecToolBase::executeTrackClassifier ( xAOD::TauJet & pTau,
xAOD::TauTrackContainer & tauTrackContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in tauRecTools::TauTrackRNNClassifier.

Definition at line 165 of file TauRecToolBase.cxx.

165 {
166 ATH_MSG_ERROR("function not implemented");
167 return StatusCode::FAILURE;
168}

◆ executeTrackFinder()

StatusCode TauRecToolBase::executeTrackFinder ( xAOD::TauJet & pTau,
xAOD::TauTrackContainer & tauTrackContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauTrackFinder.

Definition at line 160 of file TauRecToolBase.cxx.

160 {
161 ATH_MSG_ERROR("function not implemented");
162 return StatusCode::FAILURE;
163}

◆ executeVertexFinder()

StatusCode TauRecToolBase::executeVertexFinder ( xAOD::TauJet & pTau,
const xAOD::VertexContainer * vertexContainer = nullptr ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauVertexFinder.

Definition at line 155 of file TauRecToolBase.cxx.

155 {
156 ATH_MSG_ERROR("function not implemented");
157 return StatusCode::FAILURE;
158}

◆ executeVertexVariables()

StatusCode TauRecToolBase::executeVertexVariables ( xAOD::TauJet & pTau,
xAOD::VertexContainer & vertexContainer ) const
overridevirtualinherited

Implements ITauToolBase.

Reimplemented in TauVertexVariables.

Definition at line 182 of file TauRecToolBase.cxx.

182 {
183 ATH_MSG_ERROR("function not implemented");
184 return StatusCode::FAILURE;
185}

◆ 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

◆ finalize()

StatusCode TauRecToolBase::finalize ( )
overridevirtualinherited

Finalizer.

Implements ITauToolBase.

Reimplemented in PanTau::PanTauProcessor.

Definition at line 206 of file TauRecToolBase.cxx.

206 {
207 return StatusCode::SUCCESS;
208}

◆ find_file()

std::string TauRecToolBase::find_file ( const std::string & fname) const
inherited

Definition at line 19 of file TauRecToolBase.cxx.

19 {
20 std::string full_path;
21 //offline calib files are in GroupData
22 //online calib files are in release
23 full_path = PathResolverFindCalibFile(m_tauRecToolsTag+"/"+fname);
24 if(full_path.empty()) full_path = PathResolverFindCalibFile(fname);
25 return full_path;
26}
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
Gaudi::Property< std::string > m_tauRecToolsTag

◆ 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 }
ServiceHandle< StoreGateSvc > & evtStore()

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

◆ inAOD()

bool TauRecToolBase::inAOD ( ) const
inlineprotectedinherited

Definition at line 88 of file TauRecToolBase.h.

88{ return m_in_AOD; }
Gaudi::Property< bool > m_in_AOD

◆ inEleRM()

bool TauRecToolBase::inEleRM ( ) const
inlineprotectedinherited

Definition at line 89 of file TauRecToolBase.h.

89{ return m_in_EleRM; }
Gaudi::Property< bool > m_in_EleRM

◆ initialize()

StatusCode TauElectronVetoVariables::initialize ( void )
overridevirtual

Tool initializer.

Reimplemented from TauRecToolBase.

Definition at line 27 of file TauElectronVetoVariables.cxx.

27 {
28 ATH_CHECK( m_caloExtensionTool.retrieve() );
29 if (!m_ParticleCacheKey.key().empty()) {
30 ATH_CHECK(m_ParticleCacheKey.initialize());
31 } else {
32 m_useOldCalo = true;
33 }
34 return StatusCode::SUCCESS;
35}
#define ATH_CHECK
Evaluate an expression and check for errors.

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

◆ inTrigger()

bool TauRecToolBase::inTrigger ( ) const
inlineprotectedinherited

Definition at line 87 of file TauRecToolBase.h.

87{ return m_in_trigger; }
Gaudi::Property< bool > m_in_trigger

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ 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 }
MsgStream & msg() const
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition MsgLevel.cxx:19

◆ 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()

◆ readConfig()

StatusCode TauRecToolBase::readConfig ( )
overridevirtualinherited

Implements ITauToolBase.

Definition at line 27 of file TauRecToolBase.cxx.

27 {
28 // Sanity check to see if property ConfigPath is declared for a tool. Might be
29 // removed once all tools are updated to have a config path declared.
30 // in athena getProperties returns std::vector<Gaudi::Details::PropertyBase*>
31 // in rc getProperties returns std::map<std::string,Property*>
32#ifndef XAOD_STANDALONE
33 bool configPathDeclared = false;
34 for (Gaudi::Details::PropertyBase* property : getProperties())
35 {
36 if (property->name() == "ConfigPath")
37 {
38 configPathDeclared = true;
39 break;
40 }
41 }
42 if (!configPathDeclared)
43#elif defined(XAOD_STANDALONE)
44 PropertyMgr::PropMap_t property_map = getPropertyMgr()->getProperties();
45 if (property_map.find("ConfigPath") == property_map.end())
46#else
47# error "What environment are we in?!?"
48#endif // XAOD_STANDALONE
49 {
50 ATH_MSG_INFO("No config file path property declared yet, this is not recommended");
51 return StatusCode::SUCCESS;
52 }
53
54 // get configured config path and load file via TEnv
55 const std::string* config_file_path_property;
56 // if (getProperty("ConfigPath", config_file_path).isFailure())
57 // return StatusCode::FAILURE;
58 config_file_path_property = getProperty<std::string>("ConfigPath");
59 std::string config_file_path = find_file(*config_file_path_property);
60 TEnv env;
61 env.ReadFile(PathResolverFindCalibFile(config_file_path).c_str(),kEnvAll);
62
63 THashList* lList = env.GetTable();
64 for( Int_t i = 0; lList && i < lList->GetEntries(); ++i )
65 {
67 // types of properties are handled differently as well
68#ifndef XAOD_STANDALONE
69 // get type of variable with the entry name
70 const std::type_info* type = getProperty(lList->At( i )->GetName()).type_info();
71
72 // search for type is needed by env.GetValue function (needs a variable of the correct type as 2nd argument)
73 if (*type == typeid(bool))
74 sc = this->setProperty(lList->At( i )->GetName(),
75 bool(env.GetValue(lList->At( i )->GetName(),bool(true))));
76 else if (*type == typeid(int))
77 sc = this->setProperty(lList->At( i )->GetName(),
78 env.GetValue(lList->At( i )->GetName(),int(0)));
79 else if (*type == typeid(float))
80 sc = this->setProperty(lList->At( i )->GetName(),
81 env.GetValue(lList->At( i )->GetName(),float(0)));
82 else if (*type == typeid(double))
83 sc = this->setProperty(lList->At( i )->GetName(),
84 env.GetValue(lList->At( i )->GetName(),double(0)));
85 else if (*type == typeid(std::string))
86 sc = this->setProperty(lList->At( i )->GetName(),
87 env.GetValue(lList->At( i )->GetName(),""));
88#else
89 // get type of variable with the entry name
90 Property::Type type = getPropertyMgr()->getProperty(lList->At( i )->GetName())->type();
91
92 if (type == Property::BOOL)
93 sc = this->setProperty(lList->At( i )->GetName(),
94 bool(env.GetValue(lList->At( i )->GetName(),bool(true))));
95 else if (type == Property::INT)
96 sc = this->setProperty(lList->At( i )->GetName(),
97 env.GetValue(lList->At( i )->GetName(),int(0)));
98 else if (type == Property::FLOAT)
99 sc = this->setProperty(lList->At( i )->GetName(),
100 env.GetValue(lList->At( i )->GetName(),float(0)));
101 else if (type == Property::DOUBLE)
102 sc = this->setProperty(lList->At( i )->GetName(),
103 env.GetValue(lList->At( i )->GetName(),double(0)));
104 else if (type == Property::STRING)
105 sc = this->setProperty(lList->At( i )->GetName(),
106 env.GetValue(lList->At( i )->GetName(),""));
107#endif // XAOD_STANDALONE
108 else
109 {
110#ifndef XAOD_STANDALONE
111 ATH_MSG_FATAL("there was a problem to find the correct type enum: "<<type->name());
112#else
113 ATH_MSG_FATAL("there was a problem to find the correct type enum: "<<type);
114#endif // XAOD_STANDALONE
115 return StatusCode::FAILURE;
116 }
117 if (!sc.isSuccess()) {
118 ATH_MSG_FATAL("failed to set property: " << lList->At( i )->GetName());
119 return StatusCode::FAILURE;
120 }
121 }
122 return StatusCode::SUCCESS;
123}
#define ATH_MSG_FATAL(x)
static Double_t sc
void setProperty(columnar::PythonToolHandle &self, const std::string &key, nb::object value)
Type
Property type enumeration.
Definition Property.h:27
std::string find_file(const std::string &fname) const
const T * getProperty(const std::string &name) const
Get one of the tool's properties.
::StatusCode StatusCode
StatusCode definition for legacy code.

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

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

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

Member Data Documentation

◆ m_caloExtensionTool

ToolHandle<Trk::IParticleCaloExtensionTool> TauElectronVetoVariables::m_caloExtensionTool
private
Initial value:
{this,
"ParticleCaloExtensionTool", "Trk::ParticleCaloExtensionTool/ParticleCaloExtensionTool", "Tool for calculating track extrapolation"}

Definition at line 45 of file TauElectronVetoVariables.h.

45 {this,
46 "ParticleCaloExtensionTool", "Trk::ParticleCaloExtensionTool/ParticleCaloExtensionTool", "Tool for calculating track extrapolation"};

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

Gaudi::Property<bool> TauElectronVetoVariables::m_doVertexCorrection {this, "VertexCorrection", true, "switch of vertex correction"}
private

Definition at line 43 of file TauElectronVetoVariables.h.

43{this, "VertexCorrection", true, "switch of vertex correction"};

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

Gaudi::Property<bool> TauRecToolBase::m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}
protectedinherited

Definition at line 77 of file TauRecToolBase.h.

77{this, "inAOD", false, "Indicate if the tool is running on AOD"};

◆ m_in_EleRM

Gaudi::Property<bool> TauRecToolBase::m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}
protectedinherited

Definition at line 78 of file TauRecToolBase.h.

78{this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"};

◆ m_in_trigger

Gaudi::Property<bool> TauRecToolBase::m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}
protectedinherited

Definition at line 76 of file TauRecToolBase.h.

76{this, "inTrigger", false, "Indicate if the tool is running on trigger"};

◆ m_ParticleCacheKey

SG::ReadHandleKey<CaloExtensionCollection> TauElectronVetoVariables::m_ParticleCacheKey
private
Initial value:
{this,
"tauEVParticleCache", "ParticleCaloExtension", "Name of the particle measurement extrapolation cache for TauEV Algorithm"}

Definition at line 47 of file TauElectronVetoVariables.h.

47 {this,
48 "tauEVParticleCache", "ParticleCaloExtension", "Name of the particle measurement extrapolation cache for TauEV Algorithm"};

◆ m_tauRecToolsTag

Gaudi::Property<std::string> TauRecToolBase::m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}
protectedinherited

Definition at line 79 of file TauRecToolBase.h.

79{this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"};

◆ m_useOldCalo

Gaudi::Property<bool> TauElectronVetoVariables::m_useOldCalo {this,"useOldCalo",false,"If true, it uses the CaloExtensionTool for calculating track extrapolation. Otherwise, it allows the code to read from the cache created by CaloExtensionBuilderalg."}
private

Definition at line 44 of file TauElectronVetoVariables.h.

44{this,"useOldCalo",false,"If true, it uses the CaloExtensionTool for calculating track extrapolation. Otherwise, it allows the code to read from the cache created by CaloExtensionBuilderalg."};

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