ATLAS Offline Software
Loading...
Searching...
No Matches
ECUtils::EventCleaningTool Class Reference

#include <EventCleaningTool.h>

Inheritance diagram for ECUtils::EventCleaningTool:
Collaboration diagram for ECUtils::EventCleaningTool:

Public Member Functions

 EventCleaningTool (const std::string &name="EventCleaningTool")
 Create a proper constructor for Athena.
virtual ~EventCleaningTool ()
 Standard destructor.
virtual StatusCode initialize () override
 Initialize method.
virtual bool acceptEvent (const xAOD::JetContainer *jets) const override
 Declare the interface.
virtual int keepJet (const xAOD::Jet &jet) const 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

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

Private Types

typedef ServiceHandle< 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< double > m_pt {this, "PtCut" , 20000., "Jet pt cut"}
Gaudi::Property< double > m_eta {this, "EtaCut" , 4.5, "Jet eta cut"}
Gaudi::Property< std::string > m_prefix {this, "JetCleanPrefix", "", "Jet cleaning decoration prefix"}
Gaudi::Property< bool > m_decorate {this, "DoDecorations", true, "Decorate jets with cleaning decision?"}
Gaudi::Property< bool > m_useDecorations {this, "UseDecorations", false, "Use decorations in cleaning tool?"}
Gaudi::Property< std::string > m_cleaningLevel {this, "CleaningLevel", "LooseBad", "Jet cleaning level"}
Gaudi::Property< bool > m_suppressInputDeps {this, "SuppressInputDependence", false, "Will passOR be created in the same algorithm that uses this tool?"}
Gaudi::Property< bool > m_suppressOutputDeps {this, "SuppressOutputDependence", false, "Create output dependencies?"}
asg::AnaToolHandle< IJetSelectorm_jetCleaningTool
Gaudi::Property< std::string > m_jetContainerName {this, "JetContainer", "", "Input jet container key"}
SG::ReadDecorHandleKey< xAOD::JetContainerm_passJvtKey {this, "JvtDecorator", "passJvt", "JVT decision decoration key"}
SG::ReadDecorHandleKey< xAOD::JetContainerm_passORKey {this, "OrDecorator" , "passOR", "Overlap removal decision decoration key"}
SG::WriteDecorHandleKey< xAOD::JetContainerm_jetCleanKey {this, "JetCleanKey" , "", "Jet-level cleaning decoration key (autoconfigured)"}
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

Definition at line 37 of file EventCleaningTool.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

◆ EventCleaningTool()

EventCleaningTool::EventCleaningTool ( const std::string & name = "EventCleaningTool")

Create a proper constructor for Athena.

Standard constructor

Definition at line 42 of file EventCleaningTool.cxx.

43 : asg::AsgTool(name)
44 , m_jetCleaningTool("JetCleaningTool/JetCleaningTool")
45{
46 m_jetCleaningTool.declarePropertyFor(this, "JetCleaningTool");
47}
asg::AnaToolHandle< IJetSelector > m_jetCleaningTool

◆ ~EventCleaningTool()

EventCleaningTool::~EventCleaningTool ( )
virtual

Standard destructor.

Definition at line 53 of file EventCleaningTool.cxx.

53{}

Member Function Documentation

◆ acceptEvent()

bool EventCleaningTool::acceptEvent ( const xAOD::JetContainer * jets) const
overridevirtual

Declare the interface.

Top-level method for performing full overlap-removal. The individual OR methods will be called in the recommended order, and the considered objects will be decorated with the output result.

Implements ECUtils::IEventCleaningTool.

Definition at line 103 of file EventCleaningTool.cxx.

104{
105 bool pass_pt = 0;
106 bool pass_eta = 0;
107 bool pass_accept = 0;
108 int jvtDecision = 0;
109 int orDecision = 0;
110 bool isThisJetGood = 0;
111 bool isEventAllGood = 1;
112
113 SG::ReadDecorHandle<xAOD::JetContainer, char> jvtHandle(m_passJvtKey);
114 SG::ReadDecorHandle<xAOD::JetContainer, char> orHandle(m_passORKey);
115 SG::WriteDecorHandle<xAOD::JetContainer, char> jetCleanHandle(m_jetCleanKey);
116
117 for (auto thisJet : *jets){ //loop over decorated jet collection
118 pass_pt = thisJet->pt() > m_pt;
119 pass_eta = fabs(thisJet->eta()) < m_eta;
120 pass_accept = keepJet(*thisJet);
121 jvtDecision = jvtHandle(*thisJet);
122 orDecision = !(orHandle(*thisJet)); //recall, passOR==0 means that the jet is not an overlap and should be kept!
123
124 ATH_MSG_DEBUG("Jet info: pT: " << pass_pt << ", eta: " << pass_eta << ", accept? " << pass_accept << ", jvt: " << jvtDecision << ", or: " << orDecision);
125 if(pass_pt && pass_eta && jvtDecision && orDecision){//only consider jets for cleaning if they pass these requirements.
126 isThisJetGood = pass_accept;
127 isEventAllGood = isEventAllGood && isThisJetGood; //any event with a bad jet is rejected
128 }
129 else isThisJetGood = pass_accept; //if it fails any one of these, it shouldn't be able to kill the whole event, but we still need to know cleaning
130 ATH_MSG_DEBUG("Is jet good? " << isThisJetGood);
131 if(m_decorate) jetCleanHandle(*thisJet) = isThisJetGood;
132 }
133 ATH_MSG_DEBUG("Is event good? " << isEventAllGood);
134 return isEventAllGood;
135}
#define ATH_MSG_DEBUG(x)
SG::WriteDecorHandleKey< xAOD::JetContainer > m_jetCleanKey
SG::ReadDecorHandleKey< xAOD::JetContainer > m_passJvtKey
virtual int keepJet(const xAOD::Jet &jet) const override
Gaudi::Property< double > m_pt
Gaudi::Property< bool > m_decorate
Gaudi::Property< double > m_eta
SG::ReadDecorHandleKey< xAOD::JetContainer > m_passORKey

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

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

◆ extraDeps_update_handler()

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

Add StoreName to extra input/output deps as needed.

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

◆ getKey()

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

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

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

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

See also
asg::AsgTool::getName
Parameters
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.

◆ initialize()

StatusCode EventCleaningTool::initialize ( void )
overridevirtual

Initialize method.

Reimplemented from asg::AsgTool.

Definition at line 58 of file EventCleaningTool.cxx.

59{
60 if(m_passJvtKey.key() == "" || m_passORKey.key() == ""){
61 ATH_MSG_ERROR( "Tool initialized with unknown decorator names." );
62 return StatusCode::FAILURE;
63 }
64 if (m_cleaningLevel == ""){
65 ATH_MSG_ERROR( "Tool initialized with unknown cleaning level." );
66 return StatusCode::FAILURE;
67 }
68 if(m_jetContainerName == ""){
69 ATH_MSG_ERROR( "Tool initialized with no jet container name." );
70 return StatusCode::FAILURE;
71 }
72
73 //initialize jet cleaning tool
74 ATH_CHECK(m_jetCleaningTool.setProperty("JetContainer", m_jetContainerName ));
75 ATH_CHECK(m_jetCleaningTool.setProperty("CutLevel", m_cleaningLevel ));
76 ATH_CHECK(m_jetCleaningTool.setProperty("UseDecorations", m_useDecorations )); //for AODs we can't use decorations
77 ATH_CHECK(m_jetCleaningTool.retrieve());
78 ATH_MSG_INFO( "Event cleaning tool configured with cut level " << m_cleaningLevel );
79
83
84 ATH_CHECK(m_passJvtKey.initialize());
85 ATH_CHECK(m_passORKey.initialize());
87
88#ifndef XAOD_STANDALONE
90 // The user has promised that this will be produced by the same alg.
91 // Tell the scheduler to ignore it to avoid circular dependencies.
94 }
97 }
98#endif
99
100 return StatusCode::SUCCESS;
101}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)
#define ATH_MSG_INFO(x)
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)
Gaudi::Property< bool > m_suppressOutputDeps
Gaudi::Property< std::string > m_prefix
Gaudi::Property< bool > m_useDecorations
Gaudi::Property< std::string > m_jetContainerName
Gaudi::Property< std::string > m_cleaningLevel
Gaudi::Property< bool > m_suppressInputDeps

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

◆ keepJet()

int EventCleaningTool::keepJet ( const xAOD::Jet & jet) const
overridevirtual

Implements ECUtils::IEventCleaningTool.

Definition at line 137 of file EventCleaningTool.cxx.

138{
139 return m_jetCleaningTool->keep(jet);
140}

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

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

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

Gaudi::Property<std::string> ECUtils::EventCleaningTool::m_cleaningLevel {this, "CleaningLevel", "LooseBad", "Jet cleaning level"}
private

Definition at line 65 of file EventCleaningTool.h.

65{this, "CleaningLevel", "LooseBad", "Jet cleaning level"};

◆ m_decorate

Gaudi::Property<bool> ECUtils::EventCleaningTool::m_decorate {this, "DoDecorations", true, "Decorate jets with cleaning decision?"}
private

Definition at line 63 of file EventCleaningTool.h.

63{this, "DoDecorations", true, "Decorate jets with cleaning decision?"};

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

Gaudi::Property<double> ECUtils::EventCleaningTool::m_eta {this, "EtaCut" , 4.5, "Jet eta cut"}
private

Definition at line 61 of file EventCleaningTool.h.

61{this, "EtaCut" , 4.5, "Jet eta cut"};

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

asg::AnaToolHandle<IJetSelector> ECUtils::EventCleaningTool::m_jetCleaningTool
private

Definition at line 68 of file EventCleaningTool.h.

◆ m_jetCleanKey

SG::WriteDecorHandleKey<xAOD::JetContainer> ECUtils::EventCleaningTool::m_jetCleanKey {this, "JetCleanKey" , "", "Jet-level cleaning decoration key (autoconfigured)"}
private

Definition at line 73 of file EventCleaningTool.h.

73{this, "JetCleanKey" , "", "Jet-level cleaning decoration key (autoconfigured)"};

◆ m_jetContainerName

Gaudi::Property<std::string> ECUtils::EventCleaningTool::m_jetContainerName {this, "JetContainer", "", "Input jet container key"}
private

Definition at line 70 of file EventCleaningTool.h.

70{this, "JetContainer", "", "Input jet container key"};

◆ m_passJvtKey

SG::ReadDecorHandleKey<xAOD::JetContainer> ECUtils::EventCleaningTool::m_passJvtKey {this, "JvtDecorator", "passJvt", "JVT decision decoration key"}
private

Definition at line 71 of file EventCleaningTool.h.

71{this, "JvtDecorator", "passJvt", "JVT decision decoration key"};

◆ m_passORKey

SG::ReadDecorHandleKey<xAOD::JetContainer> ECUtils::EventCleaningTool::m_passORKey {this, "OrDecorator" , "passOR", "Overlap removal decision decoration key"}
private

Definition at line 72 of file EventCleaningTool.h.

72{this, "OrDecorator" , "passOR", "Overlap removal decision decoration key"};

◆ m_prefix

Gaudi::Property<std::string> ECUtils::EventCleaningTool::m_prefix {this, "JetCleanPrefix", "", "Jet cleaning decoration prefix"}
private

Definition at line 62 of file EventCleaningTool.h.

62{this, "JetCleanPrefix", "", "Jet cleaning decoration prefix"};

◆ m_pt

Gaudi::Property<double> ECUtils::EventCleaningTool::m_pt {this, "PtCut" , 20000., "Jet pt cut"}
private

Definition at line 60 of file EventCleaningTool.h.

60{this, "PtCut" , 20000., "Jet pt cut"};

◆ m_suppressInputDeps

Gaudi::Property<bool> ECUtils::EventCleaningTool::m_suppressInputDeps {this, "SuppressInputDependence", false, "Will passOR be created in the same algorithm that uses this tool?"}
private

Definition at line 66 of file EventCleaningTool.h.

66{this, "SuppressInputDependence", false, "Will passOR be created in the same algorithm that uses this tool?"};

◆ m_suppressOutputDeps

Gaudi::Property<bool> ECUtils::EventCleaningTool::m_suppressOutputDeps {this, "SuppressOutputDependence", false, "Create output dependencies?"}
private

Definition at line 67 of file EventCleaningTool.h.

67{this, "SuppressOutputDependence", false, "Create output dependencies?"};

◆ m_useDecorations

Gaudi::Property<bool> ECUtils::EventCleaningTool::m_useDecorations {this, "UseDecorations", false, "Use decorations in cleaning tool?"}
private

Definition at line 64 of file EventCleaningTool.h.

64{this, "UseDecorations", false, "Use decorations in cleaning tool?"};

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