| # Gaudi Framework, version v21r6 |

Home |  | Generated: 11 Nov 2009

# GaudiPython::GaudiAlgs Namespace Reference

## Classes
class | GaudiAlgo
| the base class for all algorithm Python-image of C++ clkass GaudiAlgorithm More...
class | HistoAlgo
| The base class for easy histogramming. More...
class | TupleAlgo
| The base class for easy manupulations with N-Tuples. More...
class | objectmethod
## Functions
def | _tool_
| Useful method to locate the tool a certain.
def | _service_
| Useful method to locate a service:.
def | _init_
| The constructor from unique algorithm instance name,.
def | _initialize_
| The default initialization (initialization of base C++ class + data.
def | _initialize_histo_
| The default initialization (initialization of base C++ class + data members).
def | _initialize_tuple_
| The default initialization (initialization of base C++ class + data members).
def | _evtSvc
| Trivial helper function to access Event Data and Event Data Service.
def | _detSvc
| Trivial helper function to access Detector Data and Detector Data Service.
def | _histoSvc
| Trivial helper function to access Histogram Data and Histogram Data Service.
def | _get
| Trivial function to access the data in TES.
def | _getDet
| Trivial function to access the data in TDS.
def | _ntupleSvc
| Trivial helper function to access NTuple Service.
def | _evtcolSvc
| Trivial helper function to access Event Collection Service.
def | _finalize_
| The default finalization (finalization of base C++ class).
def | _success_
| Dummy method returning success.
def | _hasProperty_
| check the existence of the property with the given name
def | _getProperty_
| get the value of the given property
def | _setProperty_
| set the value for the given property
def | _get_attr_
| get the attribute or property
def | _set_attr_
| set the attribute or property
def | _start_
def | _execute_
def | _stop_
def | _plot1D_
def | _plot2D_
def | _plot3D_
def | _profile1D_
def | _profile2D_
def | _decorate_plots_
def | _nTuple_
def | _evtCol_
def | _decorate_tuples_
def | _t_nTuple_
def | _t_ntuple_
def | _t_valid_
def | _t_write_
def | _t_column_
def | _t_array_
def | _t_matrix_
def | _t_farray_
def | _t_fmatrix_
def | _decorate_algs_
def | mapvct
def | _get_all_tools_
def | _Tools_a_
def | _Tools_t_
def | _get_all_counters_
| get all counters
def | _Counters_a_
| get all counters
def | _Counters_t_
def | _get_counter_
def | _Counter_a_
def | _Counter_t_
def | _get_all_histos_
def | _Histos_a_
def | _Histos_t_
def | _help_
## Variables
string | __author__ = 'Vanya BELYAEV Ivan.Belyaev@lapp.in2p3.fr'
tuple | __all__
| iAlgorithm = GaudiPython.Bindings.iAlgorithm
| iAlgTool = GaudiPython.Bindings.iAlgTool
| std = cpp.std
tuple | Vector = std.vector('double')
| "typedef" for GaudiPython::Vector
tuple | Matrix = std.vector('std::vector<double>')
| "typedef" for GaudiPython::Matrix
| HID = cpp.GaudiAlg.ID
| histogram and N-Tuple universal identifier
| HistoID = HID
| TID = HID
| TupleID = TID
| AlgDecorator = cpp.GaudiPython.AlgDecorator
| get the decorator:
| HistoDecorator = cpp.GaudiPython.HistoDecorator
| TupleAlgDecorator = cpp.GaudiPython.TupleAlgDecorator
| TupleDecorator = cpp.GaudiPython.TupleDecorator
tuple | _GaudiAlgorithm = cpp.GaudiPython.PyAlg( 'GaudiAlgorithm' )
tuple | _GaudiHistoAlg = cpp.GaudiPython.PyAlg( 'GaudiHistoAlg' )
tuple | _GaudiTupleAlg = cpp.GaudiPython.PyAlg( 'GaudiTupleAlg' )
| Tuple = cpp.Tuples.Tuple
| _Dec = TupleDecorator
dictionary | _alg_map_
| _evtSvc_
| _detSvc_
| _histoSvc_
| _ntupleSvc_
| _evtcolSvc_

## Function Documentation

def GaudiPython::GaudiAlgs::_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 1233 of file GaudiAlgs.py.

    01233                                 :
    01234     """
    01235     Retrieve the counter managed GaudiCommon<TYPE> base by name:
    01236
    01237     >>> alg  = ...                     ## get the algorithm
    01238     >>> cnt  = alg.Counter('#accept')  ## get the counter
    01239     >>> print cnt
    01240
    01241     """
    01242     _cmp  = getattr ( self , '_ialg' )
    01243     if not _cmp : self.retrieveInterface()
    01244     _cmp  = getattr ( self , '_ialg' )
    01245     return _get_counter_ ( _cmp , '_counter_a_' , name )
    01246 # ==============================================================================
    def _Counter_t_ ( self , name ) :

def GaudiPython::GaudiAlgs::_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 1247 of file GaudiAlgs.py.

    01247                                 :
    01248     """
    01249     Retrieve the counter managed GaudiCommon<TYPE> base by name:
    01250
    01251     >>> tool = ...                      ## get the tool
    01252     >>> cnt  = tool.Counter('#accept')  ## get the counter
    01253     >>> print cnt
    01254
    01255     """
    01256     _cmp  = getattr ( self , '_itool' )
    01257     if not _cmp : self.retrieveInterface()
    01258     _cmp  = getattr ( self , '_itool' )
    01259     return _get_counter_ ( _cmp , '_counter_t_' , name )
    01260
    01261 # =============================================================================
    01262 # get all histos
    01263 # =============================================================================
    01264 cpp.GaudiAlg.ID .__repr__ = cpp.GaudiAlg.ID.idAsString
    01265 cpp.GaudiAlg.ID . __str__ = cpp.GaudiAlg.ID.idAsString
    01266 cpp.StatEntity  .__repr__ = cpp.StatEntity.toString
    01267 cpp.StatEntity  . __str__ = cpp.StatEntity.toString
    01268 # =============================================================================
    def _get_all_histos_  ( component , method , name ) :

def GaudiPython::GaudiAlgs::_Counters_a_ | ( |  | self,
|  |  | name = `None` |
| ) |  |  | `[private]`

get all counters

    Retrieve the counters, managed GaudiCommon<TYPE> base:

    >>> alg  = ...             ## get the algorithm
    >>> cnts = alg.Counters()  ## get the counters
    >>> for key in cnts :
    ...        print key, cnts[key]

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

    >>> alg = ...                        ## get the algorithm
    >>> cnt = alg.Counters('MyCounter')  ## get the counter
    >>> print cnt

Definition at line 1180 of file GaudiAlgs.py.

    01180                                         :
    01181     """
    01182     Retrieve the counters, managed GaudiCommon<TYPE> base:
    01183
    01184     >>> alg  = ...             ## get the algorithm
    01185     >>> cnts = alg.Counters()  ## get the counters
    01186     >>> for key in cnts :
    01187     ...        print key, cnts[key]
    01188
    01189
    01190     Retrieve the counter, managed GaudiCommon<TYPE> base by name:
    01191
    01192     >>> alg = ...                        ## get the algorithm
    01193     >>> cnt = alg.Counters('MyCounter')  ## get the counter
    01194     >>> print cnt
    01195
    01196     """
    01197     _cmp  = getattr ( self , '_ialg' )
    01198     if not _cmp : self.retrieveInterface()
    01199     _cmp  = getattr ( self , '_ialg' )
    01200     return _get_all_counters_ ( _cmp , '_counters_a_' , name )
    01201 # =============================================================================
    def _Counters_t_ ( self , name = None ) :

def GaudiPython::GaudiAlgs::_Counters_t_ | ( |  | self,
|  |  | name = `None` |
| ) |  |  | `[private]`

    Retrieve the counters, managed GaudiCommon<TYPE> base:

    >>> tool = ...              ## get the tool
    >>> cnts = tool.Counters()  ## get the counters
    >>> for key in cnts :
    ...        print key, cnts[key]

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

    >>> tool = ...                         ## get the tool
    >>> cnt  = tool.Counters('MyCounter')  ## get the counter
    >>> print cnt

Definition at line 1202 of file GaudiAlgs.py.

    01202                                         :
    01203     """
    01204     Retrieve the counters, managed GaudiCommon<TYPE> base:
    01205
    01206     >>> tool = ...              ## get the tool
    01207     >>> cnts = tool.Counters()  ## get the counters
    01208     >>> for key in cnts :
    01209     ...        print key, cnts[key]
    01210
    01211
    01212     Retrieve the counter, managed GaudiCommon<TYPE> base by name:
    01213
    01214     >>> tool = ...                         ## get the tool
    01215     >>> cnt  = tool.Counters('MyCounter')  ## get the counter
    01216     >>> print cnt
    01217
    01218     """
    01219     _cmp  = getattr ( self , '_itool' )
    01220     if not _cmp : self.retrieveInterface()
    01221     _cmp  = getattr ( self , '_itool' )
    01222     return _get_all_counters_ ( _cmp , '_counters_t_' , name )
    01223 # =============================================================================
    01224 # get the counter
    01225 # =============================================================================
    def _get_counter_ ( self , method , name ) :

def GaudiPython::GaudiAlgs::_decorate_algs_ | ( |  | klasses | ) | `[private]`

Definition at line 1075 of file GaudiAlgs.py.

    01075                                 :
    01076     t = type( klasses )
    01077     if not issubclass ( t , list  ) and  \
    01078        not issubclass ( t , tuple ) : klasses = [ klasses ]
    01079     for _alg in klasses :
    01080         for key in _alg_map_ : setattr( _alg , key , _alg_map_[key] )
    01081
    01082 # =
    _decorate_algs_ ( GaudiAlgo )

def GaudiPython::GaudiAlgs::_decorate_plots_ | ( |  | klasses | ) | `[private]`

Definition at line 968 of file GaudiAlgs.py.

    00968                                  :
    00969     t = type( klasses )
    00970     if not issubclass ( t , list  ) and  \
    00971        not issubclass ( t , tuple ) : klasses = [ klasses ]
    00972     for klass in klasses :
    00973         klass .plot       = _plot1D_
    00974         klass .plot1D     = _plot1D_
    00975         klass .plot2D     = _plot2D_
    00976         klass .plot3D     = _plot3D_
    00977         klass .profile1D  = _profile1D_
    00978         klass .profile2D  = _profile2D_
    00979
    _decorate_plots_ ( HistoAlgo )

def GaudiPython::GaudiAlgs::_decorate_tuples_ | ( |  | klasses | ) | `[private]`

Definition at line 1000 of file GaudiAlgs.py.

    01000                                   :
    01001     t = type( klasses )
    01002     if not issubclass ( t , list  ) and  \
    01003        not issubclass ( t , tuple ) : klasses = [ klasses ]
    01004     for klass in klasses :
    01005         klass . nTuple    = _nTuple_
    01006         klass . evtCol    = _evtCol_
    01007         klass . ntupleSvc = _ntupleSvc
    01008         klass .  tupleSvc = _ntupleSvc
    01009         klass .   ntupSvc = _ntupleSvc
    01010         klass .    tupSvc = _ntupleSvc
    01011         klass . evtColSvc = _evtcolSvc
    01012         klass . evtcolSvc = _evtcolSvc
    01013
    01014 # ==========================================================
    _decorate_tuples_ ( TupleAlgo )

def GaudiPython::GaudiAlgs::_detSvc | ( |  | self | ) | `[private]`

Trivial helper function to access Detector Data and Detector Data Service.

Usage:

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

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

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

      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 320 of file GaudiAlgs.py.

    00320                        :
    00321     """
    00322     Trivial helper function to access Detector Data and Event Data Service
    00323
    00324     Usage:
    00325     # get detector data service
    00326     svc = self.detSvc()
    00327
    00328     # get the data
    00329     lhcb = self.detSvc('/dd/Structure/LHCb')
    00330     """
    00331     if not location :
    00332         return self._detSvc_
    00333     return self._detSvc_[location]
    00334
    00335 # =============================================================================
    ## Trivial helper function to access Histogram  Data and Histogram  Data Service

def GaudiPython::GaudiAlgs::_evtCol_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

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

Definition at line 991 of file GaudiAlgs.py.

    00991                          :
    00992     """
    00993     Retrieve (book-on-demand) N-Tuple object for Event Tag Collections
    00994     """
    00995     return TupleAlgDecorator.evtCol ( s , *a )
    00996
    00997 _nTuple_.__doc__  += TupleAlgDecorator.nTuple.__doc__
    00998 _evtCol_.__doc__  += TupleAlgDecorator.evtCol.__doc__
    00999
    def _decorate_tuples_ ( klasses ) :

def GaudiPython::GaudiAlgs::_evtcolSvc | ( |  | self | ) | `[private]`

Trivial helper function to access Event Collection Service.

    Trivial function to access Event Collection Service

Definition at line 393 of file GaudiAlgs.py.

    00393                         :
    00394     """
    00395     Trivial function to access Event Collection Service
    00396     """
    00397     return self._evtcolSvc_
    00398
    00399
    00400 # =============================================================================
    ## The default finalization (finalization of base C++ class)

def GaudiPython::GaudiAlgs::_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')

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

      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 287 of file GaudiAlgs.py.

    00287                                          :
    00288     """
    00289     Trivial helper function to access Event Data and Event Data Service
    00290
    00291     Usage:
    00292
    00293     # get event data service
    00294     svc = self.evtSvc()
    00295
    00296     # get the data
    00297     hits = self.evtSvc('MC/Calo/Hits')
    00298     """
    00299     if not location :
    00300         return self._evtSvc_
    00301     return self._evtSvc_[location]
    00302
    00303 # =============================================================================
    ## Trivial helper function to access Detector Data and Detector  Data Service

def GaudiPython::GaudiAlgs::_execute_ | ( |  | self | ) | `[private]`

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

Definition at line 837 of file GaudiAlgs.py.

    00837                        :
    00838     """
    00839     The fictive 'execute' method, which MUST be overwitten by user
    00840     """
    00841     raise RuntimeError, 'Execute method is not implemented for %s' % self.name()
    00842
    00843 GaudiAlgo.execute = _execute_
    00844 HistoAlgo.execute = _execute_
    00845 TupleAlgo.execute = _execute_
    00846
    def _stop_ ( self ) :

def GaudiPython::GaudiAlgs::_finalize_ | ( |  | self | ) | `[private]`

The default finalization (finalization of base C++ class).

    The default finalization : finalize the base C++ class

Definition at line 402 of file GaudiAlgs.py.

    00402                           :
    00403     """
    00404     The default finalization : finalize the base C++ class
    00405     """
    00406     status = self._Base.finalize_  ( self )
    00407     return status
    00408 # =============================================================================
    ## Dummy method returning success

def GaudiPython::GaudiAlgs::_get | ( |  | self,
|  |  | location |
| ) |  |  | `[private]`

Trivial function to access the data in TES.

    Trivial function to access the data in TES

Definition at line 369 of file GaudiAlgs.py.

    00369                                   :
    00370     """
    00371     Trivial function to access the data in TES
    00372     """
    00373     return self._evtSvc_[location]
    00374
    00375 # =============================================================================
    ## Trivial function to access the data in TDS

def GaudiPython::GaudiAlgs::_get_all_counters_ | ( |  | self,
|  |  | method,
|  |  | name = `None` |
| ) |  |  | `[private]`

get all counters

    get all counters

Definition at line 1161 of file GaudiAlgs.py.

    01161                                                        :
    01162     """
    01163     get all counters
    01164     """
    01165     _cnts = std.vector('const StatEntity*')()
    01166     _nams = std.vector('std::string')      ()
    01167     _func = getattr ( AlgDecorator , method )
    01168     _num  = _func   ( self , _nams , _cnts )
    01169     if _nams.size() != _num or _cnts.size() != _num  :
    01170         raise RuntimeError, 'Unable to extract Counters'
    01171     _res = {}
    01172     for _i in range(0,_num) :
    01173         _nam = _nams[_i]
    01174         _cnt = _cnts[_i]
    01175         _res [ _nam ] = _cnt
    01176     if not name : return _res
    01177     return _res.get( name , None )
    01178 # =============================================================================
    ## get all counters

def GaudiPython::GaudiAlgs::_get_all_histos_ | ( |  | component,
|  |  | method,
|  |  | name |
| ) |  |  | `[private]`

    Get All histogram form the component

Definition at line 1269 of file GaudiAlgs.py.

    01269                                                     :
    01270     """
    01271     Get All histogram form the component
    01272     """
    01273     _res = {}
    01274     for _his in (  std.vector('AIDA::IProfile2D*'   ) ,
    01275                    std.vector('AIDA::IProfile1D*'   ) ,
    01276                    std.vector('AIDA::IHistogram3D*' ) ,
    01277                    std.vector('AIDA::IHistogram2D*' ) ,
    01278                    std.vector('AIDA::IHistogram1D*' ) ) :
    01279         _his = _his()
    01280         _ids = std.vector('GaudiAlg::ID')     ()
    01281         _fun = getattr ( HistoDecorator , method )
    01282         _num = _fun ( component , _ids , _his )
    01283         if _ids.size() != _num or _his.size() != _num  :
    01284             raise RuntimeError, 'Unable to extract Histos!'
    01285         for _i in range(0,_num) :
    01286             _id = _ids[ _i ]
    01287             if   _id.numeric() : _id = _id.numericID  ()
    01288             elif _id.literal() : _id = _id.literalID  ()
    01289             else               : _id = _is.idAsString ()
    01290             _res [ _id ] = _his[ _i ]
    01291
    01292     if not name : return _res                         ## return the dictionary
    01293     return res.get( cpp.GaudiAlg.ID( name ) , None )  ## return the histogram
    01294 # =============================================================================
    def _Histos_a_ ( self , name = None ) :

def GaudiPython::GaudiAlgs::_get_all_tools_ | ( |  | self,
|  |  | method |
| ) |  |  | `[private]`

    Get all tools

Definition at line 1111 of file GaudiAlgs.py.

    01111                                       :
    01112     """
    01113     Get all tools
    01114     """
    01115     _tools = std.vector('IAlgTool*')()
    01116     _func  = getattr ( AlgDecorator , method )
    01117     _num   = _func ( self , _tools )
    01118     if _tools.size() != _num :
    01119         raise RuntimeError, 'Unable to extract Tools'
    01120     _res = []
    01121     for _tool in _tools : _res += [ iAlgTool ( _tool.name() , _tool ) ]
    01122     return _res
    01123 # =============================================================================
    def _Tools_a_ ( self ) :

def GaudiPython::GaudiAlgs::_get_attr_ | ( |  | self,
|  |  | pname |
| ) |  |  | `[private]`

get the attribute or property

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

Definition at line 443 of file GaudiAlgs.py.

    00443                                 :
    00444     """
    00445     Get the attribute (or property)
    00446     - if the attribute name corresponds to the property name, property value is returned
    00447     """
    00448     if self.hasProperty( pname ) :
    00449         return iAlgorithm.__getattr__ ( self , pname )
    00450     raise AttributeError, 'attribute/property %s does not exist' % pname
    00451
    00452 # =============================================================================
    ## set the attribute or property

def GaudiPython::GaudiAlgs::_get_counter_ | ( |  | self,
|  |  | method,
|  |  | name |
| ) |  |  | `[private]`

    get the counter

Definition at line 1226 of file GaudiAlgs.py.

    01226                                            :
    01227     """
    01228     get the counter
    01229     """
    01230     _func = getattr ( AlgDecorator , method )
    01231     return _func ( self , name )
    01232 # ==============================================================================
    def _Counter_a_ ( self , name ) :

def GaudiPython::GaudiAlgs::_getDet | ( |  | self,
|  |  | location |
| ) |  |  | `[private]`

Trivial function to access the data in TDS.

    Trivial function to access the data in TDS

Definition at line 377 of file GaudiAlgs.py.

    00377                                   :
    00378     """
    00379     Trivial function to access the data in TDS
    00380     """
    00381     return self._detSvc_[location]
    00382
    00383 # =============================================================================
    ## Trivial helper function to access NTuple Service

def GaudiPython::GaudiAlgs::_getProperty_ | ( |  | self,
|  |  | pname |
| ) |  |  | `[private]`

get the value of the given property

    Get the property by name

Definition at line 423 of file GaudiAlgs.py.

    00423                                    :
    00424     """
    00425     Get the property by name
    00426     """
    00427     if not self.hasProperty( pname ) :
    00428         raise AttributeError, 'property %s does not exist' % pname
    00429     return iAlgorithm.__getattr__( self , pname )
    00430
    00431 # =============================================================================
    ## set the value for the given property

def GaudiPython::GaudiAlgs::_hasProperty_ | ( |  | self,
|  |  | pname |
| ) |  |  | `[private]`

check the existence of the property with the given name

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

Definition at line 415 of file GaudiAlgs.py.

    00415                                    :
    00416     """
    00417     The trivial function which checks the existence of the property with given name
    00418     """
    00419     return cpp.Gaudi.Utils.hasProperty ( self , pname )
    00420
    00421 # =============================================================================
    ## get the value of the given property

def GaudiPython::GaudiAlgs::_help_ | ( |  | ) | `[private]`

Definition at line 1364 of file GaudiAlgs.py.

    01364              :
    01365     print __doc__ , __author__
    01366     print '\t\t\tDoc-string for class GaudiAlgo \n' , GaudiAlgo.__doc__
    01367     print '\t\t\tDoc-string for class HistoAlgo \n' , HistoAlgo.__doc__
    01368     print '\t\t\tDoc-string for class TupleAlgo \n' , TupleAlgo.__doc__
    01369
    01370 # =============================================================================
    01371 # pseudo-test suite
    01372 # =============================================================================
    if __name__ == '__main__' :

def GaudiPython::GaudiAlgs::_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 historgam with certain ID :

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

Definition at line 1295 of file GaudiAlgs.py.

    01295                                       :
    01296     """
    01297     Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:
    01298
    01299     >>> alg = ...              ## get the algorithm
    01300     >>> histos = alg.Histos()  ## get all histograms & profiles
    01301     >>> for key in histos :
    01302     ...        print key, histos[key]
    01303
    01304     Retrive the historgam with certain ID :
    01305
    01306     >>> alg = ...                           ## get the algorithm
    01307     >>> histo = alg.Histos('some histo ID') ## get the histo by ID
    01308     >>> print histo
    01309
    01310     """
    01311     _cmp  = getattr ( self , '_ialg' )
    01312     if not _cmp : self.retrieveInterface()
    01313     _cmp  = getattr ( self , '_ialg' )
    01314     return _get_all_histos_ ( _cmp , '_histos_a_' , name )
    01315 # =============================================================================
    def _Histos_t_ ( self , name = None ) :

def GaudiPython::GaudiAlgs::_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 1316 of file GaudiAlgs.py.

    01316                                       :
    01317     """
    01318     Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:
    01319
    01320     >>> tool = ...              ## get the tool
    01321     >>> histos = tool.Histos()  ## get all histograms & profiles
    01322     >>> for key in histos :
    01323     ...        print key, histos[key]
    01324
    01325     Retrive the historgam with certain ID :
    01326
    01327     >>> tool = ...                           ## get the tool
    01328     >>> histo = tool.Histos('some histo ID') ## get the histo by ID
    01329     >>> print histo
    01330
    01331     """
    01332     _cmp  = getattr ( self , '_itool' )
    01333     if not _cmp : self.retrieveInterface()
    01334     _cmp  = getattr ( self , '_itool' )
    01335     return _get_all_histos_ ( _cmp , '_histos_t_' , name )
    01336 # =============================================================================
    01337
    01338
    _Tools_a_    . __doc__ += AlgDecorator   . _tools_a_    . __doc__

def GaudiPython::GaudiAlgs::_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')

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

      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 352 of file GaudiAlgs.py.

    00352                                          :
    00353     """
    00354     Trivial helper function to access Histogram  Data and Histogram  Data Service
    00355
    00356     Usage:
    00357
    00358     # get histogram data service
    00359     svc = self.histoSvc()
    00360
    00361     # get the data
    00362     histo = self.histoSvc('/stat/Calo/1')
    00363     """
    00364     if not address : return self._histoSvc_
    00365     return self._histoSvc_[ address ]
    00366
    00367 # =============================================================================
    ## Trivial function to access the data in TES

def GaudiPython::GaudiAlgs::_init_ | ( |  | self,
|  |  | name,
|  |  | args |
| ) |  |  | `[private]`

The constructor from unique algorithm instance name,.

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

      The constructor from unique algorithm instance name & parameters

Definition at line 190 of file GaudiAlgs.py.

    00190                                     :
    00191     """
    00192     The constructor from unique algorithm instance name & parameters
    00193     """
    00194     self._Base.__init__( self , self , name )
    00195     appMgr = AppMgr()
    00196     algMgr = appMgr._algmgr
    00197     status = algMgr.addAlgorithm( self )
    00198     if status.isFailure() :
    00199         raise RuntimeError, 'Unable to add Algorithm "' + name + '"'
    00200     iAlgorithm.__init__ ( self , name , self )
    00201     for key in args : setattr ( self , key , args[key] )
    00202
    00203 # =============================================================================
    ## The default initialization (initialization of base C++ class + data

def GaudiPython::GaudiAlgs::_initialize_ | ( |  | self | ) | `[private]`

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

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

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

Definition at line 208 of file GaudiAlgs.py.

    00208                           :
    00209     """
    00210     The default initialization (initialization of base C++ class + data)
    00211     """
    00212     status = self._Base.initialize_( self )
    00213     if status.isFailure() : return status
    00214
    00215     # set the basic services
    00216     _e = self._Base.evtSvc( self )
    00217     _s = InterfaceCast(cpp.IService)(_e)
    00218     self._evtSvc_ = iDataSvc ( _s.name() , _e )
    00219
    00220     _d = self._Base.detSvc( self )
    00221     _s = InterfaceCast(cpp.IService)(_d)
    00222     self._detSvc_ = iDataSvc ( _s.name() , _d )
    00223
    00224     return status
    00225
    00226 # =============================================================================
    ## The default initialization (initialization of base C++ class + data members)

def GaudiPython::GaudiAlgs::_initialize_histo_ | ( |  | self | ) | `[private]`

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

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

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

Definition at line 231 of file GaudiAlgs.py.

    00231                                 :
    00232     """
    00233     The default initialization (initialization of base C++ class + data members)
    00234     """
    00235     status = _initialize_( self )
    00236     if status.isFailure() : return status
    00237
    00238     # set the basic services
    00239     _h = self._Base.histoSvc( self )
    00240     _s = InterfaceCast(cpp.IService)(_h)
    00241     self._histoSvc_ = iHistogramSvc ( _s.name() , _h )
    00242
    00243     return status
    00244
    00245 # =============================================================================
    ## The default initialization (initialization of base C++ class + data members)

def GaudiPython::GaudiAlgs::_initialize_tuple_ | ( |  | self | ) | `[private]`

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

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

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

Definition at line 250 of file GaudiAlgs.py.

    00250                                 :
    00251     """
    00252     The default initialization (initialization of base C++ class + data members)
    00253     """
    00254     status = _initialize_histo_( self )
    00255     if status.isFailure() : return status
    00256
    00257     # set the basic services
    00258     if self.produceNTuples() :
    00259         _n = self._Base.ntupleSvc( self )
    00260         _s = InterfaceCast(cpp.IService)(_n)
    00261         self._ntupleSvc_ = iNTupleSvc ( _s.name() , _n )
    00262
    00263     if self.produceEvtCols() :
    00264         _n = self._Base.evtColSvc( self )
    00265         _s = InterfaceCast(cpp.IService)(_n)
    00266         self._evtcolSvc_ = iNTupleSvc ( _s.name() , _n )
    00267
    00268     return status
    00269
    00270 # =============================================================================
    ## Trivial helper function to access Event Data and Event Data Service

def GaudiPython::GaudiAlgs::_nTuple_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

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

Definition at line 985 of file GaudiAlgs.py.

    00985                          :
    00986     """
    00987     Retrieve (book-on-demand) N-Tuple object
    00988     """
    00989     return TupleAlgDecorator.nTuple ( s , *a )
    00990 # =============================================================================
    def _evtCol_ ( s , *a )  :

def GaudiPython::GaudiAlgs::_ntupleSvc | ( |  | self | ) | `[private]`

Trivial helper function to access NTuple Service.

    Trivial function to access N-Tuple Service

Definition at line 385 of file GaudiAlgs.py.

    00385                         :
    00386     """
    00387     Trivial function to access N-Tuple Service
    00388     """
    00389     return self._ntupleSvc_
    00390
    00391 # =============================================================================
    ## Trivial helper function to access Event Collection Service

def GaudiPython::GaudiAlgs::_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 859 of file GaudiAlgs.py.

    00859                           :
    00860     """
    00861     The basic method to fill (book-on-demand) 1D-histogram
    00862
    00863     The histogram will be created/booked dautomatically according to the
    00864     specifications:
    00865
    00866        - literal or numerical ID (optional)
    00867        - title
    00868        - low edge
    00869        - high edge
    00870        - number of bins (default is 100)
    00871
    00872     The reference to the histogram is returned and could be used for later manipulations
    00873
    00874     """
    00875     return HistoDecorator.plot1D    (s,*a)
    00876 # =============================================================================
    def _plot2D_    ( s, *a ) :

def GaudiPython::GaudiAlgs::_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 877 of file GaudiAlgs.py.

    00877                           :
    00878     """
    00879     The basic method to fill (book-on-demand) 2D-histogram
    00880
    00881     The histogram will be created/booked dautomatically according to the
    00882     specifications:
    00883
    00884        - literal or numerical ID (optional)
    00885        - title
    00886        - low X-edge
    00887        - high X-edge
    00888        - low Y-edge
    00889        - high Y-edge
    00890        - number of X-bins (default is 50)
    00891        - number of Y-bins (default is 50)
    00892
    00893     The reference to the histogram is returned and could be used for later manipulations
    00894
    00895     """
    00896     return HistoDecorator.plot2D    (s,*a)
    00897 # =============================================================================
    def _plot3D_    ( s, *a ) :

def GaudiPython::GaudiAlgs::_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 898 of file GaudiAlgs.py.

    00898                           :
    00899     """
    00900     The basic method to fill (book-on-demand) 3D-histogram
    00901
    00902     The histogram will be created/booked dautomatically according to the
    00903     specifications:
    00904
    00905        - literal or numerical ID (optional)
    00906        - title
    00907        - low X-edge
    00908        - high X-edge
    00909        - low Y-edge
    00910        - high Y-edge
    00911        - low Z-edge
    00912        - high Z-edge
    00913        - number of X-bins (default is 10)
    00914        - number of Y-bins (default is 10)
    00915        - number of Y-bins (default is 10)
    00916
    00917     The reference to the histogram is returned and could be used for later manipulations
    00918
    00919     """
    00920     return HistoDecorator.plot3D    (s,*a)
    00921 # =============================================================================
    def _profile1D_ ( s, *a ) :

def GaudiPython::GaudiAlgs::_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 922 of file GaudiAlgs.py.

    00922                           :
    00923     """
    00924     The basic method to fill (book-on-demand) 1D profile histogram
    00925
    00926     The profile histogram will be created/booked dautomatically
    00927     according to the specifications:
    00928
    00929        - literal or numerical ID (optional)
    00930        - title
    00931        - low X-edge
    00932        - high X-edge
    00933        - number of X-bins (default is 100)
    00934
    00935     The reference to the histogram is returned and could be used for later manipulations
    00936
    00937     """
    00938     return HistoDecorator.profile1D (s,*a)
    00939 # =============================================================================
    def _profile2D_ ( s, *a ) :

def GaudiPython::GaudiAlgs::_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 940 of file GaudiAlgs.py.

    00940                           :
    00941     """
    00942     The basic method to fill (book-on-demand) 2D profile histiogram
    00943
    00944     The profile histogram will be created/booked automatically
    00945     according to the specifications:
    00946
    00947        - literal or numerical ID (optional)
    00948        - title
    00949        - low X-edge
    00950        - high X-edge
    00951        - low Y-edge
    00952        - high Y-edge
    00953        - number of X-bins (default is 50)
    00954        - number of Y-bins (default is 50)
    00955
    00956     The reference to the histogram is returned and could be used for later manipulations
    00957
    00958     """
    00959     return HistoDecorator.profile2D (s,*a)
    00960 # =============================================================================
    00961
    _plot1D_    .__doc__ += HistoDecorator.plot1D    .__doc__

def GaudiPython::GaudiAlgs::_service_ | ( |  | self,
|  |  | interface,
|  |  | name,
|  |  | create = `True` |
| ) |  |  | `[private]`

Useful method to locate a service:.

Usage:

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

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

      Useful method to locate a service:

      Usage:

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

Definition at line 164 of file GaudiAlgs.py.

    00167                                   :
    00168     """
    00169     Useful method to locate a service:
    00170
    00171     Usage:
    00172
    00173     ntsvc = self.svc( INTupleSvc , 'NTUpleSvc' )
    00174
    00175     """
    00176     if not interface : interface = cpp.IInterface
    00177     _svc = AlgDecorator.svc_ ( self , name , create )
    00178     if not _svc : return None
    00179     _svc = InterfaceCast(interface)(_svc)
    00180     if not _svc :
    00181         self.Warning('Invalid cast to interface %s' % interface )
    00182         return None
    00183     return _svc
    00184
    00185 # =============================================================================
    ## The constructor from unique algorithm instance name,

def GaudiPython::GaudiAlgs::_set_attr_ | ( |  | self,
|  |  | pname,
|  |  | pvalue |
| ) |  |  | `[private]`

set the attribute or property

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

Definition at line 454 of file GaudiAlgs.py.

    00454                                          :
    00455     """
    00456     Set the attribute (or property) :
    00457     - if the attribute name corresponds to the property name, the property is updated
    00458     """
    00459     if not self.hasProperty( pname ) : self.__dict__[pname] = pvalue
    00460     else : iAlgorithm.__setattr__ ( self , pname , pvalue )
    00461
    00462
    _GaudiAlgorithm = cpp.GaudiPython.PyAlg( 'GaudiAlgorithm' )

def GaudiPython::GaudiAlgs::_setProperty_ | ( |  | self,
|  |  | pname,
|  |  | pvalue |
| ) |  |  | `[private]`

set the value for the given property

    Set the property from the value

Definition at line 433 of file GaudiAlgs.py.

    00433                                             :
    00434     """
    00435     Set the property from the value
    00436     """
    00437     if not self.hasProperty( pname ) :
    00438         raise AttributeError, 'property %s does not exist' % pname
    00439     return iAlgorithm.__setattr__ ( self , pname , pvalue )
    00440
    00441 # =============================================================================
    ## get the attribute or property

def GaudiPython::GaudiAlgs::_start_ | ( |  | self | ) | `[private]`

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

Definition at line 826 of file GaudiAlgs.py.

    00826                      :
    00827     """
    00828     The stub 'start' method needed by the internal implementation of PyAlg<>.
    00829     """
    00830     # return self._Base.start_(self)
    00831     return SUCCESS
    00832
    00833 GaudiAlgo.start = _start_
    00834 HistoAlgo.start = _start_
    00835 TupleAlgo.start = _start_
    00836
    def _execute_ ( self ) :

def GaudiPython::GaudiAlgs::_stop_ | ( |  | self | ) | `[private]`

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

Definition at line 847 of file GaudiAlgs.py.

    00847                     :
    00848     """
    00849     The stub 'stop' method needed by the internal implementation of PyAlg<>.
    00850     """
    00851     # return self._Base.stop_(self)
    00852     return SUCCESS
    00853
    00854 GaudiAlgo.stop = _stop_
    00855 HistoAlgo.stop = _stop_
    00856 TupleAlgo.stop = _stop_
    00857
    00858 # =============================================================================
    def _plot1D_    ( s, *a ) :

def GaudiPython::GaudiAlgs::_success_ | ( |  | self | ) | `[private]`

Dummy method returning success.

Definition at line 410 of file GaudiAlgs.py.

    00410                        : return SUCCESS
    00411
    00412
    00413 # =============================================================================

def GaudiPython::GaudiAlgs::_t_array_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1026 of file GaudiAlgs.py.

    01026 : return _Dec.array  (s,*a)

def GaudiPython::GaudiAlgs::_t_column_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1025 of file GaudiAlgs.py.

    01025 : return _Dec.column (s,*a)

def GaudiPython::GaudiAlgs::_t_farray_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1028 of file GaudiAlgs.py.

    01028 : return _Dec.farray (s,*a)

def GaudiPython::GaudiAlgs::_t_fmatrix_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1029 of file GaudiAlgs.py.

    01029                        : return _Dec.fmatrix (s,*a)
    01030

def GaudiPython::GaudiAlgs::_t_matrix_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1027 of file GaudiAlgs.py.

    01027 : return _Dec.matrix (s,*a)

def GaudiPython::GaudiAlgs::_t_ntuple_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1022 of file GaudiAlgs.py.

    01022 : return _Dec.ntuple (s,*a)

def GaudiPython::GaudiAlgs::_t_nTuple_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1021 of file GaudiAlgs.py.

    01021 : return _Dec.nTuple (s,*a)

def GaudiPython::GaudiAlgs::_t_valid_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1023 of file GaudiAlgs.py.

    01023 : return _Dec.valid  (s,*a)

def GaudiPython::GaudiAlgs::_t_write_ | ( |  | s,
|  |  | a |
| ) |  |  | `[private]`

Definition at line 1024 of file GaudiAlgs.py.

    01024 : return _Dec.write  (s,*a)

def GaudiPython::GaudiAlgs::_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)

Author:
  Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
  2006-11-26

      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 115 of file GaudiAlgs.py.

    00120                                 :
    00121     """
    00122     Useful method to locate the tool a certain
    00123
    00124     Usage:
    00125
    00126     # locate public tool
    00127     t1 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator')
    00128     # locate private tool
    00129     t2 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator',parent=self)
    00130     # locate public tool with defined name
    00131     t3 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator/MyExt1')
    00132     # locate private tool with defined name
    00133     t4 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator/MyExt2',parent=self)
    00134     # locate public tool with defined name
    00135     t5 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator','MyExt3')
    00136     # locate private tool with defined name
    00137     t6 = self.tool(ITrExtrapolator,'TrParabolicExtrapolator','MyExt4',parent=self)
    00138
    00139     """
    00140     if not interface : interface = cpp.IAlgTool
    00141     if not parent    : parent    = self
    00142     if name          : typename  += '/' + name
    00143     _tool = AlgDecorator.tool_( self , typename , parent , create )
    00144     if not _tool : return None
    00145     _tool = InterfaceCast(interface)(_tool)
    00146     if not _tool :
    00147         self.Warning('Invalid cast to interface %s' % interface )
    00148         return None
    00149     return _tool
    00150
    00151 # =============================================================================
    ## Useful method to locate a service:

def GaudiPython::GaudiAlgs::_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 1124 of file GaudiAlgs.py.

    01124                        :
    01125     """
    01126     Retrieve the list of tools,
    01127         aquired by component through GaudiCommon<TYPE> base:
    01128
    01129     >>> alg   = ...             ## get the algorithm
    01130     >>> tools = alg.Tools()     ## get the tools
    01131     >>> for tool in tools :
    01132     ...        print tool
    01133
    01134     """
    01135     _cmp  = getattr ( self , '_ialg' )
    01136     if not _cmp : self.retrieveInterface()
    01137     _cmp  = getattr ( self , '_ialg' )
    01138     return _get_all_tools_ ( _cmp , '_tools_a_' )
    01139 # =============================================================================
    def _Tools_t_ ( self ) :

def GaudiPython::GaudiAlgs::_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 1140 of file GaudiAlgs.py.

    01140                        :
    01141     """
    01142     Retrieve the list of tools,
    01143         aquired by component through GaudiCommon<TYPE> base:
    01144
    01145     >>> tool  = ...              ## get the tool
    01146     >>> tools = tool.Tools()     ## get the tools
    01147     >>> for t in tools :
    01148     ...        print t
    01149
    01150     """
    01151     _cmp  = getattr ( self , '_itool' )
    01152     if not _cmp : self.retrieveInterface()
    01153     _cmp  = getattr ( self , '_itool' )
    01154     return _get_all_tools_ ( _cmp , '_tools_t_' )
    01155
    01156
    01157 # =============================================================================
    01158 # get the list of counters
    01159 # =============================================================================
    ## get all counters

def GaudiPython::GaudiAlgs::mapvct | ( |  | func,
|  |  | sequence,
|  |  | ovct = `None` |
| ) |  |  |

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

Definition at line 1090 of file GaudiAlgs.py.

    01090                                              :
    01091     """ Helper function to fill histogram/ntuple using 'map'-operation """
    01092     if not ovct :
    01093         vct = GaudiPython.Vector
    01094     else :
    01095         vct = ovct
    01096     if   hasattr( sequence, 'size' ) :
    01097         vct.reserve ( vct.size() + sequence.size() )
    01098     elif hasattr( sequence, '__len__' ) :
    01099         vct.reserve ( vct.size() + len( sequence ) )
    01100     for object in sequence :
    01101         vct.push_back( func( object ) )
    01102     if not ovct : return vct
    01103 # =============================================================================
    01104
    01105
    01106
    01107
    01108 # =============================================================================
    01109 # get the list of tools
    01110 # =============================================================================
    def _get_all_tools_ ( self , method ) :

## Variable Documentation

tuple GaudiPython::GaudiAlgs::__all__

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 43 of file GaudiAlgs.py.

string GaudiPython::GaudiAlgs::__author__ = 'Vanya BELYAEV Ivan.Belyaev@lapp.in2p3.fr'

Definition at line 39 of file GaudiAlgs.py.

dictionary GaudiPython::GaudiAlgs::_alg_map_

Initial value:

    {
        '__init__'    : _init_        , # constructor
        'tool'        : _tool_        , # service locator
        'svc'         : _service_     , # tool locator
        'evtSvc'      : _evtSvc       , # event data service
        'eventSvc'    : _evtSvc       , # event data service
        'detSvc'      : _detSvc       , # detector data service
        'histoSvc'    : _histoSvc     , # histogram data service
        'histSvc'     : _histoSvc     , # histogram data service
        'get'         : _get          , # access to event data
        'getDet'      : _getDet       , # access to detector data
        'finalize'    : _finalize_    , # algorithm finalization
        'beginRun'    : _success_     , # dummy function returning success
        'endRun'      : _success_     , # dummy function returning success
        #
        'hasProperty' : _hasProperty_ , # check the existence of property with given name
        'getProperty' : _getProperty_ , # get the property value with given name
        'setProperty' : _setProperty_ , # set the property with given name
        '__setattr__' : _set_attr_    , # set the attribute/property with given name
        '__getattr__' : _get_attr_      # set the attribute/property with given name
        }

Definition at line 1051 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::_Dec = TupleDecorator

Definition at line 1020 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::_detSvc_

Definition at line 222 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::_evtcolSvc_

Definition at line 266 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::_evtSvc_

Definition at line 218 of file GaudiAlgs.py.

tuple GaudiPython::GaudiAlgs::_GaudiAlgorithm = cpp.GaudiPython.PyAlg( 'GaudiAlgorithm' )

Definition at line 463 of file GaudiAlgs.py.

tuple GaudiPython::GaudiAlgs::_GaudiHistoAlg = cpp.GaudiPython.PyAlg( 'GaudiHistoAlg' )

Definition at line 464 of file GaudiAlgs.py.

tuple GaudiPython::GaudiAlgs::_GaudiTupleAlg = cpp.GaudiPython.PyAlg( 'GaudiTupleAlg' )

Definition at line 465 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::_histoSvc_

Definition at line 241 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::_ntupleSvc_

Definition at line 261 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::AlgDecorator = cpp.GaudiPython.AlgDecorator

get the decorator:

Definition at line 86 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::HID = cpp.GaudiAlg.ID

histogram and N-Tuple universal identifier

Definition at line 80 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::HistoDecorator = cpp.GaudiPython.HistoDecorator

Definition at line 87 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::HistoID = HID

Definition at line 81 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::iAlgorithm = GaudiPython.Bindings.iAlgorithm

Definition at line 56 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::iAlgTool = GaudiPython.Bindings.iAlgTool

Definition at line 57 of file GaudiAlgs.py.

tuple GaudiPython::GaudiAlgs::Matrix = std.vector('std::vector<double>')

"typedef" for GaudiPython::Matrix

Definition at line 77 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::std = cpp.std

Definition at line 72 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::TID = HID

Definition at line 82 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::Tuple = cpp.Tuples.Tuple

Definition at line 1019 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::TupleAlgDecorator = cpp.GaudiPython.TupleAlgDecorator

Definition at line 88 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::TupleDecorator = cpp.GaudiPython.TupleDecorator

Definition at line 89 of file GaudiAlgs.py.

GaudiPython::GaudiAlgs::TupleID = TID

Definition at line 83 of file GaudiAlgs.py.

tuple GaudiPython::GaudiAlgs::Vector = std.vector('double')

"typedef" for GaudiPython::Vector

Definition at line 75 of file GaudiAlgs.py.