GaudiPython.TupleUtils Namespace Reference

Functions
def	_getToolSvc (**kwargs)
def	_nTuple_ (s, *args)
def	nTuple (dirpath, ID, ID2=None, topdir=None, LUN='FILE1')
def	activeTuples ()
def	releaseTuples ()
def	_TupleUtils_AtExit_ ()

Variables
	__author__
	__all__
	_Tool
	_Deco
	_TOOLS_
	ntuple
	getNTuple
	getNtuple
	getntuple
	getTuple
	gettuple

Function Documentation

_getToolSvc()

def GaudiPython.TupleUtils._getToolSvc ( **  kwargs )

private

Helper private auxillary utility to get Tool Service 

Definition at line 52 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
 
 
# =============================================================================
# Retrive N-Tuple ( book on demand )

_nTuple_()

def GaudiPython.TupleUtils._nTuple_ (   s, *  args  )

private

Retrive N-tuple ( book on demand )  

Definition at line 71 of file TupleUtils.py.

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

_TupleUtils_AtExit_()

def GaudiPython.TupleUtils._TupleUtils_AtExit_ ( )

private

AtExit function for GaudiPython.TupleUtils module

Definition at line 207 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'
        )
 
 

activeTuples()

def GaudiPython.TupleUtils.activeTuples

(

)

Return the list of active tools

Definition at line 172 of file TupleUtils.py.

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

nTuple()

def GaudiPython.TupleUtils.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

Definition at line 84 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
 
 

releaseTuples()

def GaudiPython.TupleUtils.releaseTuples

(

)

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

Definition at line 183 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
    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)
 
 
# =============================================================================
 
 

Variable Documentation

__all__

GaudiPython.TupleUtils.__all__

private

Definition at line 27 of file TupleUtils.py.

__author__

GaudiPython.TupleUtils.__author__

private

Definition at line 25 of file TupleUtils.py.

_Deco

GaudiPython.TupleUtils._Deco

private

Definition at line 43 of file TupleUtils.py.

_Tool

GaudiPython.TupleUtils._Tool

private

Definition at line 42 of file TupleUtils.py.

_TOOLS_

GaudiPython.TupleUtils._TOOLS_

private

Definition at line 46 of file TupleUtils.py.

getNTuple

GaudiPython.TupleUtils.getNTuple

Definition at line 162 of file TupleUtils.py.

getNtuple

GaudiPython.TupleUtils.getNtuple

Definition at line 163 of file TupleUtils.py.

getntuple

GaudiPython.TupleUtils.getntuple

Definition at line 164 of file TupleUtils.py.

getTuple

GaudiPython.TupleUtils.getTuple

Definition at line 165 of file TupleUtils.py.

gettuple

GaudiPython.TupleUtils.gettuple

Definition at line 166 of file TupleUtils.py.

ntuple

GaudiPython.TupleUtils.ntuple

Definition at line 161 of file TupleUtils.py.