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

#include <IAnalysisTools.h>

Inheritance diagram for IAnalysisTools:
Collaboration diagram for IAnalysisTools:

Public Member Functions

 IAnalysisTools (const std::string &type, const std::string &name, const IInterface *parent)
 constructor More...
 
virtual ~IAnalysisTools ()
 destructor More...
 
double deltaPhi (const INavigable4Momentum *p1, const INavigable4Momentum *p2) const
 \( \Delta\phi \) More...
 
double deltaR (const INavigable4Momentum *p1, const INavigable4Momentum *p2) const
 \( \Delta{R} \) More...
 
double imass2 (const INavigable4Momentum *p1, const INavigable4Momentum *p2) const
 Invariant mass : 2 body. More...
 
double imass4 (const INavigable4Momentum *p1, const INavigable4Momentum *p2, const INavigable4Momentum *p3, const INavigable4Momentum *p4) const
 Invariant mass : 4 body. More...
 
template<class COLL >
bool matchR (const INavigable4Momentum *t, COLL *coll, int &index, double &deltaR) const
 find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID More...
 
template<class COLL >
bool matchR (const double eta, const double phi, COLL *coll, int &index, double &deltaR) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, int &index, double &deltaR, const bool genOnly=true) const
 
bool matchR (const double eta, const double phi, const TruthParticleContainer *coll, int &index, double &deltaR, const bool genOnly=true) const
 
template<class COLL >
bool matchR (const INavigable4Momentum *t, COLL *coll, int &index, double &deltaR, double &deltaE) const
 find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID but a condition on E More...
 
template<class COLL >
bool matchR (const double eta, const double phi, const double e, COLL *coll, int &index, double &deltaR, double &deltaE) const
 
bool matchR (const double eta, const double phi, const double e, const TruthParticleContainer *coll, int &index, double &deltaR, double &deltaE, const bool genOnly=true) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, int &index, double &deltaR, double &deltaE, const bool genOnly=true) const
 
template<class COLL , class ELEMENT >
bool matchR (const INavigable4Momentum *t, COLL *coll, ELEMENT *&element, double &deltaR) const
 find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID More...
 
template<class COLL , class ELEMENT >
bool matchR (const double eta, const double phi, COLL *coll, ELEMENT *&element, double &deltaR) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, const bool genOnly=true) const
 
bool matchR (const double eta, const double phi, const TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, const bool genOnly=true) const
 
template<class COLL , class ELEMENT >
bool matchR (const INavigable4Momentum *t, COLL *coll, ELEMENT *&element, double &deltaR, double &deltaE) const
 find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID - with a condition on E More...
 
template<class COLL , class ELEMENT >
bool matchR (const double eta, const double phi, const double e, COLL *coll, ELEMENT *&element, double &deltaR, double &deltaE) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, double &deltaE, const bool genOnly=true) const
 
bool matchR (const double eta, const double phi, const double e, const TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, double &deltaE, const bool genOnly=true) const
 
template<class COLL >
bool matchR (const INavigable4Momentum *t, COLL *coll, int &index, double &deltaR, const int pdg) const
 find the closest (in R) element in a collection to an INavigable4Momentum More...
 
template<class COLL >
bool matchR (const double eta, const double phi, COLL *coll, int &index, double &deltaR, const int pdg) const
 
bool matchR (const double eta, const double phi, const TruthParticleContainer *coll, int &index, double &deltaR, const int pdg, const bool genOnly=true) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, int &index, double &deltaR, const int pdg, const bool genOnly=true) const
 
template<class COLL >
bool matchR (const INavigable4Momentum *t, COLL *coll, int &index, double &deltaR, const int pdg, double &deltaE) const
 find the closest (in R) element in a collection to an INavigable4Momentum More...
 
template<class COLL >
bool matchR (const double eta, const double phi, const double e, COLL *coll, int &index, double &deltaR, const int pdg, double &deltaE) const
 
bool matchR (const double eta, const double phi, const double e, const TruthParticleContainer *coll, int &index, double &deltaR, const int pdg, double &deltaE, const bool genOnly=true) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, int &index, double &deltaR, const int pdg, double &deltaE, const bool genOnly=true) const
 
template<class COLL , class ELEMENT >
bool matchR (const INavigable4Momentum *t, COLL *coll, ELEMENT *&element, double &deltaR, const int pdg) const
 find the closest (in R) element in a collection to an INavigable4Momentum More...
 
template<class COLL , class ELEMENT >
bool matchR (const double eta, const double phi, COLL *coll, ELEMENT *&element, double &deltaR, const int pdg) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, const int pdg, const bool genOnly=true) const
 
bool matchR (const double eta, const double phi, TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, const int pdg, const bool genOnly=true) const
 
template<class COLL , class ELEMENT >
bool matchR (const INavigable4Momentum *t, COLL *coll, ELEMENT *&element, double &deltaR, const int pdg, double &deltaE) const
 find the closest (in R) element in a collection to an INavigable4Momentum More...
 
template<class COLL , class ELEMENT >
bool matchR (const double eta, const double phi, const double e, COLL *coll, ELEMENT *&element, double &deltaR, const int pdg, double &deltaE) const
 
bool matchR (const INavigable4Momentum *t, const TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, const int pdg, double &deltaE, const bool genOnly=true) const
 
bool matchR (const double eta, const double phi, const double e, const TruthParticleContainer *coll, const TruthParticle *&element, double &deltaR, const int pdg, double &deltaE, const bool genOnly=true) const
 
template<class COLL >
void sortPT (COLL *coll) const
 sort by pT More...
 
template<class COLL >
void sortE (COLL *coll) const
 sort by energy More...
 
template<class COLL >
void sortEta (COLL *coll) const
 sort by eta More...
 
template<class COLL >
void sortPhi (COLL *coll) const
 sort by phi More...
 
template<class COLL >
void classifyCharge (const COLL *coll, std::vector< typename COLL::value_type > &pos, std::vector< typename COLL::value_type > &neg) const
 classify by charge More...
 
template<class CALLER , class CRITERIA , class COLL >
StatusCode select (CALLER *caller, CRITERIA criteria, COLL *coll, const std::string &key, const bool=false) const
 selection 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

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

Definition at line 28 of file IAnalysisTools.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

◆ IAnalysisTools()

IAnalysisTools::IAnalysisTools ( const std::string &  type,
const std::string &  name,
const IInterface *  parent 
)
inline

constructor

Definition at line 34 of file IAnalysisTools.h.

37  {}

◆ ~IAnalysisTools()

virtual IAnalysisTools::~IAnalysisTools ( )
inlinevirtual

destructor

Definition at line 41 of file IAnalysisTools.h.

41 {}

Member Function Documentation

◆ classifyCharge()

template<class COLL >
void IAnalysisTools::classifyCharge ( const COLL *  coll,
std::vector< typename COLL::value_type > &  pos,
std::vector< typename COLL::value_type > &  neg 
) const

classify by charge

Parameters
COLL[in] type of collection
coll[in] pointer to collection
pos[out] collection of positives
neg[out] collection of nagatives

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

◆ deltaPhi()

double IAnalysisTools::deltaPhi ( const INavigable4Momentum p1,
const INavigable4Momentum p2 
) const

\( \Delta\phi \)

◆ deltaR()

double IAnalysisTools::deltaR ( const INavigable4Momentum p1,
const INavigable4Momentum p2 
) const

\( \Delta{R} \)

◆ 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

◆ imass2()

double IAnalysisTools::imass2 ( const INavigable4Momentum p1,
const INavigable4Momentum p2 
) const

Invariant mass : 2 body.

◆ imass4()

double IAnalysisTools::imass4 ( const INavigable4Momentum p1,
const INavigable4Momentum p2,
const INavigable4Momentum p3,
const INavigable4Momentum p4 
) const

Invariant mass : 4 body.

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

◆ matchR() [1/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR 
) const

◆ matchR() [2/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR,
const int  pdg 
) const

◆ matchR() [3/32]

template<class COLL >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
COLL *  coll,
int &  index,
double &  deltaR 
) const

◆ matchR() [4/32]

template<class COLL >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
COLL *  coll,
int &  index,
double &  deltaR,
const int  pdg 
) const

◆ matchR() [5/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR,
const int  pdg,
double &  deltaE 
) const

◆ matchR() [6/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR,
double &  deltaE 
) const

◆ matchR() [7/32]

template<class COLL >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
COLL *  coll,
int &  index,
double &  deltaR,
const int  pdg,
double &  deltaE 
) const

◆ matchR() [8/32]

template<class COLL >
bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
COLL *  coll,
int &  index,
double &  deltaR,
double &  deltaE 
) const

◆ matchR() [9/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
const TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
const int  pdg,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 276 of file IAnalysisTools.h.

278  {
279  int index;
280  bool ret = AnalysisUtils::Match::R(eta,phi,e,coll,index,deltaR,pdg, deltaE,genOnly);
281  if (!ret) return false;
282  element = (*coll)[index];
283  return true;
284  }

◆ matchR() [10/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
const TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 164 of file IAnalysisTools.h.

166  {
167  int index = -1;
168  bool ret = AnalysisUtils::Match::R(eta,phi,e,coll,index,deltaR,deltaE,genOnly);
169  if (!ret || -1 == index) return false;
170  element = (*coll)[index];
171  return true;
172  }

◆ matchR() [11/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
const int  pdg,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 210 of file IAnalysisTools.h.

212  {
213  return AnalysisUtils::Match::R(eta, phi, e, coll, index, deltaR, pdg, deltaE, genOnly);
214  }

◆ matchR() [12/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const double  e,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 97 of file IAnalysisTools.h.

99  {
100  return AnalysisUtils::Match::R(eta, phi, e, coll, index, deltaR, deltaE, genOnly);
101  }

◆ matchR() [13/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
const bool  genOnly = true 
) const
inline

Definition at line 131 of file IAnalysisTools.h.

133  {
134  int index;
135  bool ret = AnalysisUtils::Match::R(eta,phi,coll,index,deltaR,genOnly);
136  if (!ret) return false;
137  element = (*coll)[index];
138  return true;
139  }

◆ matchR() [14/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
const bool  genOnly = true 
) const
inline

Definition at line 78 of file IAnalysisTools.h.

80  {
81  return AnalysisUtils::Match::R(eta, phi, coll, index, deltaR, genOnly);
82  }

◆ matchR() [15/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
const int  pdg,
const bool  genOnly = true 
) const
inline

Definition at line 185 of file IAnalysisTools.h.

187  {
188  return AnalysisUtils::Match::R(eta, phi, coll, index, deltaR, pdg, genOnly);
189  }

◆ matchR() [16/32]

bool IAnalysisTools::matchR ( const double  eta,
const double  phi,
TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
const int  pdg,
const bool  genOnly = true 
) const
inline

Definition at line 243 of file IAnalysisTools.h.

245  {
246  int index;
247  bool ret = AnalysisUtils::Match::R(eta,phi,coll,index,deltaR,pdg,genOnly);
248  if (!ret) return false;
249  element = (*coll)[index];
250  return true;
251  }

◆ matchR() [17/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR 
) const

find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID

Parameters
element[out] pointer to the closest element
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [18/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR,
const int  pdg 
) const

find the closest (in R) element in a collection to an INavigable4Momentum

Parameters
element[out] pointer to the closest element
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [19/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR,
const int  pdg,
double &  deltaE 
) const

find the closest (in R) element in a collection to an INavigable4Momentum

Parameters
element[out] pointer to the closest element and a condition on E
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [20/32]

template<class COLL , class ELEMENT >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
ELEMENT *&  element,
double &  deltaR,
double &  deltaE 
) const

find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID - with a condition on E

Parameters
element[out] pointer to the closest element
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [21/32]

template<class COLL >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
int &  index,
double &  deltaR 
) const

find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID

Parameters
index[out] index of the closest element
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [22/32]

template<class COLL >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
int &  index,
double &  deltaR,
const int  pdg 
) const

find the closest (in R) element in a collection to an INavigable4Momentum

Parameters
index[out] index of the closest element
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [23/32]

template<class COLL >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
int &  index,
double &  deltaR,
const int  pdg,
double &  deltaE 
) const

find the closest (in R) element in a collection to an INavigable4Momentum

Parameters
index[out] index of the closest element
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [24/32]

template<class COLL >
bool IAnalysisTools::matchR ( const INavigable4Momentum t,
COLL *  coll,
int &  index,
double &  deltaR,
double &  deltaE 
) const

find the closest (in R) element in a collection to an INavigable4Momentum not check PDG ID but a condition on E

Parameters
index[out] index of the closest element
deltaR[out] \( \Delta{R} \)
Returns
true if found

◆ matchR() [25/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
const bool  genOnly = true 
) const
inline

Definition at line 121 of file IAnalysisTools.h.

123  {
124  int index = 0;
125  bool ret = AnalysisUtils::Match::R(t,coll,index,deltaR, genOnly);
126  if (!ret) return false;
127  element = (*coll)[index];
128  return true;
129  }

◆ matchR() [26/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
const int  pdg,
const bool  genOnly = true 
) const
inline

Definition at line 233 of file IAnalysisTools.h.

235  {
236  int index;
237  bool ret = AnalysisUtils::Match::R(t,coll,index,deltaR,pdg,genOnly);
238  if (!ret) return false;
239  element = (*coll)[index];
240  return true;
241  }

◆ matchR() [27/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
const int  pdg,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 266 of file IAnalysisTools.h.

268  {
269  int index;
270  bool ret = AnalysisUtils::Match::R(t,coll,index,deltaR,pdg,deltaE,genOnly);
271  if (!ret) return false;
272  element = (*coll)[index];
273  return true;
274  }

◆ matchR() [28/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
const TruthParticle *&  element,
double &  deltaR,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 154 of file IAnalysisTools.h.

156  {
157  int index = -1;
158  bool ret = AnalysisUtils::Match::R(t,coll,index,deltaR, deltaE, genOnly);
159  if (!ret || index == -1) return false;
160  element = (*coll)[index];
161  return true;
162  }

◆ matchR() [29/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
const bool  genOnly = true 
) const
inline

Definition at line 72 of file IAnalysisTools.h.

74  {
75  return AnalysisUtils::Match::R(t->eta(), t->phi(), coll, index, deltaR, genOnly);
76  }

◆ matchR() [30/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
const int  pdg,
const bool  genOnly = true 
) const
inline

Definition at line 191 of file IAnalysisTools.h.

193  {
194  return AnalysisUtils::Match::R(t->eta(), t->phi(), coll, index, deltaR, pdg, genOnly);
195  }

◆ matchR() [31/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
const int  pdg,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 216 of file IAnalysisTools.h.

218  {
219  return AnalysisUtils::Match::R(t->eta(), t->phi(), t->e(), coll, index, deltaR, pdg, deltaE, genOnly);
220  }

◆ matchR() [32/32]

bool IAnalysisTools::matchR ( const INavigable4Momentum t,
const TruthParticleContainer coll,
int &  index,
double &  deltaR,
double &  deltaE,
const bool  genOnly = true 
) const
inline

Definition at line 103 of file IAnalysisTools.h.

105  {
106  return AnalysisUtils::Match::R(t->eta(), t->phi(), t->e(), coll, index, deltaR, deltaE, genOnly);
107  }

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

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

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

◆ select()

template<class CALLER , class CRITERIA , class COLL >
StatusCode IAnalysisTools::select ( CALLER *  caller,
CRITERIA  criteria,
COLL *  coll,
const std::string &  key,
const bool  = false 
) const

selection

Parameters
CALLER[in] type of caller. e.g., class XYZ
CRITERIA[in] function pointer. must be void XYZ::abc(COLL::value_type, XYZ*)
COLL[in] type of
caller[in] pointer to caller
criteria[in] pointer to criteria
coll[in] pointer to collection
key[in] key for selected collection in SG
lock[in] lock the selected collection in SG. default=false

◆ sortE()

template<class COLL >
void IAnalysisTools::sortE ( COLL *  coll) const

sort by energy

Parameters
coll[in] collection
out[out] sorted collection

◆ sortEta()

template<class COLL >
void IAnalysisTools::sortEta ( COLL *  coll) const

sort by eta

Parameters
coll[in] collection
out[out] sorted collection

◆ sortPhi()

template<class COLL >
void IAnalysisTools::sortPhi ( COLL *  coll) const

sort by phi

Parameters
coll[in] collection
out[out] sorted collection

◆ sortPT()

template<class COLL >
void IAnalysisTools::sortPT ( COLL *  coll) const

sort by pT

Parameters
coll[in] collection
out[out] sorted collection

◆ 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_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 file:
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
phi
Scalar phi() const
phi method
Definition: AmgMatrixBasePlugin.h:64
eta
Scalar eta() const
pseudorapidity method
Definition: AmgMatrixBasePlugin.h:79
index
Definition: index.py:1
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
IAnalysisTools::deltaR
double deltaR(const INavigable4Momentum *p1, const INavigable4Momentum *p2) const
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
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
ret
T ret(T t)
Definition: rootspy.cxx:260
AnalysisUtils::Match::R
bool R(const double eta, const double phi, COLL *coll, int &index, double &deltaR, const int pdg)
find the closest element in R
Definition: AnalysisMisc.h:94
test_pyathena.parent
parent
Definition: test_pyathena.py:15
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
AthAlgTool::AthAlgTool
AthAlgTool()
Default constructor:
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
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
DeMoScan.index
string index
Definition: DeMoScan.py:362
DiTauMassTools::MaxHistStrategyV2::e
e
Definition: PhysicsAnalysis/TauID/DiTauMassTools/DiTauMassTools/HelperFunctions.h:26
a
TList * a
Definition: liststreamerinfos.cxx:10
h
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
fitman.k
k
Definition: fitman.py:528