Inheritance diagram for python.PyAthenaComps.AthFilterAlgorithm:

Collaboration diagram for python.PyAthenaComps.AthFilterAlgorithm:

Public Member Functions
def	__init__ (self, name=None, **kw)

def	cutFlowSvc (self)

def	setFilterDescription (self, descr)

def	sysInitialize (self)

def	setFilterPassed (self, state)

def	evtStore (self)

def	detStore (self)

def	condStore (self)

def	initialize (self)

def	sysReinitialize (self)

def	reinitialize (self)

def	sysExecute (self, cppcontext)

def	execute (self)

def	sysFinalize (self)

def	finalize (self)

def	sysStart (self)

def	start (self)

def	sysStop (self)

def	stop (self)

def	filterPassed (self)

def	resetExecuted (self)

def	setExecuted (self, state)

def	isExecuted (self)

def	getContext (self)

Public Attributes
	cutID

	name

Properties
	FilterDescription

Private Member Functions
def	_get_filter_descr (self)

def	_set_filter_descr (self, descr)

Private Attributes
	_filter_descr
	init base class More...

	_cutflowsvc

	_pyath_evtstore
	init base class More...

	_pyath_detstore

	_pyath_condstore

	_ctx

	__component_type__

Static Private Attributes
string	_dflt_FilterDescription = 'N/A'

Detailed Description

base class for a filter algorithm, making use of the cutflow-svc.

instances of this class (and its derived class) shall have:
 - a `cutID` attribute of type `CutIdentifier*` from `initialize`
   (included) and onwards,
 - a `cutFlowSvc()` method from `initialize` (included) and onwards.

The `cutID` attribute is the CutIdentifier returned by the `ICutFlowSvc`
when `self` registered itself with the `ICutFlowSvc`.

Definition at line 349 of file PyAthenaComps.py.

Constructor & Destructor Documentation

◆ init()

def python.PyAthenaComps.AthFilterAlgorithm.__init__	(		self,
			name = `None`,
		**	kw
	)

Reimplemented from python.PyAthenaComps.Alg.

Definition at line 362 of file PyAthenaComps.py.

     def __init__(self, name = None, **kw):
         if name is None:
             name = kw.get('name', self.__class__.__name__)
         kw['name'] = name
         kw.setdefault('OutputLevel', 3) #INFO
  
         
         super(AthFilterAlgorithm, self).__init__(**kw)
  
         # properties
         self._filter_descr = kw.get('FilterDescription',
                                     AthFilterAlgorithm._dflt_FilterDescription)
         '''describes to the cutflowsvc what this filter does.'''
         return
  

Member Function Documentation

◆ _get_filter_descr()

def python.PyAthenaComps.AthFilterAlgorithm._get_filter_descr ( self )

private

Definition at line 377 of file PyAthenaComps.py.

377 def _get_filter_descr(self):

378 return self._filter_descr

◆ _set_filter_descr()

def python.PyAthenaComps.AthFilterAlgorithm._set_filter_descr	(	self,
		descr
	)

private

Definition at line 379 of file PyAthenaComps.py.

     def _set_filter_descr(self, descr):
         self._filter_descr = descr
         

◆ condStore()

def python.PyAthenaComps.Alg.condStore ( self )

inherited

Definition at line 101 of file PyAthenaComps.py.

     def condStore(self):
         if not self._pyath_condstore:
             import AthenaPython.PyAthena as PyAthena
             self._pyath_condstore = PyAthena.py_svc('StoreGateSvc/ConditionStore')
         return self._pyath_condstore
     

◆ cutFlowSvc()

def python.PyAthenaComps.AthFilterAlgorithm.cutFlowSvc ( self )

Definition at line 386 of file PyAthenaComps.py.

     def cutFlowSvc(self):
         if not hasattr(self, '_cutflowsvc'):
             import AthenaPython.PyAthena as PyAthena
             self._cutflowsvc = PyAthena.py_svc('CutFlowSvc',
                                                iface='ICutFlowSvc')
         return self._cutflowsvc
  

◆ detStore()

def python.PyAthenaComps.Alg.detStore ( self )

inherited

Definition at line 94 of file PyAthenaComps.py.

     def detStore(self):
         if not self._pyath_detstore:
             import AthenaPython.PyAthena as PyAthena
             self._pyath_detstore = PyAthena.py_svc('StoreGateSvc/DetectorStore')
         return self._pyath_detstore
     

◆ evtStore()

def python.PyAthenaComps.Alg.evtStore ( self )

inherited

Definition at line 87 of file PyAthenaComps.py.

     def evtStore(self):
         if not self._pyath_evtstore:
             import AthenaPython.PyAthena as PyAthena
             self._pyath_evtstore = PyAthena.py_svc('StoreGateSvc/StoreGateSvc')
         return self._pyath_evtstore
     

◆ execute()

def python.PyAthenaComps.Alg.execute ( self )

inherited

Definition at line 136 of file PyAthenaComps.py.

     def execute(self):
         return StatusCode.Success
  

◆ filterPassed()

def python.PyAthenaComps.Alg.filterPassed ( self )

inherited

Did this algorithm pass or fail its filter criterion for the last event?

Definition at line 157 of file PyAthenaComps.py.

     def filterPassed(self):
         """Did this algorithm pass or fail its filter criterion for the last event?"""
         return self._cppHandle.filterPassed()
  

◆ finalize()

def python.PyAthenaComps.Alg.finalize ( self )

inherited

Definition at line 142 of file PyAthenaComps.py.

     def finalize(self):
         return StatusCode.Success
  

◆ getContext()

def python.PyAthenaComps.Alg.getContext ( self )

inherited

Definition at line 175 of file PyAthenaComps.py.

     def getContext(self):
        return self._ctx
     

◆ initialize()

def python.PyAthenaComps.Alg.initialize ( self )

inherited

Definition at line 114 of file PyAthenaComps.py.

     def initialize(self):
         return StatusCode.Success
  

◆ isExecuted()

def python.PyAthenaComps.Alg.isExecuted ( self )

inherited

Definition at line 172 of file PyAthenaComps.py.

     def isExecuted(self):
        return self._cppHandle.isExecuted()
  

◆ reinitialize()

def python.PyAthenaComps.Alg.reinitialize ( self )

inherited

Definition at line 124 of file PyAthenaComps.py.

     def reinitialize(self):
         return StatusCode.Success
  

◆ resetExecuted()

def python.PyAthenaComps.Alg.resetExecuted ( self )

inherited

Definition at line 165 of file PyAthenaComps.py.

     def resetExecuted(self):
        self.setExecuted(False)
        return StatusCode.Success
     

◆ setExecuted()

def python.PyAthenaComps.Alg.setExecuted	(	self,
		state
	)

inherited

Definition at line 169 of file PyAthenaComps.py.

     def setExecuted(self,state):
        return self._cppHandle.setExecuted(state)
     

◆ setFilterDescription()

def python.PyAthenaComps.AthFilterAlgorithm.setFilterDescription	(	self,
		descr
	)

This function updates self's CutFlow description if (and only if)
it has not been explicitely set during the python-level configuration

Definition at line 393 of file PyAthenaComps.py.

     def setFilterDescription(self,descr):
         """This function updates self's CutFlow description if (and only if)
         it has not been explicitely set during the python-level configuration
         """
         if hasattr(self,'cutID'):
             if self.FilterDescription==AthFilterAlgorithm._dflt_FilterDescription:
                 self.cutFlowSvc().setFilterDescription(self.cutID,descr)
         else:
             self.msg.error("AthFilterAlg has no self.cutID: could not set filter description.")
         return
  

◆ setFilterPassed()

def python.PyAthenaComps.AthFilterAlgorithm.setFilterPassed	(	self,
		state
	)

Set the filter passed flag to the specified state

Reimplemented from python.PyAthenaComps.Alg.

Definition at line 417 of file PyAthenaComps.py.

     def setFilterPassed(self, state):
         """Set the filter passed flag to the specified state"""
         o = super(AthFilterAlgorithm, self).setFilterPassed(state)
         if state:
             # TODO: we should read a proper weight
             self.cutFlowSvc().addEvent(self.cutID, 1)
         return o
     

◆ start()

def python.PyAthenaComps.Alg.start ( self )

inherited

Definition at line 148 of file PyAthenaComps.py.

     def start(self):
         return StatusCode.Success
  

◆ stop()

def python.PyAthenaComps.Alg.stop ( self )

inherited

Definition at line 154 of file PyAthenaComps.py.

     def stop(self):
         return StatusCode.Success
  

◆ sysExecute()

def python.PyAthenaComps.Alg.sysExecute	(	self,
		cppcontext
	)

inherited

Definition at line 127 of file PyAthenaComps.py.

     def sysExecute(self, cppcontext):
         import cppyy
         self._ctx = cppyy.bind_object(cppcontext, "EventContext")
         try:
             ret = self.execute()
         finally:
             self._ctx = None
         return ret
     

◆ sysFinalize()

def python.PyAthenaComps.Alg.sysFinalize ( self )

inherited

Definition at line 139 of file PyAthenaComps.py.

     def sysFinalize(self):
         return self.finalize()
     

◆ sysInitialize()

def python.PyAthenaComps.AthFilterAlgorithm.sysInitialize ( self )

Reimplemented from python.PyAthenaComps.Alg.

Definition at line 404 of file PyAthenaComps.py.

     def sysInitialize(self):
         if hasattr(self, 'OutputLevel'):
             self.msg.setLevel(self.OutputLevel)
         else:
             self.msg.setLevel(_get_prop_value(self,'OutputLevel'))
         myName=self.name() if callable(self.name) else self.name 
         self.cutID = self.cutFlowSvc().registerFilter(myName, self._filter_descr, True)
         if not self.cutID:
             self.msg.error("could not register filter-cut with cutflowsvc")
             return StatusCode.Failure
         
         return super(AthFilterAlgorithm, self).sysInitialize()
  

◆ sysReinitialize()

def python.PyAthenaComps.Alg.sysReinitialize ( self )

inherited

Definition at line 117 of file PyAthenaComps.py.

     def sysReinitialize(self):
         if hasattr(self, 'OutputLevel'):
             self.msg.setLevel(self.OutputLevel)
         else:
             self.msg.setLevel(_get_prop_value(self,'OutputLevel'))
         return self.reinitialize()
     

◆ sysStart()

def python.PyAthenaComps.Alg.sysStart ( self )

inherited

Definition at line 145 of file PyAthenaComps.py.

     def sysStart(self):
         return self.start()
     

◆ sysStop()

def python.PyAthenaComps.Alg.sysStop ( self )

inherited

Definition at line 151 of file PyAthenaComps.py.

     def sysStop(self):
         return self.stop()
     

Member Data Documentation

◆ __component_type__

python.PyAthenaComps.Alg.__component_type__

privateinherited

Definition at line 82 of file PyAthenaComps.py.

◆ _ctx

python.PyAthenaComps.Alg._ctx

privateinherited

Definition at line 81 of file PyAthenaComps.py.

◆ _cutflowsvc

python.PyAthenaComps.AthFilterAlgorithm._cutflowsvc

private

Definition at line 389 of file PyAthenaComps.py.

◆ _dflt_FilterDescription

string python.PyAthenaComps.AthFilterAlgorithm._dflt_FilterDescription = 'N/A'

staticprivate

Definition at line 360 of file PyAthenaComps.py.

◆ _filter_descr

python.PyAthenaComps.AthFilterAlgorithm._filter_descr

private

init base class

Definition at line 372 of file PyAthenaComps.py.

◆ _pyath_condstore

python.PyAthenaComps.Alg._pyath_condstore

privateinherited

Definition at line 80 of file PyAthenaComps.py.

◆ _pyath_detstore

python.PyAthenaComps.Alg._pyath_detstore

privateinherited

Definition at line 79 of file PyAthenaComps.py.

◆ _pyath_evtstore

python.PyAthenaComps.Alg._pyath_evtstore

privateinherited

init base class

Definition at line 78 of file PyAthenaComps.py.

◆ cutID

python.PyAthenaComps.AthFilterAlgorithm.cutID

Definition at line 410 of file PyAthenaComps.py.

◆ name

python.PyAthenaComps.Alg.name

inherited

Definition at line 83 of file PyAthenaComps.py.

Property Documentation

◆ FilterDescription

python.PyAthenaComps.AthFilterAlgorithm.FilterDescription

static

Initial value:

=  property(_get_filter_descr,
                                 _set_filter_descr,
                                 doc='describes to the cutflowsvc what this filter does.')

Definition at line 382 of file PyAthenaComps.py.

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

PyAthenaComps.py

Public Member Functions

Public Attributes

Properties

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _get_filter_descr()

◆ _set_filter_descr()

◆ condStore()

◆ cutFlowSvc()

◆ detStore()

◆ evtStore()

◆ execute()

◆ filterPassed()

◆ finalize()

◆ getContext()

◆ initialize()

◆ isExecuted()

◆ reinitialize()

◆ resetExecuted()

◆ setExecuted()

◆ setFilterDescription()

◆ setFilterPassed()

◆ start()

◆ stop()

◆ sysExecute()

◆ sysFinalize()

◆ sysInitialize()

◆ sysReinitialize()

◆ sysStart()

◆ sysStop()

Member Data Documentation

◆ __component_type__

◆ _ctx

◆ _cutflowsvc

◆ _dflt_FilterDescription

◆ _filter_descr

◆ _pyath_condstore

◆ _pyath_detstore

◆ _pyath_evtstore

◆ cutID

◆ name

Property Documentation

◆ FilterDescription

◆ init()