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

#include <CollisionFilterAlg.h>

Inheritance diagram for CollisionFilterAlg:
Collaboration diagram for CollisionFilterAlg:

Public Member Functions

 CollisionFilterAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual ~CollisionFilterAlg ()=default
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
virtual StatusCode finalize () override
virtual StatusCode sysInitialize () override
 Override sysInitialize.
virtual bool isClonable () const override
 Specify if the algorithm is clonable.
virtual unsigned int cardinality () const override
 Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode sysExecute (const EventContext &ctx) override
 Execute an algorithm.
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies.
virtual bool filterPassed (const EventContext &ctx) const
virtual void setFilterPassed (bool state, const EventContext &ctx) const
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 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

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

ToolHandle< ICaloTimeFilterToolm_calofilter
ToolHandle< IMBTSTimeFilterToolm_mbtsfilter
SG::ReadHandleKey< TileCellContainerm_MBTS_key {this, "MBTSContainerKey", "MBTSContainer", ""}
SG::ReadHandleKey< LArCollisionTimem_LArTimeKey {this, "LARCollisionTimeKey","LArCollisionTime" , "" }
Gaudi::Property< unsigned int > m_prescale {this, "CounterPrescale", 1000}
Gaudi::Property< bool > m_doCaloTimeFilter {this, "DoCaloTimeFilter" , true}
Gaudi::Property< bool > m_doMBTSTimeFilter {this, "DoMBTSTimeFilter" , true}
std::atomic< unsigned int > m_counter {0}
std::atomic< unsigned int > m_caloaccept {0}
std::atomic< unsigned int > m_mbtsaccept {0}
std::atomic< unsigned int > m_overlap {0}
DataObjIDColl m_extendedExtraObjects
 Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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 20 of file CollisionFilterAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CollisionFilterAlg()

CollisionFilterAlg::CollisionFilterAlg ( const std::string & name,
ISvcLocator * pSvcLocator )

Definition at line 11 of file CollisionFilterAlg.cxx.

12 : AthReentrantAlgorithm(name, pSvcLocator)
13 , m_calofilter("CaloTimeFilterTool")
14 , m_mbtsfilter("MBTSTimeFilterTool"){
15 declareProperty( "CaloTimeFilterTool", m_calofilter, "The instance of the CaloTimeFilterTool" );
16 declareProperty( "MBTSTimeFilterTool", m_mbtsfilter, "The instance of the MBTSTimeFilterTool" );
17}
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
ToolHandle< ICaloTimeFilterTool > m_calofilter
ToolHandle< IMBTSTimeFilterTool > m_mbtsfilter

◆ ~CollisionFilterAlg()

virtual CollisionFilterAlg::~CollisionFilterAlg ( )
virtualdefault

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const
overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

64{
65 return 0;
66}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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 }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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 CollisionFilterAlg::execute ( const EventContext & ctx) const
overridevirtual

Definition at line 42 of file CollisionFilterAlg.cxx.

43{
44 StatusCode sc = StatusCode::SUCCESS;
45
46 ATH_MSG_DEBUG ("execute()");
47
48 if (m_counter % m_prescale == 0)
49 ATH_MSG_DEBUG ("Now processing event : " << m_counter);
50 ++m_counter;
51
53
54 bool pass(false);
55
56 TimingFilterInformation MBTS;
57 TimingFilterInformation Calo;
58
60
62 sc = m_calofilter->getTimeDifference(Calo, m_LArTimeKey, ctx);
63 if ( sc.isFailure() ) {
64 ATH_MSG_WARNING (m_calofilter.propertyName() << ": Failed to execute tool " << m_calofilter.type());
65 return StatusCode::SUCCESS;
66 }
67 if (Calo.passCut) {
68 ATH_MSG_DEBUG ("Event accepted by CaloTimeFilter.");
70 } else
71 ATH_MSG_DEBUG ("Event rejected by CaloTimeFilter.");
72 }
73
75
77 sc = m_mbtsfilter->getTimeDifference(MBTS, m_MBTS_key,ctx);
78 if ( sc.isFailure() ) {
79 ATH_MSG_WARNING (m_mbtsfilter.propertyName() << ": Failed to execute tool " << m_mbtsfilter.type());
80 return StatusCode::SUCCESS;
81 }
82 if (MBTS.passCut) {
83 ATH_MSG_DEBUG ("Event accepted by MBTSTimeFilter.");
85 } else
86 ATH_MSG_DEBUG ("Event rejected by MBTSTimeFilter.");
87 }
88
90
91 if (m_doCaloTimeFilter) pass = pass || Calo.passCut;
92 if (m_doMBTSTimeFilter) pass = pass || MBTS.passCut;
94 ATH_MSG_DEBUG ("Event accepted as collision ? " << pass);
95 setFilterPassed (pass,ctx); // This skips the execution of following algs for this event
96 }
97
99 if (Calo.passCut && MBTS.passCut) ++m_overlap;
100
102
103 ATH_MSG_DEBUG ("execute() successful");
104
105 return StatusCode::SUCCESS;
106}
#define ATH_MSG_WARNING(x)
#define ATH_MSG_DEBUG(x)
static Double_t sc
virtual void setFilterPassed(bool state, const EventContext &ctx) const
std::atomic< unsigned int > m_overlap
std::atomic< unsigned int > m_mbtsaccept
Gaudi::Property< unsigned int > m_prescale
Gaudi::Property< bool > m_doCaloTimeFilter
SG::ReadHandleKey< TileCellContainer > m_MBTS_key
Gaudi::Property< bool > m_doMBTSTimeFilter
SG::ReadHandleKey< LArCollisionTime > m_LArTimeKey
std::atomic< unsigned int > m_caloaccept
std::atomic< unsigned int > m_counter
::StatusCode StatusCode
StatusCode definition for legacy code.

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

90{
91 // If we didn't find any symlinks to add, just return the collection
92 // from the base class. Otherwise, return the extended collection.
93 if (!m_extendedExtraObjects.empty()) {
95 }
97}
An algorithm that can be simultaneously executed in multiple threads.

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

96 {
97 return execState( ctx ).filterPassed();
98 }
virtual bool filterPassed(const EventContext &ctx) const

◆ finalize()

StatusCode CollisionFilterAlg::finalize ( )
overridevirtual

Definition at line 109 of file CollisionFilterAlg.cxx.

110{
111 ATH_MSG_DEBUG ("finalize()");
112
113 if (m_doCaloTimeFilter) ATH_MSG_INFO ("CaloTimeFilter : Processed " << m_counter << " events, accepted " << m_caloaccept << " events.");
114 if (m_doMBTSTimeFilter) ATH_MSG_INFO ("MBTSTimeFilter : Processed " << m_counter << " events, accepted " << m_mbtsaccept << " events.");
115
117 ATH_MSG_INFO ("Overlapping accept : " << m_overlap << " events.");
118
119 return StatusCode::SUCCESS;
120}
#define ATH_MSG_INFO(x)

◆ initialize()

StatusCode CollisionFilterAlg::initialize ( )
overridevirtual

Retrieve the CaloTimeFilter tool using the ToolHandles

Retrieve the mbts timefilter tool using the ToolHandles

Definition at line 19 of file CollisionFilterAlg.cxx.

20{
21 ATH_MSG_DEBUG ("initialize()");
22
25 ATH_CHECK(m_calofilter.retrieve());
26 }
28
31 ATH_CHECK(m_mbtsfilter.retrieve());
32 }
34
35 ATH_MSG_DEBUG ("initialize() successful");
36
37 return StatusCode::SUCCESS;
38}
#define ATH_CHECK
Evaluate an expression and check for errors.

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

◆ isClonable()

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

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

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state,
const EventContext & ctx ) const
inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100 {
102 }

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx)
overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

77{
78 return BaseAlg::sysExecute (ctx);
79}

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )
overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

107 {
109
110 if (sc.isFailure()) {
111 return sc;
112 }
113
114 ServiceHandle<ICondSvc> cs("CondSvc",name());
115 for (auto h : outputHandles()) {
116 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
117 // do this inside the loop so we don't create the CondSvc until needed
118 if ( cs.retrieve().isFailure() ) {
119 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
120 return StatusCode::SUCCESS;
121 }
122 if (cs->regHandle(this,*h).isFailure()) {
124 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125 << " with CondSvc");
126 }
127 }
128 }
129 return sc;
130}
#define ATH_MSG_ERROR(x)
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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 }

Member Data Documentation

◆ m_caloaccept

std::atomic<unsigned int> CollisionFilterAlg::m_caloaccept {0}
mutableprivate

Definition at line 46 of file CollisionFilterAlg.h.

46{0};

◆ m_calofilter

ToolHandle<ICaloTimeFilterTool> CollisionFilterAlg::m_calofilter
private

Definition at line 32 of file CollisionFilterAlg.h.

◆ m_counter

std::atomic<unsigned int> CollisionFilterAlg::m_counter {0}
mutableprivate

Definition at line 44 of file CollisionFilterAlg.h.

44{0};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doCaloTimeFilter

Gaudi::Property<bool> CollisionFilterAlg::m_doCaloTimeFilter {this, "DoCaloTimeFilter" , true}
private

Definition at line 40 of file CollisionFilterAlg.h.

40{this, "DoCaloTimeFilter" , true};

◆ m_doMBTSTimeFilter

Gaudi::Property<bool> CollisionFilterAlg::m_doMBTSTimeFilter {this, "DoMBTSTimeFilter" , true}
private

Definition at line 41 of file CollisionFilterAlg.h.

41{this, "DoMBTSTimeFilter" , true};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_LArTimeKey

SG::ReadHandleKey<LArCollisionTime> CollisionFilterAlg::m_LArTimeKey {this, "LARCollisionTimeKey","LArCollisionTime" , "" }
private

Definition at line 36 of file CollisionFilterAlg.h.

36{this, "LARCollisionTimeKey","LArCollisionTime" , "" };

◆ m_MBTS_key

SG::ReadHandleKey<TileCellContainer> CollisionFilterAlg::m_MBTS_key {this, "MBTSContainerKey", "MBTSContainer", ""}
private

Definition at line 35 of file CollisionFilterAlg.h.

35{this, "MBTSContainerKey", "MBTSContainer", ""};

◆ m_mbtsaccept

std::atomic<unsigned int> CollisionFilterAlg::m_mbtsaccept {0}
mutableprivate

Definition at line 47 of file CollisionFilterAlg.h.

47{0};

◆ m_mbtsfilter

ToolHandle<IMBTSTimeFilterTool> CollisionFilterAlg::m_mbtsfilter
private

Definition at line 33 of file CollisionFilterAlg.h.

◆ m_overlap

std::atomic<unsigned int> CollisionFilterAlg::m_overlap {0}
mutableprivate

Definition at line 48 of file CollisionFilterAlg.h.

48{0};

◆ m_prescale

Gaudi::Property<unsigned int> CollisionFilterAlg::m_prescale {this, "CounterPrescale", 1000}
private

Definition at line 39 of file CollisionFilterAlg.h.

39{this, "CounterPrescale", 1000};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files: