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
	The basic module.
	iAlgTool = GaudiPython.Bindings.iAlgTool
	std = cpp.std
	AIDA -> ROTO converter ============================================================================= std C++ namespace.
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 1237 of file GaudiAlgs.py.

01238                                 :
01239     """
01240     Retrieve the counter managed GaudiCommon<TYPE> base by name:
01241 
01242     >>> alg  = ...                     ## get the algorithm
01243     >>> cnt  = alg.Counter('#accept')  ## get the counter
01244     >>> print cnt
01245 
01246     """
01247     _cmp  = getattr ( self , '_ialg' )
01248     if not _cmp : self.retrieveInterface()
01249     _cmp  = getattr ( self , '_ialg' )
01250     return _get_counter_ ( _cmp , '_counter_a_' , 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 1251 of file GaudiAlgs.py.

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

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

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

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

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

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

Definition at line 1079 of file GaudiAlgs.py.

01080                                 :
01081     t = type( klasses )
01082     if not issubclass ( t , list  ) and  \
01083        not issubclass ( t , tuple ) : klasses = [ klasses ]
01084     for _alg in klasses :
01085         for key in _alg_map_ : setattr( _alg , key , _alg_map_[key] )
01086 
# =

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

Definition at line 972 of file GaudiAlgs.py.

00973                                  :
00974     t = type( klasses )
00975     if not issubclass ( t , list  ) and  \
00976        not issubclass ( t , tuple ) : klasses = [ klasses ]
00977     for klass in klasses :
00978         klass .plot       = _plot1D_
00979         klass .plot1D     = _plot1D_
00980         klass .plot2D     = _plot2D_
00981         klass .plot3D     = _plot3D_
00982         klass .profile1D  = _profile1D_
00983         klass .profile2D  = _profile2D_

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

Definition at line 1004 of file GaudiAlgs.py.

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

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

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

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

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

Definition at line 995 of file GaudiAlgs.py.

00996                          :
00997     """
00998     Retrieve (book-on-demand) N-Tuple object for Event Tag Collections
00999     """
01000     return TupleAlgDecorator.evtCol ( s , *a )
01001 
01002 _nTuple_.__doc__  += TupleAlgDecorator.nTuple.__doc__
01003 _evtCol_.__doc__  += TupleAlgDecorator.evtCol.__doc__

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

Trivial helper function to access Event Collection Service.

Trivial function to access Event Collection Service

Definition at line 397 of file GaudiAlgs.py.

00398                         :
00399     """
00400     Trivial function to access Event Collection Service
00401     """
00402     return self._evtcolSvc_
00403 
00404 
# =============================================================================

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

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

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

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

Definition at line 841 of file GaudiAlgs.py.

00842                        :
00843     """
00844     The fictive 'execute' method, which MUST be overwitten by user
00845     """
00846     raise RuntimeError, 'Execute method is not implemented for %s' % self.name()
00847 
00848 GaudiAlgo.execute = _execute_
00849 HistoAlgo.execute = _execute_
00850 TupleAlgo.execute = _execute_

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

00407                           :
00408     """
00409     The default finalization : finalize the base C++ class
00410     """
00411     status = self._Base.finalize_  ( self )
00412     return status
# =============================================================================

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

00374                                   :
00375     """
00376     Trivial function to access the data in TES
00377     """
00378     return self._evtSvc_[location]
00379 
# =============================================================================

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

get all counters

get all counters

Definition at line 1165 of file GaudiAlgs.py.

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

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

Get All histogram form the component

Definition at line 1273 of file GaudiAlgs.py.

01274                                                     :
01275     """
01276     Get All histogram form the component
01277     """
01278     _res = {}
01279     for _his in (  std.vector('AIDA::IProfile2D*'   ) ,
01280                    std.vector('AIDA::IProfile1D*'   ) ,
01281                    std.vector('AIDA::IHistogram3D*' ) ,
01282                    std.vector('AIDA::IHistogram2D*' ) ,
01283                    std.vector('AIDA::IHistogram1D*' ) ) :
01284         _his = _his()
01285         _ids = std.vector('GaudiAlg::ID')     ()
01286         _fun = getattr ( HistoDecorator , method )
01287         _num = _fun ( component , _ids , _his )
01288         if _ids.size() != _num or _his.size() != _num  :
01289             raise RuntimeError, 'Unable to extract Histos!'
01290         for _i in range(0,_num) :
01291             _id = _ids[ _i ]
01292             if   _id.numeric() : _id = _id.numericID  ()
01293             elif _id.literal() : _id = _id.literalID  ()
01294             else               : _id = _is.idAsString ()
01295             _res [ _id ] = _his[ _i ]
01296 
01297     if not name : return _res                          ## return the dictionary
01298 
01299     id = cpp.GaudiAlg.ID ( name ) 
01300     for i in ( name            ,
01301                id.literalID () ,
01302                id.numericID () ,
01303                id.idAsString() , id  ) :
01304         h = _res.get( i , None  )
01305         if not not h : return h   ## return the histogram
01306         
01307     return None
# =============================================================================

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

Get all tools

Definition at line 1115 of file GaudiAlgs.py.

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

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

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

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

get the counter

Definition at line 1230 of file GaudiAlgs.py.

01231                                            :
01232     """
01233     get the counter
01234     """
01235     _func = getattr ( AlgDecorator , method )
01236     return _func ( 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 381 of file GaudiAlgs.py.

00382                                   :
00383     """
00384     Trivial function to access the data in TDS
00385     """
00386     return self._detSvc_[location]
00387 
# =============================================================================

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

get the value of the given property

Get the property by name

Definition at line 427 of file GaudiAlgs.py.

00428                                    :
00429     """
00430     Get the property by name
00431     """
00432     if not self.hasProperty( pname ) :
00433         raise AttributeError, 'property %s does not exist' % pname
00434     return iAlgorithm.__getattr__( self , pname )
00435 
# =============================================================================

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

00420                                    :
00421     """
00422     The trivial function which checks the existence of the property with given name
00423     """
00424     return cpp.Gaudi.Utils.hasProperty ( self , pname )
00425 
# =============================================================================

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

Definition at line 1377 of file GaudiAlgs.py.

01378              :
01379     print __doc__ , __author__
01380     print '\t\t\tDoc-string for class GaudiAlgo \n' , GaudiAlgo.__doc__
01381     print '\t\t\tDoc-string for class HistoAlgo \n' , HistoAlgo.__doc__
01382     print '\t\t\tDoc-string for class TupleAlgo \n' , TupleAlgo.__doc__
01383 
01384 # =============================================================================
01385 # pseudo-test suite
# =============================================================================

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

01309                                       :
01310     """
01311     Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:
01312 
01313     >>> alg = ...              ## get the algorithm
01314     >>> histos = alg.Histos()  ## get all histograms & profiles
01315     >>> for key in histos :
01316     ...        print key, histos[key]
01317 
01318     Retrive the histogram with the certain ID :
01319 
01320     >>> alg = ...                           ## get the algorithm
01321     >>> histo = alg.Histos('some histo ID') ## get the histo by ID
01322     >>> print histo
01323 
01324     """
01325     _cmp  = getattr ( self , '_ialg' )
01326     if not _cmp : self.retrieveInterface()
01327     _cmp  = getattr ( self , '_ialg' )
01328     return _get_all_histos_ ( _cmp , '_histos_a_' , name )
# =============================================================================

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

01330                                       :
01331     """
01332     Retrieve all histograms & profiles, booked through GauydiHistos<TYPE> base:
01333 
01334     >>> tool = ...              ## get the tool
01335     >>> histos = tool.Histos()  ## get all histograms & profiles
01336     >>> for key in histos :
01337     ...        print key, histos[key]
01338 
01339     Retrive the historgam with certain ID :
01340 
01341     >>> tool = ...                           ## get the tool
01342     >>> histo = tool.Histos('some histo ID') ## get the histo by ID
01343     >>> print histo
01344 
01345     """
01346     _cmp  = getattr ( self , '_itool' )
01347     if not _cmp : self.retrieveInterface()
01348     _cmp  = getattr ( self , '_itool' )
01349     return _get_all_histos_ ( _cmp , '_histos_t_' , name )
01350 # =============================================================================
01351

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

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

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.

00191                                     :
00192     """
00193     The constructor from unique algorithm instance name & parameters
00194     """
00195     self._Base.__init__( self , self , name )
00196     appMgr = AppMgr()
00197     algMgr = appMgr._algmgr
00198     status = algMgr.addAlgorithm( self )
00199     if status.isFailure() :
00200         raise RuntimeError, 'Unable to add Algorithm "' + name + '"'
00201     iAlgorithm.__init__ ( self , name , self )
00202     for key in args : setattr ( self , key , args[key] )
00203     # take some care about the ownership of the algorithms
00204     if not appMgr.__dict__.has_key ( 'GaudiPythonAlgos') :
00205         appMgr.__dict__[ 'GaudiPythonAlgos'] = []
00206     appMgr.__dict__[ 'GaudiPythonAlgos'].append( self ) 
00207 
# =============================================================================

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

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

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

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

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

00255                                 :
00256     """
00257     The default initialization (initialization of base C++ class + data members)
00258     """
00259     status = _initialize_histo_( self )
00260     if status.isFailure() : return status
00261 
00262     # set the basic services
00263     if self.produceNTuples() :
00264         _n = self._Base.ntupleSvc( self )
00265         _s = InterfaceCast(cpp.IService)(_n)
00266         self._ntupleSvc_ = iNTupleSvc ( _s.name() , _n )
00267 
00268     if self.produceEvtCols() :
00269         _n = self._Base.evtColSvc( self )
00270         _s = InterfaceCast(cpp.IService)(_n)
00271         self._evtcolSvc_ = iNTupleSvc ( _s.name() , _n )
00272 
00273     return status
00274 
# =============================================================================

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

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

Definition at line 989 of file GaudiAlgs.py.

00990                          :
00991     """
00992     Retrieve (book-on-demand) N-Tuple object
00993     """
00994     return TupleAlgDecorator.nTuple ( 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 389 of file GaudiAlgs.py.

00390                         :
00391     """
00392     Trivial function to access N-Tuple Service
00393     """
00394     return self._ntupleSvc_
00395 
# =============================================================================

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

00864                           :
00865     """
00866     The basic method to fill (book-on-demand) 1D-histogram
00867 
00868     The histogram will be created/booked dautomatically according to the
00869     specifications:
00870 
00871        - literal or numerical ID (optional)
00872        - title
00873        - low edge
00874        - high edge
00875        - number of bins (default is 100)
00876 
00877     The reference to the histogram is returned and could be used for later manipulations
00878 
00879     """
00880     return HistoDecorator.plot1D    (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 881 of file GaudiAlgs.py.

00882                           :
00883     """
00884     The basic method to fill (book-on-demand) 2D-histogram
00885 
00886     The histogram will be created/booked dautomatically according to the
00887     specifications:
00888 
00889        - literal or numerical ID (optional)
00890        - title
00891        - low X-edge
00892        - high X-edge
00893        - low Y-edge
00894        - high Y-edge
00895        - number of X-bins (default is 50)
00896        - number of Y-bins (default is 50)
00897 
00898     The reference to the histogram is returned and could be used for later manipulations
00899 
00900     """
00901     return HistoDecorator.plot2D    (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 902 of file GaudiAlgs.py.

00903                           :
00904     """
00905     The basic method to fill (book-on-demand) 3D-histogram
00906 
00907     The histogram will be created/booked dautomatically according to the
00908     specifications:
00909 
00910        - literal or numerical ID (optional)
00911        - title
00912        - low X-edge
00913        - high X-edge
00914        - low Y-edge
00915        - high Y-edge
00916        - low Z-edge
00917        - high Z-edge
00918        - number of X-bins (default is 10)
00919        - number of Y-bins (default is 10)
00920        - number of Y-bins (default is 10)
00921 
00922     The reference to the histogram is returned and could be used for later manipulations
00923 
00924     """
00925     return HistoDecorator.plot3D    (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 926 of file GaudiAlgs.py.

00927                           :
00928     """
00929     The basic method to fill (book-on-demand) 1D profile histogram
00930 
00931     The profile histogram will be created/booked dautomatically
00932     according to the specifications:
00933 
00934        - literal or numerical ID (optional)
00935        - title
00936        - low X-edge
00937        - high X-edge
00938        - number of X-bins (default is 100)
00939 
00940     The reference to the histogram is returned and could be used for later manipulations
00941 
00942     """
00943     return HistoDecorator.profile1D (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 944 of file GaudiAlgs.py.

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

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.

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

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

00459                                          :
00460     """
00461     Set the attribute (or property) :
00462     - if the attribute name corresponds to the property name, the property is updated
00463     """
00464     if not self.hasProperty( pname ) : self.__dict__[pname] = pvalue
00465     else : iAlgorithm.__setattr__ ( self , pname , pvalue )
00466

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

set the value for the given property

Set the property from the value

Definition at line 437 of file GaudiAlgs.py.

00438                                             :
00439     """
00440     Set the property from the value
00441     """
00442     if not self.hasProperty( pname ) :
00443         raise AttributeError, 'property %s does not exist' % pname
00444     return iAlgorithm.__setattr__ ( self , pname , pvalue )
00445 
# =============================================================================

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

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

Definition at line 830 of file GaudiAlgs.py.

00831                      :
00832     """
00833     The stub 'start' method needed by the internal implementation of PyAlg<>.
00834     """
00835     # return self._Base.start_(self)
00836     return SUCCESS
00837 
00838 GaudiAlgo.start = _start_
00839 HistoAlgo.start = _start_
00840 TupleAlgo.start = _start_

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

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

Definition at line 851 of file GaudiAlgs.py.

00852                     :
00853     """
00854     The stub 'stop' method needed by the internal implementation of PyAlg<>.
00855     """
00856     # return self._Base.stop_(self)
00857     return SUCCESS
00858 
00859 GaudiAlgo.stop = _stop_
00860 HistoAlgo.stop = _stop_
00861 TupleAlgo.stop = _stop_
00862 
# =============================================================================

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

Dummy method returning success.

Definition at line 414 of file GaudiAlgs.py.

00414                        : return SUCCESS
00415 
00416 
00417 # =============================================================================

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

Definition at line 1030 of file GaudiAlgs.py.

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

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

Definition at line 1029 of file GaudiAlgs.py.

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

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

Definition at line 1032 of file GaudiAlgs.py.

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

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

Definition at line 1033 of file GaudiAlgs.py.

01033                        : return _Dec.fmatrix (s,*a)
01034

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

Definition at line 1031 of file GaudiAlgs.py.

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

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

Definition at line 1025 of file GaudiAlgs.py.

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

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

Definition at line 1026 of file GaudiAlgs.py.

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

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

Definition at line 1027 of file GaudiAlgs.py.

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

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

Definition at line 1028 of file GaudiAlgs.py.

01028 : 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.

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

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

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

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

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

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

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

Definition at line 1094 of file GaudiAlgs.py.

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

Variable Documentation

tuple GaudiPython::GaudiAlgs::__all__

Initial value:

00001 (
00002     'GaudiAlgo' ,                    ##               base class for algorithms
00003     'HistoAlgo' ,                    ## base class for histo-related algorithms
00004     'TupleAlgo' ,                    ## base class for tuple-related algorithms
00005     'Tuple'     ,                    ##                                 N-Tuple
00006     'HistoID'   ,                    ##                         ID for N-tuples
00007     'TupleID'   ,                    ##                       ID for Histograms
00008     'aida2root' ,                    ##                  AIDA -> ROOT converter
00009     'SUCCESS'                        ##                             status code
00010     )

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:

00001 {
00002     '__init__'    : _init_        , # constructor
00003     'tool'        : _tool_        , # service locator
00004     'svc'         : _service_     , # tool locator
00005     'evtSvc'      : _evtSvc       , # event data service
00006     'eventSvc'    : _evtSvc       , # event data service
00007     'detSvc'      : _detSvc       , # detector data service
00008     'histoSvc'    : _histoSvc     , # histogram data service
00009     'histSvc'     : _histoSvc     , # histogram data service
00010     'get'         : _get          , # access to event data
00011     'getDet'      : _getDet       , # access to detector data
00012     'finalize'    : _finalize_    , # algorithm finalization
00013     'beginRun'    : _success_     , # dummy function returning success
00014     'endRun'      : _success_     , # dummy function returning success
00015     #
00016     'hasProperty' : _hasProperty_ , # check the existence of property with given name
00017     'getProperty' : _getProperty_ , # get the property value with given name
00018     'setProperty' : _setProperty_ , # set the property with given name
00019     '__setattr__' : _set_attr_    , # set the attribute/property with given name
00020     '__getattr__' : _get_attr_      # set the attribute/property with given name
00021     }