The Gaudi Framework  v33r2 (a6f0ec87)
Public Member Functions | List of all members
GaudiPython.Bindings.iHistogramSvc Class Reference
Inheritance diagram for GaudiPython.Bindings.iHistogramSvc:
Inheritance graph
[legend]
Collaboration diagram for GaudiPython.Bindings.iHistogramSvc:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, name, ihs)
 
def retrieve1D (self, path)
 
def retrieve2D (self, path)
 
def retrieve3D (self, path)
 
def retrieveProfile1D (self, path)
 
def retrieveProfile2D (self, path)
 
def retrieve (self, path)
 
def book (self, *args)
 
def bookProf (self, *args)
 
def __getitem__ (self, path)
 
def getAsAIDA (self, path)
 
def getAsROOT (self, path)
 
- Public Member Functions inherited from GaudiPython.Bindings.iDataSvc
def registerObject (self, path, obj)
 
def unregisterObject (self, path)
 
def retrieveObject (self, path)
 
def findObject (self, path)
 
def getObject (self, path, *args)
 
def __setitem__ (self, path, obj)
 
def __delitem__ (self, path)
 
def leaves (self, node=None)
 
def dump (self, node=None)
 
def getList (self, node=None, lst=[], rootFID=None)
 
def getHistoNames (self, node=None, lst=[])
 
def setRoot (self, name, obj)
 
def clearStore (self)
 
- Public Member Functions inherited from GaudiPython.Bindings.iService
def retrieveInterface (self)
 
def initialize (self)
 
def start (self)
 
def stop (self)
 
def finalize (self)
 
def reinitialize (self)
 
def restart (self)
 
def isValid (self)
 
- Public Member Functions inherited from GaudiPython.Bindings.iProperty
def getInterface (self)
 
def __call_interface_method__ (self, ifname, method, *args)
 
def __setattr__ (self, name, value)
 
def __getattr__ (self, name)
 
def properties (self)
 
def name (self)
 

Detailed Description

Definition at line 708 of file Bindings.py.

Constructor & Destructor Documentation

◆ __init__()

def GaudiPython.Bindings.iHistogramSvc.__init__ (   self,
  name,
  ihs 
)

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 709 of file Bindings.py.

709  def __init__(self, name, ihs):
710  self.__dict__['_ihs'] = InterfaceCast(gbl.IHistogramSvc)(ihs)
711  iDataSvc.__init__(self, name, ihs)
712 

Member Function Documentation

◆ __getitem__()

def GaudiPython.Bindings.iHistogramSvc.__getitem__ (   self,
  path 
) 
Retrieve the object from  Histogram Transient Store (by path)
The reference to AIDA histogram is returned (if possible)
>>> svc = ...
>>> histo = svc['path/to/my/histogram']

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 761 of file Bindings.py.

761  def __getitem__(self, path):
762  """
763  Retrieve the object from Histogram Transient Store (by path)
764  The reference to AIDA histogram is returned (if possible)
765  >>> svc = ...
766  >>> histo = svc['path/to/my/histogram']
767  """
768  h = self.retrieve(path)
769  if h:
770  return h
771  return iDataSvc.__getitem__(self, path)
772 

◆ book()

def GaudiPython.Bindings.iHistogramSvc.book (   self,
*  args 
) 
Book the histograms(1D,2D&3D) , see IHistogramSvc::book
>>> svc = ...
>>> histo = svc.book( .... )

Definition at line 745 of file Bindings.py.

745  def book(self, *args):
746  """
747  Book the histograms(1D,2D&3D) , see IHistogramSvc::book
748  >>> svc = ...
749  >>> histo = svc.book( .... )
750  """
751  return self._ihs.book(*args)
752 
Gaudi::Histos::book
GAUDI_API AIDA::IHistogram1D * book(IHistogramSvc *svc, const std::string &path, const Gaudi::Histo1DDef &hist)
helper function to book 1D-histogram
Definition: HistoDef.cpp:97

◆ bookProf()

def GaudiPython.Bindings.iHistogramSvc.bookProf (   self,
*  args 
) 
Book the profile(1D&2D) histograms, see IHistogramSvc::bookProf
>>> svc = ...
>>> histo = svc.bookProf( .... )

Definition at line 753 of file Bindings.py.

753  def bookProf(self, *args):
754  """
755  Book the profile(1D&2D) histograms, see IHistogramSvc::bookProf
756  >>> svc = ...
757  >>> histo = svc.bookProf( .... )
758  """
759  return self._ihs.bookProf(*args)
760 
GaudiPython.HistoUtils.bookProf
def bookProf(*args, **kwargs)
Definition: HistoUtils.py:267

◆ getAsAIDA()

def GaudiPython.Bindings.iHistogramSvc.getAsAIDA (   self,
  path 
) 
Retrieve the histogram from  Histogram Transient Store (by path)
The reference to AIDA histogram is returned (if possible)
>>> svc = ...
>>> histo = svc.getAsAIDA ( 'path/to/my/histogram' )

Definition at line 773 of file Bindings.py.

773  def getAsAIDA(self, path):
774  """
775  Retrieve the histogram from Histogram Transient Store (by path)
776  The reference to AIDA histogram is returned (if possible)
777  >>> svc = ...
778  >>> histo = svc.getAsAIDA ( 'path/to/my/histogram' )
779  """
780  return self.__getitem__(path)
781 
GaudiPython.HistoUtils.getAsAIDA
def getAsAIDA(path, **kwargs)
Definition: HistoUtils.py:347

◆ getAsROOT()

def GaudiPython.Bindings.iHistogramSvc.getAsROOT (   self,
  path 
) 
Retrieve the histogram from  Histogram Transient Store (by path)
The Underlying native ROOT object is returned (if possible)
>>> svc = ...
>>> histo = svc.getAsROOT ( 'path/to/my/histogram' )

Definition at line 782 of file Bindings.py.

782  def getAsROOT(self, path):
783  """
784  Retrieve the histogram from Histogram Transient Store (by path)
785  The Underlying native ROOT object is returned (if possible)
786  >>> svc = ...
787  >>> histo = svc.getAsROOT ( 'path/to/my/histogram' )
788  """
789  fun = gbl.Gaudi.Utils.Aida2ROOT.aida2root
790  return fun(self.getAsAIDA(path))
791 
792 
793 # ----iNTupleSvc class---------------------------------------------------------
794 
795 
GaudiPython.HistoUtils.getAsROOT
def getAsROOT(path, **kwargs)
Definition: HistoUtils.py:372

◆ retrieve()

def GaudiPython.Bindings.iHistogramSvc.retrieve (   self,
  path 
) 
Retrieve AIDA histogram or AIDA profile histogram by path in Histogram Transient Store
>>> svc = ...
>>> histo = svc.retrieve ( 'path/to/my/histogram' )

Definition at line 728 of file Bindings.py.

728  def retrieve(self, path):
729  """
730  Retrieve AIDA histogram or AIDA profile histogram by path in Histogram Transient Store
731  >>> svc = ...
732  >>> histo = svc.retrieve ( 'path/to/my/histogram' )
733  """
734  h = self.retrieve1D(path)
735  if not h:
736  h = self.retrieve2D(path)
737  if not h:
738  h = self.retrieve3D(path)
739  if not h:
740  h = self.retrieveProfile1D(path)
741  if not h:
742  h = self.retrieveProfile2D(path)
743  return h
744 

◆ retrieve1D()

def GaudiPython.Bindings.iHistogramSvc.retrieve1D (   self,
  path 
)

Definition at line 713 of file Bindings.py.

713  def retrieve1D(self, path):
714  return Helper.histo1D(self._ihs, path)
715 

◆ retrieve2D()

def GaudiPython.Bindings.iHistogramSvc.retrieve2D (   self,
  path 
)

Definition at line 716 of file Bindings.py.

716  def retrieve2D(self, path):
717  return Helper.histo2D(self._ihs, path)
718 

◆ retrieve3D()

def GaudiPython.Bindings.iHistogramSvc.retrieve3D (   self,
  path 
)

Definition at line 719 of file Bindings.py.

719  def retrieve3D(self, path):
720  return Helper.histo3D(self._ihs, path)
721 

◆ retrieveProfile1D()

def GaudiPython.Bindings.iHistogramSvc.retrieveProfile1D (   self,
  path 
)

Definition at line 722 of file Bindings.py.

722  def retrieveProfile1D(self, path):
723  return Helper.profile1D(self._ihs, path)
724 

◆ retrieveProfile2D()

def GaudiPython.Bindings.iHistogramSvc.retrieveProfile2D (   self,
  path 
)

Definition at line 725 of file Bindings.py.

725  def retrieveProfile2D(self, path):
726  return Helper.profile2D(self._ihs, path)
727 
The documentation for this class was generated from the following file: