GaudiPython.GaudiAlgs.HistoAlgo Class Reference

The base class for easy histogramming. More...

Inheritance diagram for GaudiPython.GaudiAlgs.HistoAlgo:

Collaboration diagram for GaudiPython.GaudiAlgs.HistoAlgo:

Additional Inherited Members
Public Member Functions inherited from GaudiPython.Bindings.iAlgorithm
def	__init__
def	retrieveInterface
Static Public Attributes inherited from GaudiPython.Bindings.iAlgorithm
tuple	initialize lambdaself:self.__call_interface_method__("_ialg","initialize")
tuple	start lambdaself:self.__call_interface_method__("_ialg","start")
tuple	execute lambdaself:self.__call_interface_method__("_ialg","execute")
tuple	stop lambdaself:self.__call_interface_method__("_ialg","stop")
tuple	finalize lambdaself:self.__call_interface_method__("_ialg","finalize")
tuple	reinitialize lambdaself:self.__call_interface_method__("_ialg","reinitialize")
tuple	restart lambdaself:self.__call_interface_method__("_ialg","restart")
tuple	sysInitialize lambdaself:self.__call_interface_method__("_ialg","sysInitialize")
tuple	sysStart lambdaself:self.__call_interface_method__("_ialg","sysStart")
tuple	sysExecute lambdaself:self.__call_interface_method__("_ialg","sysExecute")
tuple	sysStop lambdaself:self.__call_interface_method__("_ialg","sysStop")
tuple	sysFinalize lambdaself:self.__call_interface_method__("_ialg","sysFinalize")
tuple	sysReinitialize lambdaself:self.__call_interface_method__("_ialg","sysReinitialize")
tuple	sysRestart lambdaself:self.__call_interface_method__("_ialg","sysRestart")

Detailed Description

The base class for easy histogramming.

*******************************************************************************
*                                                * 'Physisics do not like it, *
*                                                *  physisics do not need it, *
*                                                *  physisics do not use  it' *
*                                                * ****************************
*  Usage:                                                                     *
*                                                                             *
*  from GaudiPython.GaudiAlgs import HistoAlgo, SUCCESS                       *
*                                                                             *
*  class MyClass(HistoAlgo) :                                                 *
*       ' My specific Algorithm, derived from GaudiAlgo base class '          *
*       def __init__( self , name , **args ) :                                *
*            'Constructor from algorithm instance name'                       *
*             #invoke the constructor of base class                           *
*             HistoAlgo.__init__(self , name , **args )                       *
*                                                                             *
*       def execute ( self ) :                                                *
*            'Major method (from IAlgorithm interface)'                       *
*                                                                             *
*           # get some data from Transient Event Store                        *
*           tracks = self.get('/Event/Rec/Tracks')                            *
*                                                                             *
*           self.plot1D ( tracks->size() , '#tracks' , 0 , 100 )              *
*                                                                             *
*           return SUCCESS                                                    *
*                                                                             *
* Alternatively the histogram  could be booked in advance:                    *
*                                                                             *
*  class MyClass(HistoAlgo) :                                                 *
*       ' My specific Algorithm, derived from GaudiAlgo base class '          *
*       def __init__( self , name ) :                                         *
*            'Constructor from algorithm instance name'                       *
*             #invoke the constructor of base class                           *
*             HistoAlgo.__init__(self , name )                                *
*                                                                             *
*       def initialize ( self ) :                                             *
*           'Algorithm initialization'                                        *
*           # initialize the base class                                       *
*           status = HistoAlgo.initialize( self )                             *
*           if status.isFailure() : return status                             *
*                                                                             *
*           # book the histogram                                              *
*           self.h1 = selff.book1D ( '#tracks' , 0 , 100 )                    *
*                                                                             *
*           return SUCCESS                                                    *
*                                                                             *
*                                                                             *
*       def execute ( self ) :                                                *
*            'Major method (from IAlgorithm interface)'                       *
*                                                                             *
*           # get some data from Transient Event Store                        *
*           tracks = self.get('/Event/Rec/Tracks')                            *
*                                                                             *
*           # fill the histogram                                              *
*           self.h1.fill ( tracks->size() )                                   *
*                                                                             *
*           return SUCCESS                                                    *
*                                                                             *
*******************************************************************************

Usage:

from GaudiPython.GaudiAlgs import HistoAlgo, SUCCESS

class MyClass(HistoAlgo) :
     ' My specific Algorithm, derived from GaudiAlgo base class '
     def __init__( self , name , **args ) :
          'Constructor from algorithm instance name & parameters'
           #invoke the constructor of base class
           HistoAlgo.__init__(self , name , **args )

     def execute ( self ) :
          'Major method (from IAlgorithm interface)'

         # get some data from Transient Event Store
         tracks = self.get('/Event/Rec/Tracks')

         self.plot1D ( tracks->size() , '#tracks' , 0 , 100 )

         return SUCCESS

Alternatively the histogram could be booked in advance:

class MyClass(HistoAlgo) :
     ' My specific Algorithm, derived from GaudiAlgo base class '
     def __init__( self , name ) :
          'Constructor from algorithm instance name'
           #invoke the constructor of base class
           HistoAlgo.__init__(self , name )

     def initialize ( self ) :
         'Algorithm initialization'
         # initialize the base class
         status = HistoAlgo.initialize( self )
         if status.isFailure() : return status

         # book the histogram
         self.h1 = selff.book1D ( '#tracks' , 0 , 100 )

         return SUCCESS


     def execute ( self ) :
          'Major method (from IAlgorithm interface)'

         # get some data from Transient Event Store
         tracks = self.get('/Event/Rec/Tracks')

         # fill the histogram
         self.h1.fill ( tracks->size() )

          return SUCCESS

See Also

GaudiHistoAlg

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-11-26

Definition at line 677 of file GaudiAlgs.py.

---

The documentation for this class was generated from the following file:

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r5/GaudiPython/python/GaudiPython/GaudiAlgs.py