GaudiAlg.Algs Namespace Reference

Classes
class	GaudiAlgo
class	HistoAlgo
class	objectmethod
class	TupleAlgo
class	TupleDecColumnDispatcher

Functions
def	_tool_ (self, interface, typename, name=None, parent=None, create=True)
def	_service_ (self, interface, name, create=True)
def	_init_ (self, name, **args)
def	_initialize_ (self)
def	_initialize_histo_ (self)
def	_initialize_tuple_ (self)
def	_evtSvc (self, location=None)
def	_detSvc (self, location=None)
def	_histoSvc (self, address=None)
def	_get (self, location)
def	_getDet (self, location)
def	_get_ (self, location, rootInTES=True)
def	_exist_ (self, location, rootInTES=True)
def	_ntupleSvc (self)
def	_evtcolSvc (self)
def	_finalize_ (self)
def	_success_ (self)
def	_hasProperty_ (self, pname)
def	_getProperty_ (self, pname)
def	_setProperty_ (self, pname, pvalue)
def	_get_attr_ (self, pname)
def	_set_attr_ (self, pname, pvalue)
def	_start_ (self)
def	_execute_ (self)
def	_stop_ (self)
def	_plot1D_ (s, *a)
def	_plot2D_ (s, *a)
def	_plot3D_ (s, *a)
def	_profile1D_ (s, *a)
def	_profile2D_ (s, *a)
def	_decorate_plots_ (klasses)
def	_nTuple_ (s, *a)
def	_evtCol_ (s, *a)
def	_decorate_tuples_ (klasses)
def	_t_nTuple_ (s, *a)
def	_t_ntuple_ (s, *a)
def	_t_valid_ (s, *a)
def	_t_write_ (s, *a)
def	_t_column_ (s, *a)
def	_t_column_ll_ (s, *a)
def	_t_column_ull_ (s, *a)
def	_t_array_ (s, *a)
def	_t_matrix_ (s, *a)
def	_t_farray_ (s, *a)
def	_t_fmatrix_ (s, *a)
def	_decorate_algs_ (klasses)
def	mapvct (func, sequence, ovct=None)
def	_get_all_tools_ (self, method)
def	_Tools_a_ (self)
def	_Tools_t_ (self)
def	_get_counter_ (self, method, name)
def	_Counter_a_ (self, name)
def	_Counter_t_ (self, name)
def	_get_all_histos_ (component, method, name)
def	_Histos_a_ (self, name=None)
def	_Histos_t_ (self, name=None)
def	_help_ ()

Variables
string	__author__ = "Vanya BELYAEV Ivan.Belyaev@lapp.in2p3.fr"
tuple	__all__
	iAlgorithm = GaudiPython.Bindings.iAlgorithm
	iAlgTool = GaudiPython.Bindings.iAlgTool
	std
	Vector
	Matrix
	HID
	HistoID
	TID
	TupleID
	AlgDecorator
	HistoDecorator
	TupleAlgDecorator
	TupleDecorator
	_GaudiAlgorithm
	_GaudiHistoAlg
	_GaudiTupleAlg
	Tuple
	_Dec
	column
	_alg_map_
	_ialg
	_evtSvc_
	_detSvc_
	_histoSvc_
	_ntupleSvc_
	_evtcolSvc_

Function Documentation

_Counter_a_()

def GaudiAlg.Algs._Counter_a_ (   self,   name  )

private

Retrieve the counter managed GaudiCommon<TYPE> base by name:

>>> alg  = ...                     ## get the algorithm
>>> cnt  = alg.Counter('#accept')  ## get the counter
>>> print(cnt)

Definition at line 1455 of file Algs.py.

def _Counter_a_(self, name):
    """
    Retrieve the counter managed GaudiCommon<TYPE> base by name:
 
    >>> alg  = ...                     ## get the algorithm
    >>> cnt  = alg.Counter('#accept')  ## get the counter
    >>> print(cnt)
 
    """
    _cmp = getattr(self, "_ialg")
    if not _cmp:
        self.retrieveInterface()
    _cmp = getattr(self, "_ialg")
    return _get_counter_(_cmp, "_counter_a_", name)
 
 
# ==============================================================================
 
 

_Counter_t_()

def GaudiAlg.Algs._Counter_t_ (   self,   name  )

private

Retrieve the counter managed GaudiCommon<TYPE> base by name:

>>> tool = ...                      ## get the tool
>>> cnt  = tool.Counter('#accept')  ## get the counter
>>> print(cnt)

Definition at line 1474 of file Algs.py.

def _Counter_t_(self, name):
    """
    Retrieve the counter managed GaudiCommon<TYPE> base by name:
 
    >>> tool = ...                      ## get the tool
    >>> cnt  = tool.Counter('#accept')  ## get the counter
    >>> print(cnt)
 
    """
    _cmp = getattr(self, "_itool")
    if not _cmp:
        self.retrieveInterface()
    _cmp = getattr(self, "_itool")
    return _get_counter_(_cmp, "_counter_t_", name)
 
 
# =============================================================================
# get all histos
# =============================================================================
cpp.GaudiAlg.ID.__repr__ = cpp.GaudiAlg.ID.idAsString
cpp.GaudiAlg.ID.__str__ = cpp.GaudiAlg.ID.idAsString
cpp.StatEntity.__repr__ = cpp.StatEntity.toString
cpp.StatEntity.__str__ = cpp.StatEntity.toString
 
# =============================================================================
 
 

_decorate_algs_()

def GaudiAlg.Algs._decorate_algs_ (   klasses )

private

Definition at line 1341 of file Algs.py.

def _decorate_algs_(klasses):
    t = type(klasses)
    if not issubclass(t, list) and not issubclass(t, tuple):
        klasses = [klasses]
    for _alg in klasses:
        for key in _alg_map_:
            setattr(_alg, key, _alg_map_[key])
 
 
# =
_decorate_algs_(GaudiAlgo)
_decorate_algs_(HistoAlgo)
_decorate_algs_(TupleAlgo)
 
# =============================================================================
# Helper function to fill histogram/ntuple using 'map'-operation
# =============================================================================
 
 

_decorate_plots_()

def GaudiAlg.Algs._decorate_plots_ (   klasses )

private

Definition at line 1116 of file Algs.py.

def _decorate_plots_(klasses):
    t = type(klasses)
    if not issubclass(t, list) and not issubclass(t, tuple):
        klasses = [klasses]
    for klass in klasses:
        klass.plot = _plot1D_
        klass.plot1D = _plot1D_
        klass.plot2D = _plot2D_
        klass.plot3D = _plot3D_
        klass.profile1D = _profile1D_
        klass.profile2D = _profile2D_
 
 
_decorate_plots_(HistoAlgo)
_decorate_plots_(TupleAlgo)
 
 
# =============================================================================

_decorate_tuples_()

def GaudiAlg.Algs._decorate_tuples_ (   klasses )

private

Definition at line 1155 of file Algs.py.

def _decorate_tuples_(klasses):
    t = type(klasses)
    if not issubclass(t, list) and not issubclass(t, tuple):
        klasses = [klasses]
    for klass in klasses:
        klass.nTuple = _nTuple_
        klass.evtCol = _evtCol_
        klass.ntupleSvc = _ntupleSvc
        klass.tupleSvc = _ntupleSvc
        klass.ntupSvc = _ntupleSvc
        klass.tupSvc = _ntupleSvc
        klass.evtColSvc = _evtcolSvc
        klass.evtcolSvc = _evtcolSvc
 
 
# ==========================================================
_decorate_tuples_(TupleAlgo)
 
# "decorate N-Tuple object

_detSvc()

def GaudiAlg.Algs._detSvc (   self,   location = None  )

private

Trivial helper function to access Detector Data and Event Data Service

Usage:
# get detector data service
svc = self.detSvc()

# get the data
lhcb = self.detSvc('/dd/Structure/LHCb')

Definition at line 360 of file Algs.py.

def _detSvc(self, location=None):
    """
    Trivial helper function to access Detector Data and Event Data Service
 
    Usage:
    # get detector data service
    svc = self.detSvc()
 
    # get the data
    lhcb = self.detSvc('/dd/Structure/LHCb')
    """
    if location is None:
        return self._detSvc_
    return self._detSvc_[location]
 
 
# =============================================================================
# Trivial helper function to access Histogram  Data and Histogram  Data Service
#
#    Usage:
#
#  @code
#
#    # get histogram data service
#    svc = self.histoSvc()
#
#    # get the data
#    histo = self.histoSvc('/stat/Calo/1')
#
#  @endcode
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_evtCol_()

def GaudiAlg.Algs._evtCol_ (   s, *  a  )

private

Retrieve (book-on-demand) N-Tuple object for Event Tag Collections

Definition at line 1144 of file Algs.py.

def _evtCol_(s, *a):
    """
    Retrieve (book-on-demand) N-Tuple object for Event Tag Collections
    """
    return TupleAlgDecorator.evtCol(s, *a)
 
 
_nTuple_.__doc__ += "\n" + TupleAlgDecorator.nTuple.__doc__
_evtCol_.__doc__ += "\n" + TupleAlgDecorator.evtCol.__doc__
 
 

_evtcolSvc()

def GaudiAlg.Algs._evtcolSvc (   self )

private

Trivial function to access Event Collection Service

Definition at line 473 of file Algs.py.

def _evtcolSvc(self):
    """
    Trivial function to access Event Collection Service
    """
    return self._evtcolSvc_
 
 
# =============================================================================
# The default finalization (finalization of base C++ class)

_evtSvc()

def GaudiAlg.Algs._evtSvc (   self,   location = None  )

private

Trivial helper function to access Event Data and Event Data Service

Usage:

# get event data service
svc = self.evtSvc()

# get the data
hits = self.evtSvc('MC/Calo/Hits')

Definition at line 324 of file Algs.py.

def _evtSvc(self, location=None):
    """
    Trivial helper function to access Event Data and Event Data Service
 
    Usage:
 
    # get event data service
    svc = self.evtSvc()
 
    # get the data
    hits = self.evtSvc('MC/Calo/Hits')
    """
    if not location:
        return self._evtSvc_
    return self._evtSvc_[location]
 
 
# =============================================================================
# Trivial helper function to access Detector Data and Detector  Data Service
#
#    Usage:
#
#  @code
#
#    # get detector data service
#    svc = self.detSvc()
#
#    # get the data
#    lhcb = self.detSvc('/dd/Structure/LHCb')
#
#  @endcode
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_execute_()

def GaudiAlg.Algs._execute_ (   self )

private

The fictive 'execute' method, which MUST be overwitten by user

Definition at line 961 of file Algs.py.

def _execute_(self):
    """
    The fictive 'execute' method, which MUST be overwitten by user
    """
    raise RuntimeError("Execute method is not implemented for %s" % self.name())
 
 
GaudiAlgo.execute = _execute_
HistoAlgo.execute = _execute_
TupleAlgo.execute = _execute_
 
 

_exist_()

def GaudiAlg.Algs._exist_ (   self,   location,   rootInTES = True  )

private

Check  the object in Transient Event Store using GaudiCommon machinery,
respecting RootInTES behaviour

Definition at line 450 of file Algs.py.

def _exist_(self, location, rootInTES=True):
    """
    Check  the object in Transient Event Store using GaudiCommon machinery,
    respecting RootInTES behaviour
    """
    return AlgDecorator.exist_(self, location, rootInTES)
 
 
# =============================================================================
# Trivial helper function to access NTuple Service
 
 

_finalize_()

def GaudiAlg.Algs._finalize_ (   self )

private

The default finalization : finalize the base C++ class

Definition at line 482 of file Algs.py.

def _finalize_(self):
    """
    The default finalization : finalize the base C++ class
    """
    status = self._Base.finalize_(self)
    return status
 
 
# =============================================================================
# Dummy method returning success
 
 

_get()

def GaudiAlg.Algs._get (   self,   location  )

private

Trivial function to access the data in TES using the data service

Definition at line 416 of file Algs.py.

def _get(self, location):
    """
    Trivial function to access the data in TES using the data service
    """
    return self._evtSvc_[location]
 
 
# =============================================================================
# Trivial function to access the data in TDS
 
 

_get_()

def GaudiAlg.Algs._get_ (   self,   location,   rootInTES = True  )

private

Get the object from Transient Event Store using GaudiCommon machinery,
respecting RootInTES behaviour

Definition at line 438 of file Algs.py.

def _get_(self, location, rootInTES=True):
    """
    Get the object from Transient Event Store using GaudiCommon machinery,
    respecting RootInTES behaviour
    """
    return AlgDecorator.get_(self, location, rootInTES)
 
 
# =============================================================================
# check the data from TES using GaudiCommon methods, respecting RootInTES
 
 

_get_all_histos_()

def GaudiAlg.Algs._get_all_histos_ (   component,   method,   name  )

private

Get All histogram form the component

Definition at line 1501 of file Algs.py.

def _get_all_histos_(component, method, name):
    """
    Get All histogram form the component
    """
    _res = {}
    for _his in (
        std.vector("AIDA::IProfile2D*"),
        std.vector("AIDA::IProfile1D*"),
        std.vector("AIDA::IHistogram3D*"),
        std.vector("AIDA::IHistogram2D*"),
        std.vector("AIDA::IHistogram1D*"),
    ):
        _his = _his()
        _ids = std.vector("GaudiAlg::ID")()
        _fun = getattr(HistoDecorator, method)
        _num = _fun(component, _ids, _his)
        if _ids.size() != _num or _his.size() != _num:
            raise RuntimeError("Unable to extract Histos!")
        for _i in range(0, _num):
            _id = _ids[_i]
            if _id.numeric():
                _id = _id.numericID()
            elif _id.literal():
                _id = _id.literalID()
            else:
                _id = _id.idAsString()
            _res[_id] = _his[_i]
 
    if not name:
        return _res  # return the dictionary
 
    id = cpp.GaudiAlg.ID(name)
    for i in (name, id.literalID(), id.numericID(), id.idAsString(), id):
        h = _res.get(i, None)
        if not not h:
            return h  # return the histogram
 
    return None
 
 
# =============================================================================
 
 

_get_all_tools_()

def GaudiAlg.Algs._get_all_tools_ (   self,   method  )

private

Get all tools

Definition at line 1382 of file Algs.py.

def _get_all_tools_(self, method):
    """
    Get all tools
    """
    _tools = std.vector("IAlgTool*")()
    _func = getattr(AlgDecorator, method)
    _num = _func(self, _tools)
    if _tools.size() != _num:
        raise RuntimeError("Unable to extract Tools")
    _res = []
    for _tool in _tools:
        _res += [iAlgTool(_tool.name(), _tool)]
    return _res
 
 
# =============================================================================
 
 

_get_attr_()

def GaudiAlg.Algs._get_attr_ (   self,   pname  )

private

Get the attribute (or property)
- if the attribute name corresponds to the property name, property value is returned

Definition at line 537 of file Algs.py.

def _get_attr_(self, pname):
    """
    Get the attribute (or property)
    - if the attribute name corresponds to the property name, property value is returned
    """
    if self.hasProperty(pname):
        return self._ialg.__getattr__(pname)
    else:
        # Since self does not inherit from iAlgorithm (see !1116, 4f05f03678),
        # delegate attribute lookup to self._ialg.
        try:
            return getattr(self._ialg, pname)
        except AttributeError:
            pass
    raise AttributeError("attribute/property %s does not exist" % pname)
 
 
# =============================================================================
# set the attribute or property
 
 

_get_counter_()

def GaudiAlg.Algs._get_counter_ (   self,   method,   name  )

private

get the counter

Definition at line 1444 of file Algs.py.

def _get_counter_(self, method, name):
    """
    get the counter
    """
    _func = getattr(AlgDecorator, method)
    return _func(self, name)
 
 
# ==============================================================================
 
 

_getDet()

def GaudiAlg.Algs._getDet (   self,   location  )

private

Trivial function to access the data in TDS using data service

Definition at line 427 of file Algs.py.

def _getDet(self, location):
    """
    Trivial function to access the data in TDS using data service
    """
    return self._detSvc_[location]
 
 
# =============================================================================
# get the data from TES using GaudiCommon methods, respecting RootInTES
 
 

_getProperty_()

def GaudiAlg.Algs._getProperty_ (   self,   pname  )

private

Get the property by name

Definition at line 511 of file Algs.py.

def _getProperty_(self, pname):
    """
    Get the property by name
    """
    if not self.hasProperty(pname):
        raise AttributeError("property %s does not exist" % pname)
    return self._ialg.__getattr__(pname)
 
 
# =============================================================================
# set the value for the given property
 
 

_hasProperty_()

def GaudiAlg.Algs._hasProperty_ (   self,   pname  )

private

The trivial function which checks the existence of the property with given name

Definition at line 500 of file Algs.py.

def _hasProperty_(self, pname):
    """
    The trivial function which checks the existence of the property with given name
    """
    return cpp.Gaudi.Utils.hasProperty(self, pname)
 
 
# =============================================================================
# get the value of the given property
 
 

_help_()

def GaudiAlg.Algs._help_ ( )

private

Definition at line 1617 of file Algs.py.

def _help_():
    print(__doc__, __author__)
    print("\t\t\tDoc-string for class GaudiAlgo \n", GaudiAlgo.__doc__)
    print("\t\t\tDoc-string for class HistoAlgo \n", HistoAlgo.__doc__)
    print("\t\t\tDoc-string for class TupleAlgo \n", TupleAlgo.__doc__)
 
 
# =============================================================================
# pseudo-test suite
# =============================================================================

_Histos_a_()

def GaudiAlg.Algs._Histos_a_ (   self,   name = None  )

private

Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:

>>> alg = ...              ## get the algorithm
>>> histos = alg.Histos()  ## get all histograms & profiles
>>> for key in histos :
...        print(key, histos[key])

Retrive the histogram with the certain ID :

>>> alg = ...                           ## get the algorithm
>>> histo = alg.Histos('some histo ID') ## get the histo by ID
>>> print(histo)

Definition at line 1544 of file Algs.py.

def _Histos_a_(self, name=None):
    """
    Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:
 
    >>> alg = ...              ## get the algorithm
    >>> histos = alg.Histos()  ## get all histograms & profiles
    >>> for key in histos :
    ...        print(key, histos[key])
 
    Retrive the histogram with the certain ID :
 
    >>> alg = ...                           ## get the algorithm
    >>> histo = alg.Histos('some histo ID') ## get the histo by ID
    >>> print(histo)
 
    """
    _cmp = getattr(self, "_ialg")
    if not _cmp:
        self.retrieveInterface()
    _cmp = getattr(self, "_ialg")
    return _get_all_histos_(_cmp, "_histos_a_", name)
 
 
# =============================================================================
 
 

_Histos_t_()

def GaudiAlg.Algs._Histos_t_ (   self,   name = None  )

private

Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:

>>> tool = ...              ## get the tool
>>> histos = tool.Histos()  ## get all histograms & profiles
>>> for key in histos :
...        print(key, histos[key])

Retrive the historgam with certain ID :

>>> tool = ...                           ## get the tool
>>> histo = tool.Histos('some histo ID') ## get the histo by ID
>>> print(histo)

Definition at line 1570 of file Algs.py.

def _Histos_t_(self, name=None):
    """
    Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:
 
    >>> tool = ...              ## get the tool
    >>> histos = tool.Histos()  ## get all histograms & profiles
    >>> for key in histos :
    ...        print(key, histos[key])
 
    Retrive the historgam with certain ID :
 
    >>> tool = ...                           ## get the tool
    >>> histo = tool.Histos('some histo ID') ## get the histo by ID
    >>> print(histo)
 
    """
    _cmp = getattr(self, "_itool")
    if not _cmp:
        self.retrieveInterface()
    _cmp = getattr(self, "_itool")
    return _get_all_histos_(_cmp, "_histos_t_", name)
 
 
# =============================================================================
 
_Tools_a_.__doc__ += "\n" + AlgDecorator._tools_a_.__doc__
_Tools_t_.__doc__ += "\n" + AlgDecorator._tools_t_.__doc__
_Counter_a_.__doc__ += "\n" + AlgDecorator._counter_a_.__doc__
_Counter_t_.__doc__ += "\n" + AlgDecorator._counter_t_.__doc__
_Histos_a_.__doc__ += "\n" + HistoDecorator._histos_a_.__doc__
_Histos_t_.__doc__ += "\n" + HistoDecorator._histos_t_.__doc__
 
iAlgorithm.Tools = _Tools_a_
iAlgTool.Tools = _Tools_t_
iAlgorithm.Counter = _Counter_a_
iAlgTool.Counter = _Counter_t_
iAlgorithm.Histos = _Histos_a_
iAlgTool.Histos = _Histos_t_
 
# finally add some decoration for histograms

_histoSvc()

def GaudiAlg.Algs._histoSvc (   self,   address = None  )

private

Trivial helper function to access Histogram  Data and Histogram  Data Service

Usage:

# get histogram data service
svc = self.histoSvc()

# get the data
histo = self.histoSvc('/stat/Calo/1')

Definition at line 395 of file Algs.py.

def _histoSvc(self, address=None):
    """
    Trivial helper function to access Histogram  Data and Histogram  Data Service
 
    Usage:
 
    # get histogram data service
    svc = self.histoSvc()
 
    # get the data
    histo = self.histoSvc('/stat/Calo/1')
    """
    if not address:
        return self._histoSvc_
    return self._histoSvc_[address]
 
 
# =============================================================================
# Trivial function to access the data in TES
 
 

_init_()

def GaudiAlg.Algs._init_ (   self,   name, **  args  )

private

The constructor from unique algorithm instance name & parameters

Definition at line 207 of file Algs.py.

def _init_(self, name, **args):
    """
    The constructor from unique algorithm instance name & parameters
    """
    self._Base.__init__(self, self, name)
    appMgr = AppMgr()
    algMgr = appMgr._algmgr
    status = algMgr.addAlgorithm(self)
    if status.isFailure():
        raise RuntimeError('Unable to add Algorithm "' + name + '"')
    self._ialg = iAlgorithm(name, self)
    for key in args:
        setattr(self, key, args[key])
    # take some care about the ownership of the algorithms
    if "GaudiPythonAlgos" not in appMgr.__dict__:
        appMgr.__dict__["GaudiPythonAlgos"] = []
    appMgr.__dict__["GaudiPythonAlgos"].append(self)
 
 
# =============================================================================
# The default initialization (initialization of base C++ class + data
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_initialize_()

def GaudiAlg.Algs._initialize_ (   self )

private

The default initialization (initialization of base C++ class + data)

Definition at line 233 of file Algs.py.

def _initialize_(self):
    """
    The default initialization (initialization of base C++ class + data)
    """
    status = self._Base.initialize_(self)
    if status.isFailure():
        return status
 
    # set the basic services
    _e = self._Base.evtSvc(self)
    _s = InterfaceCast(cpp.IService)(_e)
    self._evtSvc_ = iDataSvc(_s.name(), _e)
 
    _d = self._Base.detSvc(self)
    _s = InterfaceCast(cpp.IService)(_d)
    self._detSvc_ = iDataSvc(_s.name(), _d)
 
    return status
 
 
# =============================================================================
# The default initialization (initialization of base C++ class + data members)
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_initialize_histo_()

def GaudiAlg.Algs._initialize_histo_ (   self )

private

The default initialization (initialization of base C++ class + data members)

Definition at line 260 of file Algs.py.

def _initialize_histo_(self):
    """
    The default initialization (initialization of base C++ class + data members)
    """
    status = _initialize_(self)
    if status.isFailure():
        return status
 
    # set the basic services
    _h = self._Base.histoSvc(self)
    _s = InterfaceCast(cpp.IService)(_h)
    self._histoSvc_ = iHistogramSvc(_s.name(), _h)
 
    return status
 
 
# =============================================================================
# The default initialization (initialization of base C++ class + data members)
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_initialize_tuple_()

def GaudiAlg.Algs._initialize_tuple_ (   self )

private

The default initialization (initialization of base C++ class + data members)

Definition at line 283 of file Algs.py.

def _initialize_tuple_(self):
    """
    The default initialization (initialization of base C++ class + data members)
    """
    status = _initialize_histo_(self)
    if status.isFailure():
        return status
 
    # set the basic services
    if self.produceNTuples():
        _n = self._Base.ntupleSvc(self)
        _s = InterfaceCast(cpp.IService)(_n)
        self._ntupleSvc_ = iNTupleSvc(_s.name(), _n)
 
    if self.produceEvtCols():
        _n = self._Base.evtColSvc(self)
        _s = InterfaceCast(cpp.IService)(_n)
        self._evtcolSvc_ = iNTupleSvc(_s.name(), _n)
 
    return status
 
 
# =============================================================================
# Trivial helper function to access Event Data and Event Data Service
#
#    Usage:
#
#  @code
#
#    # get event data service
#    svc = self.evtSvc()
#
#    # get the data
#    hits = self.evtSvc('MC/Calo/Hits')
#
#  @endcode
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_nTuple_()

def GaudiAlg.Algs._nTuple_ (   s, *  a  )

private

Retrieve (book-on-demand) N-Tuple object

Definition at line 1134 of file Algs.py.

def _nTuple_(s, *a):
    """
    Retrieve (book-on-demand) N-Tuple object
    """
    return TupleAlgDecorator.nTuple(s, *a)
 
 
# =============================================================================
 
 

_ntupleSvc()

def GaudiAlg.Algs._ntupleSvc (   self )

private

Trivial function to access N-Tuple Service

Definition at line 462 of file Algs.py.

def _ntupleSvc(self):
    """
    Trivial function to access N-Tuple Service
    """
    return self._ntupleSvc_
 
 
# =============================================================================
# Trivial helper function to access Event Collection Service
 
 

_plot1D_()

def GaudiAlg.Algs._plot1D_ (   s, *  a  )

private

The basic method to fill (book-on-demand) 1D-histogram

The histogram will be created/booked dautomatically according to the
specifications:

   - literal or numerical ID (optional)
   - title
   - low edge
   - high edge
   - number of bins (default is 100)

The reference to the histogram is returned and could be used for later manipulations

Definition at line 988 of file Algs.py.

def _plot1D_(s, *a):
    """
    The basic method to fill (book-on-demand) 1D-histogram
 
    The histogram will be created/booked dautomatically according to the
    specifications:
 
       - literal or numerical ID (optional)
       - title
       - low edge
       - high edge
       - number of bins (default is 100)
 
    The reference to the histogram is returned and could be used for later manipulations
 
    """
    return HistoDecorator.plot1D(s, *a)
 
 
# =============================================================================
 
 

_plot2D_()

def GaudiAlg.Algs._plot2D_ (   s, *  a  )

private

The basic method to fill (book-on-demand) 2D-histogram

The histogram will be created/booked dautomatically according to the
specifications:

   - literal or numerical ID (optional)
   - title
   - low X-edge
   - high X-edge
   - low Y-edge
   - high Y-edge
   - number of X-bins (default is 50)
   - number of Y-bins (default is 50)

The reference to the histogram is returned and could be used for later manipulations

Definition at line 1010 of file Algs.py.

def _plot2D_(s, *a):
    """
    The basic method to fill (book-on-demand) 2D-histogram
 
    The histogram will be created/booked dautomatically according to the
    specifications:
 
       - literal or numerical ID (optional)
       - title
       - low X-edge
       - high X-edge
       - low Y-edge
       - high Y-edge
       - number of X-bins (default is 50)
       - number of Y-bins (default is 50)
 
    The reference to the histogram is returned and could be used for later manipulations
 
    """
    return HistoDecorator.plot2D(s, *a)
 
 
# =============================================================================
 
 

_plot3D_()

def GaudiAlg.Algs._plot3D_ (   s, *  a  )

private

The basic method to fill (book-on-demand) 3D-histogram

The histogram will be created/booked dautomatically according to the
specifications:

   - literal or numerical ID (optional)
   - title
   - low X-edge
   - high X-edge
   - low Y-edge
   - high Y-edge
   - low Z-edge
   - high Z-edge
   - number of X-bins (default is 10)
   - number of Y-bins (default is 10)
   - number of Y-bins (default is 10)

The reference to the histogram is returned and could be used for later manipulations

Definition at line 1035 of file Algs.py.

def _plot3D_(s, *a):
    """
    The basic method to fill (book-on-demand) 3D-histogram
 
    The histogram will be created/booked dautomatically according to the
    specifications:
 
       - literal or numerical ID (optional)
       - title
       - low X-edge
       - high X-edge
       - low Y-edge
       - high Y-edge
       - low Z-edge
       - high Z-edge
       - number of X-bins (default is 10)
       - number of Y-bins (default is 10)
       - number of Y-bins (default is 10)
 
    The reference to the histogram is returned and could be used for later manipulations
 
    """
    return HistoDecorator.plot3D(s, *a)
 
 
# =============================================================================
 
 

_profile1D_()

def GaudiAlg.Algs._profile1D_ (   s, *  a  )

private

The basic method to fill (book-on-demand) 1D profile histogram

The profile histogram will be created/booked dautomatically
according to the specifications:

   - literal or numerical ID (optional)
   - title
   - low X-edge
   - high X-edge
   - number of X-bins (default is 100)

The reference to the histogram is returned and could be used for later manipulations

Definition at line 1063 of file Algs.py.

def _profile1D_(s, *a):
    """
    The basic method to fill (book-on-demand) 1D profile histogram
 
    The profile histogram will be created/booked dautomatically
    according to the specifications:
 
       - literal or numerical ID (optional)
       - title
       - low X-edge
       - high X-edge
       - number of X-bins (default is 100)
 
    The reference to the histogram is returned and could be used for later manipulations
 
    """
    return HistoDecorator.profile1D(s, *a)
 
 
# =============================================================================
 
 

_profile2D_()

def GaudiAlg.Algs._profile2D_ (   s, *  a  )

private

The basic method to fill (book-on-demand) 2D profile histiogram

The profile histogram will be created/booked automatically
according to the specifications:

   - literal or numerical ID (optional)
   - title
   - low X-edge
   - high X-edge
   - low Y-edge
   - high Y-edge
   - number of X-bins (default is 50)
   - number of Y-bins (default is 50)

The reference to the histogram is returned and could be used for later manipulations

Definition at line 1085 of file Algs.py.

def _profile2D_(s, *a):
    """
    The basic method to fill (book-on-demand) 2D profile histiogram
 
    The profile histogram will be created/booked automatically
    according to the specifications:
 
       - literal or numerical ID (optional)
       - title
       - low X-edge
       - high X-edge
       - low Y-edge
       - high Y-edge
       - number of X-bins (default is 50)
       - number of Y-bins (default is 50)
 
    The reference to the histogram is returned and could be used for later manipulations
 
    """
    return HistoDecorator.profile2D(s, *a)
 
 
# =============================================================================
 
_plot1D_.__doc__ += "\n" + HistoDecorator.plot1D.__doc__
_plot2D_.__doc__ += "\n" + HistoDecorator.plot2D.__doc__
_plot3D_.__doc__ += "\n" + HistoDecorator.plot3D.__doc__
_profile1D_.__doc__ += "\n" + HistoDecorator.profile1D.__doc__
_profile2D_.__doc__ += "\n" + HistoDecorator.profile2D.__doc__
 
 

_service_()

def GaudiAlg.Algs._service_ (   self,   interface,   name,   create = True  )

private

Useful method to locate a service:

Usage:

ntsvc = self.svc( INTupleSvc , 'NTUpleSvc' )

Definition at line 179 of file Algs.py.

def _service_(self, interface, name, create=True):
    """
    Useful method to locate a service:
 
    Usage:
 
    ntsvc = self.svc( INTupleSvc , 'NTUpleSvc' )
 
    """
    if not interface:
        interface = cpp.IInterface
    _svc = AlgDecorator.svc_(self, name, create)
    if not _svc:
        return None
    _svc = InterfaceCast(interface)(_svc)
    if not _svc:
        self.Warning("Invalid cast to interface %s" % interface)
        return None
    return _svc
 
 
# =============================================================================
# The constructor from unique algorithm instance name,
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_set_attr_()

def GaudiAlg.Algs._set_attr_ (   self,   pname,   pvalue  )

private

Set the attribute (or property) :
- if the attribute name corresponds to the property name, the property is updated

Definition at line 558 of file Algs.py.

def _set_attr_(self, pname, pvalue):
    """
    Set the attribute (or property) :
    - if the attribute name corresponds to the property name, the property is updated
    """
    if not self.hasProperty(pname):
        self.__dict__[pname] = pvalue
    else:
        self._ialg.__setattr__(pname, pvalue)
 
 

_setProperty_()

def GaudiAlg.Algs._setProperty_ (   self,   pname,   pvalue  )

private

Set the property from the value

Definition at line 524 of file Algs.py.

def _setProperty_(self, pname, pvalue):
    """
    Set the property from the value
    """
    if not self.hasProperty(pname):
        raise AttributeError("property %s does not exist" % pname)
    return self._ialg.__setattr__(pname, pvalue)
 
 
# =============================================================================
# get the attribute or property
 
 

_start_()

def GaudiAlg.Algs._start_ (   self )

private

The stub 'start' method needed by the internal implementation of PyAlg<>.

Definition at line 948 of file Algs.py.

def _start_(self):
    """
    The stub 'start' method needed by the internal implementation of PyAlg<>.
    """
    # return self._Base.start_(self)
    return SUCCESS
 
 
GaudiAlgo.start = _start_
HistoAlgo.start = _start_
TupleAlgo.start = _start_
 
 

_stop_()

def GaudiAlg.Algs._stop_ (   self )

private

The stub 'stop' method needed by the internal implementation of PyAlg<>.

Definition at line 973 of file Algs.py.

def _stop_(self):
    """
    The stub 'stop' method needed by the internal implementation of PyAlg<>.
    """
    # return self._Base.stop_(self)
    return SUCCESS
 
 
GaudiAlgo.stop = _stop_
HistoAlgo.stop = _stop_
TupleAlgo.stop = _stop_
 
# =============================================================================
 
 

_success_()

def GaudiAlg.Algs._success_ (   self )

private

Definition at line 494 of file Algs.py.

def _success_(self):
    return SUCCESS
 
 
# =============================================================================
# check the existence of the property with the given name

_t_array_()

def GaudiAlg.Algs._t_array_ (   s, *  a  )

private

Fill the fixed-size array column

Definition at line 1265 of file Algs.py.

def _t_array_(s, *a):
    """
    Fill the fixed-size array column
    """
    return _Dec.array(s, *a)
 
 

_t_column_()

def GaudiAlg.Algs._t_column_ (   s, *  a  )

private

Fill the certain column to n-tuple

Definition at line 1244 of file Algs.py.

def _t_column_(s, *a):
    """
    Fill the certain column to n-tuple
    """
    return _Dec.column(s, *a)
 
 

_t_column_ll_()

def GaudiAlg.Algs._t_column_ll_ (   s, *  a  )

private

Fill the 'long long' column

Definition at line 1251 of file Algs.py.

def _t_column_ll_(s, *a):
    """
    Fill the 'long long' column
    """
    return _Dec.column_ll(s, *a)
 
 

_t_column_ull_()

def GaudiAlg.Algs._t_column_ull_ (   s, *  a  )

private

Fill the 'unsigned long long' column

Definition at line 1258 of file Algs.py.

def _t_column_ull_(s, *a):
    """
    Fill the 'unsigned long long' column
    """
    return _Dec.column_ull(s, *a)
 
 

_t_farray_()

def GaudiAlg.Algs._t_farray_ (   s, *  a  )

private

Fill the floating-size array column

Definition at line 1279 of file Algs.py.

def _t_farray_(s, *a):
    """
    Fill the floating-size array column
    """
    return _Dec.farray(s, *a)
 
 

_t_fmatrix_()

def GaudiAlg.Algs._t_fmatrix_ (   s, *  a  )

private

Fill the floating-size matrix column

Definition at line 1286 of file Algs.py.

def _t_fmatrix_(s, *a):
    """
    Fill the floating-size matrix column
    """
    return _Dec.fmatrix(s, *a)
 
 
_t_nTuple_.__doc__ += "\n" + _Dec.nTuple.__doc__
_t_ntuple_.__doc__ += "\n" + _Dec.ntuple.__doc__
_t_valid_.__doc__ += "\n" + _Dec.valid.__doc__
_t_write_.__doc__ += "\n" + _Dec.write.__doc__
_t_column_.__doc__ += "\n" + _Dec.column.__doc__
_t_column_ll_.__doc__ += "\n" + _Dec.column_ll.__doc__
_t_column_ull_.__doc__ += "\n" + _Dec.column_ull.__doc__
_t_array_.__doc__ += "\n" + _Dec.array.__doc__
_t_matrix_.__doc__ += "\n" + _Dec.matrix.__doc__
_t_farray_.__doc__ += "\n" + _Dec.farray.__doc__
_t_fmatrix_.__doc__ += "\n" + _Dec.fmatrix.__doc__
 
Tuple.nTuple = _t_nTuple_
Tuple.ntuple = _t_ntuple_
Tuple.valid = _t_valid_
Tuple.write = _t_write_
Tuple.column = _t_column_
Tuple.column_ll = _t_column_ll_
Tuple.column_ull = _t_column_ull_
Tuple.array = _t_array_
Tuple.matrix = _t_matrix_
Tuple.farray = _t_farray_
Tuple.fmatrix = _t_fmatrix_
 

_t_matrix_()

def GaudiAlg.Algs._t_matrix_ (   s, *  a  )

private

Fill the fixed-size matrix column

Definition at line 1272 of file Algs.py.

def _t_matrix_(s, *a):
    """
    Fill the fixed-size matrix column
    """
    return _Dec.matrix(s, *a)
 
 

_t_nTuple_()

def GaudiAlg.Algs._t_nTuple_ (   s, *  a  )

private

Access to underlying INTuple object

Definition at line 1216 of file Algs.py.

def _t_nTuple_(s, *a):
    """
    Access to underlying INTuple object
    """
    return _Dec.nTuple(s, *a)
 
 

_t_ntuple_()

def GaudiAlg.Algs._t_ntuple_ (   s, *  a  )

private

Access to underlying NTuple::Tuple object

Definition at line 1223 of file Algs.py.

def _t_ntuple_(s, *a):
    """
    Access to underlying NTuple::Tuple object
    """
    return _Dec.ntuple(s, *a)
 
 

_t_valid_()

def GaudiAlg.Algs._t_valid_ (   s, *  a  )

private

Valid NTuple::Tuple object?

Definition at line 1230 of file Algs.py.

def _t_valid_(s, *a):
    """
    Valid NTuple::Tuple object?
    """
    return _Dec.valid(s, *a)
 
 

_t_write_()

def GaudiAlg.Algs._t_write_ (   s, *  a  )

private

Commit the row/record to n-tuple

Definition at line 1237 of file Algs.py.

def _t_write_(s, *a):
    """
    Commit the row/record to n-tuple
    """
    return _Dec.write(s, *a)
 
 

_tool_()

def GaudiAlg.Algs._tool_ (   self,   interface,   typename,   name = None,   parent = None,   create = True  )

private

Useful method to locate the tool a certain

Usage:

# locate public tool
t1 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator')
# locate private tool
t2 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator',parent=self)
# locate public tool with defined name
t3 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator/MyExt1')
# locate private tool with defined name
t4 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator/MyExt2',parent=self)
# locate public tool with defined name
t5 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator','MyExt3')
# locate private tool with defined name
t6 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator','MyExt4',parent=self)

Definition at line 128 of file Algs.py.

def _tool_(self, interface, typename, name=None, parent=None, create=True):
    """
    Useful method to locate the tool a certain
 
    Usage:
 
    # locate public tool
    t1 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator')
    # locate private tool
    t2 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator',parent=self)
    # locate public tool with defined name
    t3 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator/MyExt1')
    # locate private tool with defined name
    t4 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator/MyExt2',parent=self)
    # locate public tool with defined name
    t5 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator','MyExt3')
    # locate private tool with defined name
    t6 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator','MyExt4',parent=self)
 
    """
    if not interface:
        interface = cpp.IAlgTool
    if not parent:
        parent = self
    if name:
        typename += "/" + name
    _tool = AlgDecorator.tool_(self, typename, parent, create)
    if not _tool:
        return None
    _tool = InterfaceCast(interface)(_tool)
    if not _tool:
        self.Warning("Invalid cast to interface %s" % interface)
        return None
    return _tool
 
 
# =============================================================================
# Useful method to locate a service:
#
#     Usage:
#
#  @code
#
#     ntsvc = self.svc( INTupleSvc , 'NTUpleSvc' )
#
#  @endcode
#
#  @author Vanya BELYAEV ibelyaev@physics.syr.edu
#  @date 2006-11-26
 
 

_Tools_a_()

def GaudiAlg.Algs._Tools_a_ (   self )

private

Retrieve the list of tools,
    aquired by component through GaudiCommon<TYPE> base:

>>> alg   = ...             ## get the algorithm
>>> tools = alg.Tools()     ## get the tools
>>> for tool in tools :
...        print(tool)

Definition at line 1400 of file Algs.py.

def _Tools_a_(self):
    """
    Retrieve the list of tools,
        aquired by component through GaudiCommon<TYPE> base:
 
    >>> alg   = ...             ## get the algorithm
    >>> tools = alg.Tools()     ## get the tools
    >>> for tool in tools :
    ...        print(tool)
 
    """
    _cmp = getattr(self, "_ialg")
    if not _cmp:
        self.retrieveInterface()
    _cmp = getattr(self, "_ialg")
    return _get_all_tools_(_cmp, "_tools_a_")
 
 
# =============================================================================
 
 

_Tools_t_()

def GaudiAlg.Algs._Tools_t_ (   self )

private

Retrieve the list of tools,
    aquired by component through GaudiCommon<TYPE> base:

>>> tool  = ...              ## get the tool
>>> tools = tool.Tools()     ## get the tools
>>> for t in tools :
...        print(t)

Definition at line 1421 of file Algs.py.

def _Tools_t_(self):
    """
    Retrieve the list of tools,
        aquired by component through GaudiCommon<TYPE> base:
 
    >>> tool  = ...              ## get the tool
    >>> tools = tool.Tools()     ## get the tools
    >>> for t in tools :
    ...        print(t)
 
    """
    _cmp = getattr(self, "_itool")
    if not _cmp:
        self.retrieveInterface()
    _cmp = getattr(self, "_itool")
    return _get_all_tools_(_cmp, "_tools_t_")
 
 
# =============================================================================
# get the counter
# =============================================================================
 
 

mapvct()

def GaudiAlg.Algs.mapvct	(		func,
			sequence,
			ovct = None
	)

Helper function to fill histogram/ntuple using 'map'-operation

Definition at line 1360 of file Algs.py.

def mapvct(func, sequence, ovct=None):
    """Helper function to fill histogram/ntuple using 'map'-operation"""
    if not ovct:
        vct = GaudiPython.Vector
    else:
        vct = ovct
    if hasattr(sequence, "size"):
        vct.reserve(vct.size() + sequence.size())
    elif hasattr(sequence, "__len__"):
        vct.reserve(vct.size() + len(sequence))
    for object in sequence:
        vct.push_back(func(object))
    if not ovct:
        return vct
 
 
# =============================================================================
 
 
# =============================================================================
# get the list of tools
# =============================================================================

Variable Documentation

__all__

tuple GaudiAlg.Algs.__all__

private

Initial value:

=  (
    "GaudiAlgo",  # base class for algorithms
    "HistoAlgo",  # base class for histo-related algorithms
    "TupleAlgo",  # base class for tuple-related algorithms
    "Tuple",  # N-Tuple
    "HistoID",  # ID for N-tuples
    "TupleID",  # ID for Histograms
    "aida2root",  # AIDA -> ROOT converter
    "SUCCESS",  # status code
)

Definition at line 52 of file Algs.py.

__author__

string GaudiAlg.Algs.__author__ = "Vanya BELYAEV Ivan.Belyaev@lapp.in2p3.fr"

private

Definition at line 48 of file Algs.py.

_alg_map_

GaudiAlg.Algs._alg_map_

private

Definition at line 1317 of file Algs.py.

_Dec

GaudiAlg.Algs._Dec

private

Definition at line 1175 of file Algs.py.

_detSvc_

GaudiAlg.Algs._detSvc_

private

Definition at line 248 of file Algs.py.

_evtcolSvc_

GaudiAlg.Algs._evtcolSvc_

private

Definition at line 300 of file Algs.py.

_evtSvc_

GaudiAlg.Algs._evtSvc_

private

Definition at line 244 of file Algs.py.

_GaudiAlgorithm

GaudiAlg.Algs._GaudiAlgorithm

private

Definition at line 569 of file Algs.py.

_GaudiHistoAlg

GaudiAlg.Algs._GaudiHistoAlg

private

Definition at line 570 of file Algs.py.

_GaudiTupleAlg

GaudiAlg.Algs._GaudiTupleAlg

private

Definition at line 571 of file Algs.py.

_histoSvc_

GaudiAlg.Algs._histoSvc_

private

Definition at line 271 of file Algs.py.

_ialg

GaudiAlg.Algs._ialg

private

Definition at line 217 of file Algs.py.

_ntupleSvc_

GaudiAlg.Algs._ntupleSvc_

private

Definition at line 295 of file Algs.py.

AlgDecorator

GaudiAlg.Algs.AlgDecorator

Definition at line 97 of file Algs.py.

column

GaudiAlg.Algs.column

Definition at line 1213 of file Algs.py.

HID

GaudiAlg.Algs.HID

Definition at line 91 of file Algs.py.

HistoDecorator

GaudiAlg.Algs.HistoDecorator

Definition at line 98 of file Algs.py.

HistoID

GaudiAlg.Algs.HistoID

Definition at line 92 of file Algs.py.

iAlgorithm

GaudiAlg.Algs.iAlgorithm = GaudiPython.Bindings.iAlgorithm

Definition at line 66 of file Algs.py.

iAlgTool

GaudiAlg.Algs.iAlgTool = GaudiPython.Bindings.iAlgTool

Definition at line 67 of file Algs.py.

Matrix

GaudiAlg.Algs.Matrix

Definition at line 88 of file Algs.py.

std

GaudiAlg.Algs.std

Definition at line 83 of file Algs.py.

TID

GaudiAlg.Algs.TID

Definition at line 93 of file Algs.py.

Tuple

GaudiAlg.Algs.Tuple

Definition at line 1174 of file Algs.py.

TupleAlgDecorator

GaudiAlg.Algs.TupleAlgDecorator

Definition at line 99 of file Algs.py.

TupleDecorator

GaudiAlg.Algs.TupleDecorator

Definition at line 100 of file Algs.py.

TupleID

GaudiAlg.Algs.TupleID

Definition at line 94 of file Algs.py.

Vector

GaudiAlg.Algs.Vector

Definition at line 86 of file Algs.py.