The Gaudi Framework: GaudiPython.TupleUtils Namespace Reference

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages

Functions
def	_getToolSvc
	Helper private auxillary utility to get Tool Service.

def	_nTuple_
	Retrive N-Tuple ( book on demand )

def	nTuple
	Retrieve (book-on-demand) 'Smart'-N-tuple object.

def	activeTuples
	Return the list of active tools.

def	releaseTuples
	Release the active tool/tuples.

def	_TupleUtils_AtExit_

Variables
string	__author__ "Vanya BELYAEV ibelyaev@physics.syr.edu"
	This module contains set of simple and useful utilities to booking and manipulation with N-Tuples (in the spirit of GaudiTuples<TYPE>)

tuple	__all__

	_Tool cpp.ITupleTool

	_Deco cpp.GaudiPython.TupleToolDecorator

list	_TOOLS_ []

	ntuple nTuple

	getNTuple nTuple

	getNtuple nTuple

	getntuple nTuple

	getTuple nTuple

	gettuple nTuple

Function Documentation

def GaudiPython.TupleUtils._getToolSvc ( kwargs )

private

Helper private auxillary utility to get Tool Service.

Helper private auxillary utility to get Tool Service

Definition at line 39 of file TupleUtils.py.

 
 def _getToolSvc( **kwargs ) :
     """ Helper private auxillary utility to get Tool Service """
     svc = kwargs.get ( 'toolSvc' , None )
     if not svc : svc = kwargs.get ( 'toolsvc' , None )
     if not svc : svc = kwargs.get ( 'service' , None )
     if not svc : svc = kwargs.get ( 'svc'     , None )
     else       : return svc                                ## RETURN
     gaudi = kwargs.get ( 'gaudi' , None )
     if not gaudi : gaudi = AppMgr()
     return gaudi.toolsvc()                                 ## RETURN
 
 
# =============================================================================

def GaudiPython.TupleUtils._nTuple_	(	s,
		args
	)

private

Retrive N-Tuple ( book on demand )

Retrive N-tuple ( book on demand )

Definition at line 53 of file TupleUtils.py.

 
 def _nTuple_ ( s , *args ) :
     """ Retrive N-tuple ( book on demand )  """
     print 'ARGS:' , args
     return _Deco.nTuple ( s , *args)
 
 # =============================================================================
 _nTuple_. __doc__ += "\n" + _Deco.nTuple . __doc__
 _Tool.nTuple = _nTuple_
 _Tool.ntuple = _nTuple_
 
 
# =============================================================================

def GaudiPython.TupleUtils._TupleUtils_AtExit_ ( )

private

AtExit function for GaudiPython.TupleUtils module

Definition at line 177 of file TupleUtils.py.

 
 def _TupleUtils_AtExit_ () :
     """
     AtExit function for GaudiPython.TupleUtils module
     """
     if activeTuples() :
         print 'WARNING: the list of local TupleTools is not empty!'
         print 'WARNING: please use GaudiPython.TupleUtils.releaseTuples() at the end'

def GaudiPython.TupleUtils.activeTuples ( )

Return the list of active tools.

Return the list of active tools

Definition at line 148 of file TupleUtils.py.

 
 def activeTuples () :
     """
     Return the list of active tools
     """
     return _TOOLS_
 
# =============================================================================

def GaudiPython.TupleUtils.nTuple	(	dirpath,
		ID,
		ID2 = `None`,
		topdir = `None`,
		LUN = `'FILE1'`
	)

Retrieve (book-on-demand) 'Smart'-N-tuple object.

Retrieve 'Smart'-N-tuple object.
N-tuple is booked on-demand.

Atetntion !!
The logical unit LUN must be configured by N-Tuple Service

Retrieve (book-n-demand) N-Tuple using
the  directory name and the title:
>>> t = nTuple ( 'the/path/to/directory' , ## the path to the directory
                 'N-tuple title'         , ## the title for N-Tuple
                  LUN = 'FILE1'          ) ## logical file unit

Retrieve (book-n-demand) N-Tuple using
the  directory name, literal ID and the title:
>>> t = nTuple ( 'the/path/to/directory' , ## the path to the directory
                 'Tuple1'                , ## the literal ID for N-Tuple
                 'N-tuple title'         , ## the title for N-Tuple
                  LUN = 'FILE1'          ) ## logical file unit

Retrieve (book-n-demand) N-Tuple using
the  directory name, numerical ID and the title:
>>> t = nTuple ( 'the/path/to/directory' , ## the path to the directory
                 124                     , ## the numerical ID for N-Tuple
                 'N-tuple title'         , ## the title for N-Tuple
                  LUN = 'FILE1'          ) ## logical file unit

Definition at line 66 of file TupleUtils.py.

 
 def nTuple ( dirpath , ID , ID2 = None , topdir = None , LUN = 'FILE1' ) :
     """
     Retrieve 'Smart'-N-tuple object.
     N-tuple is booked on-demand.
 
     Atetntion !!
     The logical unit LUN must be configured by N-Tuple Service
 
     Retrieve (book-n-demand) N-Tuple using
     the  directory name and the title:
     >>> t = nTuple ( 'the/path/to/directory' , ## the path to the directory
                      'N-tuple title'         , ## the title for N-Tuple
                       LUN = 'FILE1'          ) ## logical file unit
 
     Retrieve (book-n-demand) N-Tuple using
     the  directory name, literal ID and the title:
     >>> t = nTuple ( 'the/path/to/directory' , ## the path to the directory
                      'Tuple1'                , ## the literal ID for N-Tuple
                      'N-tuple title'         , ## the title for N-Tuple
                       LUN = 'FILE1'          ) ## logical file unit
 
     Retrieve (book-n-demand) N-Tuple using
     the  directory name, numerical ID and the title:
     >>> t = nTuple ( 'the/path/to/directory' , ## the path to the directory
                      124                     , ## the numerical ID for N-Tuple
                      'N-tuple title'         , ## the title for N-Tuple
                       LUN = 'FILE1'          ) ## logical file unit
 
 
     """
     toolSvc = _getToolSvc ()
 
     # construct the name of the intermediate TupleTool
     name = 'Tuple'+LUN+"/"
     if topdir : name += topdir
     name += dirpath
     name += "_%s"%ID
     if  ID2 : name += "_%s"%ID2
     name=name.replace ( '.'  , '_' )
     name=name.replace ( '/'  , '_' )
     name=name.replace ( '\\' , '_' )
     name=name.replace ( ' '  , '_' )
 
     ## define tool properties
     t0 = GaudiPython.iAlgTool( 'ToolSvc.'+name )
     t0.OutputLevel      = 1
     t0.NTupleLUN        = LUN
     t0.NTupleDir        = dirpath
     t0.PropertiesPrint  = False
     t0.OutputLevel      = 4
     if topdir : t0.NTupleTopDir = topdir
 
     ## get the tool from Tool service
     tool = toolSvc.create ( 'TupleTool'       ,
                             name              ,
                             interface = _Tool )
 
     ## check the properties and redefine them if needed
     t1 = GaudiPython.iAlgTool ( tool.name() , tool )
     if t1.NTupleLUN != LUN     : t1.NTupleLUN = LUN
     if t1.NTupleDir != dirpath : t1.NTupleDir = dirpath
     if topdir and ( t1.NTupleTopDir != topdir ) :
         t1.NTupleTopDir = topdir
 
     _TOOLS_.append ( tool )
     if not ID2 : return tool.nTuple ( ID )               ## RETURN
 
     return tool.nTuple ( ID , ID2 )                      ## RETURN
 

def GaudiPython.TupleUtils.releaseTuples ( )

Release the active tool/tuples.

Release the active tool/tuples
The method needs to be invoked explicitely at the end of the job

Definition at line 156 of file TupleUtils.py.

 
 def releaseTuples () :
     """
     Release the active tool/tuples
     The method needs to be invoked explicitely at the end of the job
     """
     if not _TOOLS_ : return
     print ' %s/%s: release all pending ITupleTools: %s' % ( __file__     ,
                                                            __name__     ,
                                                            len(_TOOLS_) )
     from GaudiPython.Bindings import _gaudi
     if not _gaudi : return
     
     toolSvc = _getToolSvc()
     if toolSvc.isValid() : 
         while _TOOLS_ :
             t = _TOOLS_.pop()
             if not t : continue
             while 1 < t.refCount() :
                 toolSvc._its.releaseTool( t )
 
# =============================================================================

Functions

Variables

Function Documentation

Variable Documentation

2007-08-04