|
ATLAS Offline Software
|
JetModifier that associates HIClusters w/ a jet. Necessary because you may want to know all clusters w/in DR < X rather than just the clusters that are constituents of the jet. Since HI-style clusters derive from towers they have a well-defined index For each jet, this tool associates a set of clusters from a pre-determined indexing.
More...
#include <HIJetClusterIndexAssociationTool.h>
|
| HIJetClusterIndexAssociationTool (const std::string &t) |
|
virtual StatusCode | initialize () override |
| Dummy implementation of the initialisation function. More...
|
|
virtual StatusCode | modify (xAOD::JetContainer &jets) const override |
| Loop over calls to modifyJet. More...
|
|
virtual int | modifyJet (xAOD::Jet &) const override |
| Modify a single jet. This is obsolete and set to be removed. More...
|
|
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 |
|
|
SG::ReadHandleKey< xAOD::IParticleContainer > | m_containerKey { this, "ContainerKey", "", "Name of IParticleContainer w/ particles to associat"} |
| name of IParticleContainer w/ particles to associate More...
|
|
Gaudi::Property< std::string > | m_assocName { this, "AssociationName", "", "Name of jet attribute providing link between jets and clusters" } |
| Name of jet attribute providing link between jets and clusters. More...
|
|
Gaudi::Property< float > | m_DR { this, "DeltaR", 0.8, "Index passing actually needs to be implemented" } |
|
Gaudi::Property< bool > | m_applyFilter { this, "ApplyFilter", false, "Apply filter boolean" } |
|
Gaudi::Property< float > | m_Emin { this, "FilterMinE", -999., "Filter minimum Energy" } |
|
Gaudi::Property< float > | m_pTmin { this, "FilterMinPt", 0., "Filter minimum Pt" } |
|
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 |
|
JetModifier that associates HIClusters w/ a jet. Necessary because you may want to know all clusters w/in DR < X rather than just the clusters that are constituents of the jet. Since HI-style clusters derive from towers they have a well-defined index For each jet, this tool associates a set of clusters from a pre-determined indexing.
- Author
- Aaron Angerami anger.nosp@m.ami@.nosp@m.cern..nosp@m.ch
- Date
- Jan, 2015
Given a DR value and an eta/phi position a set of indices of towers w/in DR of that position can be calculated, and can be done in advance or at initialization time rather than in the event loop. The set of such indices for each eta/phi position (defined by tower grid) is supplied to the tool, which uses this to perform the association.
Definition at line 37 of file HIJetClusterIndexAssociationTool.h.
◆ StoreGateSvc_t
◆ HIJetClusterIndexAssociationTool()
HIJetClusterIndexAssociationTool::HIJetClusterIndexAssociationTool |
( |
const std::string & |
t | ) |
|
◆ ASG_TOOL_CLASS0()
◆ declareGaudiProperty() [1/4]
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
175 hndl.documentation());
◆ declareGaudiProperty() [2/4]
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
161 hndl.documentation());
◆ declareGaudiProperty() [3/4]
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
189 hndl.documentation());
◆ declareGaudiProperty() [4/4]
◆ declareProperty() [1/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation 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.
250 this->declare(hndl.
vhKey());
251 hndl.
vhKey().setOwner(
this);
253 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [2/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation 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.
229 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [3/6]
◆ declareProperty() [4/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation 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.
338 return PBASE::declareProperty(
name, property,
doc);
◆ declareProperty() [5/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation 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.
◆ declareProperty() [6/6]
◆ detStore()
◆ evtStore() [1/2]
◆ evtStore() [2/2]
◆ extraDeps_update_handler()
Add StoreName to extra input/output deps as needed.
use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given
◆ getKey()
Get the (hashed) key of an object that is in the event store.
This is a bit of a special one. StoreGateSvc
and xAOD::TEvent
both provide ways for getting the SG::sgkey_t
key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
- See also
- asg::AsgTool::getName
- Parameters
-
ptr | The bare pointer to the object that the event store should know about |
- Returns
- The hashed key of the object in the store. If not found, an invalid (zero) key.
Definition at line 119 of file AsgTool.cxx.
121 #ifdef XAOD_STANDALONE
127 return (
proxy ==
nullptr ? 0 :
proxy->sgkey() );
128 #endif // XAOD_STANDALONE
◆ getName()
const std::string & asg::AsgTool::getName |
( |
const void * |
ptr | ) |
const |
|
inherited |
Get the name of an object that is / should be in the event store.
This is a bit of a special one. StoreGateSvc
and xAOD::TEvent
both provide ways for getting the std::string
name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
- See also
- asg::AsgTool::getKey
- Parameters
-
ptr | The bare pointer to the object that the event store should know about |
- Returns
- The string name of the object in the store. If not found, an empty string.
Definition at line 106 of file AsgTool.cxx.
108 #ifdef XAOD_STANDALONE
114 static const std::string
dummy =
"";
116 #endif // XAOD_STANDALONE
◆ getProperty()
template<class T >
const T* asg::AsgTool::getProperty |
( |
const std::string & |
name | ) |
const |
|
inherited |
Get one of the tool's properties.
◆ initialize()
StatusCode HIJetClusterIndexAssociationTool::initialize |
( |
| ) |
|
|
overridevirtual |
Dummy implementation of the initialisation function.
It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...
Reimplemented from asg::AsgTool.
Definition at line 18 of file HIJetClusterIndexAssociationTool.cxx.
19 ATH_MSG_DEBUG(
"Initializing HIJetClusterIndexAssociationTool");
21 return StatusCode::SUCCESS;
◆ inputHandles()
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.
◆ modify()
Loop over calls to modifyJet.
Reimplemented from JetModifierBase.
Definition at line 25 of file HIJetClusterIndexAssociationTool.cxx.
32 ppars = readHandlePcontainer.
get();
45 if(etabinmin < 0) etabinmin=0;
48 for(
int ieta=etabinmin; ieta<=etabinmax; ieta++)
57 float rv2=dphi*dphi+delta_ev2;
64 rv2=dphi*dphi+delta_ev2;
76 rv2=dphi*dphi+delta_ev2;
108 return StatusCode::SUCCESS;
◆ modifyJet()
virtual int HIJetClusterIndexAssociationTool::modifyJet |
( |
xAOD::Jet & |
jet | ) |
const |
|
inlineoverridevirtual |
◆ msg() [1/2]
◆ msg() [2/2]
◆ 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.
◆ msgLvl()
◆ outputHandles()
Return this algorithm's output handles.
We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.
◆ print()
void asg::AsgTool::print |
( |
| ) |
const |
|
virtualinherited |
Print the state of the tool.
Implements asg::IAsgTool.
Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.
Definition at line 131 of file AsgTool.cxx.
◆ renounce()
◆ renounceArray()
◆ sysInitialize()
◆ sysStart()
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
◆ updateVHKA()
◆ m_applyFilter
Gaudi::Property< bool > HIJetClusterIndexAssociationTool::m_applyFilter { this, "ApplyFilter", false, "Apply filter boolean" } |
|
private |
◆ m_assocName
Gaudi::Property< std::string > HIJetClusterIndexAssociationTool::m_assocName { this, "AssociationName", "", "Name of jet attribute providing link between jets and clusters" } |
|
private |
◆ m_containerKey
◆ m_detStore
◆ m_DR
Gaudi::Property< float > HIJetClusterIndexAssociationTool::m_DR { this, "DeltaR", 0.8, "Index passing actually needs to be implemented" } |
|
private |
◆ m_Emin
Gaudi::Property< float > HIJetClusterIndexAssociationTool::m_Emin { this, "FilterMinE", -999., "Filter minimum Energy" } |
|
private |
◆ m_evtStore
◆ m_pTmin
Gaudi::Property< float > HIJetClusterIndexAssociationTool::m_pTmin { this, "FilterMinPt", 0., "Filter minimum Pt" } |
|
private |
◆ m_varHandleArraysDeclared
◆ m_vhka
The documentation for this class was generated from the following files:
Scalar phi() const
phi method
Scalar eta() const
pseudorapidity method
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
unsigned int findBinEta(float eta)
unsigned int findBinPhi(float phi)
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
const T * get(size_type n) const
Access an element, as an rvalue.
float getBinCenterPhi(unsigned int pb)
virtual double phi() const
The azimuthal angle ( ) of the particle.
unsigned int findEtaPhiBin(float eta, float phi)
Class providing the definition of the 4-vector interface.
__HOSTDEV__ double Phi_mpi_pi(double)
virtual void setOwner(IDataHandleHolder *o)=0
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
std::vector< const IParticle * > ParticleVector
(Non-const) Iterator class for DataVector/DataList.
float getBinCenterEta(unsigned int eb)
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
virtual double eta() const
The pseudorapidity ( ) of the particle.
constexpr unsigned int numEtaBins()
virtual void renounce()=0
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
void setAssociatedObjects(const std::string &name, const std::vector< const T * > &vec)
set associated objects from a vector of arbitrary object.
JetModifierBase(const std::string &myname)
Ctor.
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>