python.AlgSequence Namespace Reference

Classes
class	AlgSequence
class	AlgSequenceIterator
class	AthSequencer
	sequence of Gaudi algorithms, to replace the generated configurable More...
class	TestAlgSequenceWithAlgs
	Test case for a sequence with only algorithms in it. More...
class	TestAlgSequenceWithAlgsAndSeqs
	Test case for a sequence with algorithms and sub-sequences. More...

Functions
	AlgSequence (name="AthAlgSeq", **kwargs)
	default algorithm sequence
	iter_algseq (seq)
	helper functions -------------------------------------------------------—
	dumpSequence (seq, indent=0)
	dumpMasterSequence ()

Variables
str	__version__ = '$Revision: 1.21 $'
str	__author__
list	__all__
	AthSequencer
	AlgSequence = CompFactory.AthSequencer

Function Documentation

AlgSequence()

python.AlgSequence.AlgSequence	(		name = "AthAlgSeq",
		**	kwargs )

default algorithm sequence

Convenience method to get the default sequence for algorithms

Definition at line 69 of file Control/AthenaCommon/python/AlgSequence.py.

def AlgSequence( name="AthAlgSeq", **kwargs ):
    """Convenience method to get the default sequence for algorithms"""
    return AthSequencer( name, **kwargs )
 
 

dumpMasterSequence()

python.AlgSequence.dumpMasterSequence

(

)

Helper function to display on screen the current master sequencer layout

Definition at line 113 of file Control/AthenaCommon/python/AlgSequence.py.

def dumpMasterSequence():
    """
    Helper function to display on screen the current master sequencer layout
    """
    # if the application manager has already been setup()'d we just have to
    # dump the AthMasterSeq as all the work has been done for us
    from AthenaCommon.AppMgr import theApp, AthAppMgr
    app_state = theApp.state()
    if app_state != AthAppMgr.State.OFFLINE:
        return dumpSequence( AthSequencer ("AthMasterSeq") )
 
    # otherwise, manually do it...
    dumpSequence( AthSequencer ("AthMasterSeq"), indent=0 )
    dumpSequence( AthSequencer ("athAlgEvtSeq"), indent=1 )
    dumpSequence( AthSequencer ("athBeginSeq"),  indent=2 )
    dumpSequence( AthSequencer ("athAllAlgSeq"), indent=2 )
    dumpSequence( AthSequencer ("athCondSeq"),   indent=3 )
    dumpSequence( AthSequencer ("athAlgSeq"),    indent=3 )
    dumpSequence( AthSequencer ("athEndSeq"),    indent=2 )
    dumpSequence( AthSequencer ("athOutSeq"),    indent=1 )
    dumpSequence( AthSequencer ("athRegSeq"),    indent=1 )

dumpSequence()

python.AlgSequence.dumpSequence	(		seq,
			indent = 0 )

Definition at line 101 of file Control/AthenaCommon/python/AlgSequence.py.

def dumpSequence (seq, indent=0):
    def _dump (seq, indent):
        o = list()
        for c in seq.getChildren():
            o.append( (c.getFullName(), indent) )
            o.extend( _dump (c, indent+1) )
        return o
    out = [(seq.getFullName(),indent)]
    out.extend( _dump( seq, indent=indent+1 ) )
    for n,i in out:
        print ("  "*i,"+--",n)
 

iter_algseq()

python.AlgSequence.iter_algseq

(

seq

)

helper functions -------------------------------------------------------—

iterate over a (possibly nested) ``seq`` AlgSequence.

if the sequence contains nested sub-sequences, everything will be flatten
out in-order.

example:
>>> import AthenaCommon.AlgSequence as acas
>>> aaa = CfgMgr.AthSequencer('aaa')
>>> aaa += CfgMgr.AthSequencer('aaa1')
>>> aaa.aaa1 += CfgMgr.AthSequencer('aaa2')
>>> aaa.aaa1.aaa2 += CfgMgr.AthSequencer('aaa3')
>>> aaa.aaa1.aaa2.aaa3 += CfgMgr.AthSequencer('aaa4')
>>> aaa.aaa1.aaa2.aaa3.aaa4 += CfgMgr.AthSequencer('aaa5')
>>> aaa += CfgMgr.AthSequencer('aaa11')
>>> aaa.aaa11 += CfgMgr.AthSequencer('aaa21')
>>> print ([c.getName() for c in acas.iter_algseq(aaa)])
['aaa', 'aaa1', 'aaa2', 'aaa3', 'aaa4', 'aaa5', 'aaa11', 'aaa21']

Definition at line 75 of file Control/AthenaCommon/python/AlgSequence.py.

def iter_algseq(seq):
    """iterate over a (possibly nested) ``seq`` AlgSequence.
    
    if the sequence contains nested sub-sequences, everything will be flatten
    out in-order.
 
    example:
    >>> import AthenaCommon.AlgSequence as acas
    >>> aaa = CfgMgr.AthSequencer('aaa')
    >>> aaa += CfgMgr.AthSequencer('aaa1')
    >>> aaa.aaa1 += CfgMgr.AthSequencer('aaa2')
    >>> aaa.aaa1.aaa2 += CfgMgr.AthSequencer('aaa3')
    >>> aaa.aaa1.aaa2.aaa3 += CfgMgr.AthSequencer('aaa4')
    >>> aaa.aaa1.aaa2.aaa3.aaa4 += CfgMgr.AthSequencer('aaa5')
    >>> aaa += CfgMgr.AthSequencer('aaa11')
    >>> aaa.aaa11 += CfgMgr.AthSequencer('aaa21')
    >>> print ([c.getName() for c in acas.iter_algseq(aaa)])
    ['aaa', 'aaa1', 'aaa2', 'aaa3', 'aaa4', 'aaa5', 'aaa11', 'aaa21']
    """
    def _iter_algseq(seq):
        yield seq
        for c in seq.getChildren():
            for sub in _iter_algseq(c):
                yield sub
    return _iter_algseq(seq)
 

Variable Documentation

__all__

list python.AlgSequence.__all__

private

Initial value:

=  [ 'AlgSequence', 'AthSequencer',
            'iter_algseq',
            'dumpSequence',
            'dumpMasterSequence']

Definition at line 12 of file Control/AthenaCommon/python/AlgSequence.py.

__author__

str python.AlgSequence.__author__

private

Initial value:

=  """Wim Lavrijsen (WLavrijsen@lbl.gov)
                 Sebastien Binet <binet@cern.ch>
                 """

Definition at line 8 of file Control/AthenaCommon/python/AlgSequence.py.

__version__

str python.AlgSequence.__version__ = '$Revision: 1.21 $'

private

Definition at line 7 of file Control/AthenaCommon/python/AlgSequence.py.

AlgSequence

python.AlgSequence.AlgSequence = CompFactory.AthSequencer

Definition at line 7 of file PhysicsAnalysis/D3PDTools/AnaAlgorithm/python/AlgSequence.py.

AthSequencer

python.AlgSequence.AthSequencer

Definition at line 64 of file Control/AthenaCommon/python/AlgSequence.py.