The Gaudi Framework  v33r1 (b1225454)
GaudiPython.Bindings.iHistogramSvc Class Reference
Inheritance diagram for GaudiPython.Bindings.iHistogramSvc:
Collaboration diagram for GaudiPython.Bindings.iHistogramSvc:

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 699 of file Bindings.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 700 of file Bindings.py.

700  def __init__(self, name, ihs):
701  self.__dict__['_ihs'] = InterfaceCast(gbl.IHistogramSvc)(ihs)
702  iDataSvc.__init__(self, name, ihs)
703 

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 752 of file Bindings.py.

752  def __getitem__(self, path):
753  """
754  Retrieve the object from Histogram Transient Store (by path)
755  The reference to AIDA histogram is returned (if possible)
756  >>> svc = ...
757  >>> histo = svc['path/to/my/histogram']
758  """
759  h = self.retrieve(path)
760  if h:
761  return h
762  return iDataSvc.__getitem__(self, path)
763 

◆ book()

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

Definition at line 736 of file Bindings.py.

736  def book(self, *args):
737  """
738  Book the histograms(1D,2D&3D) , see IHistogramSvc::book
739  >>> svc = ...
740  >>> histo = svc.book( .... )
741  """
742  return self._ihs.book(*args)
743 
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 744 of file Bindings.py.

744  def bookProf(self, *args):
745  """
746  Book the profile(1D&2D) histograms, see IHistogramSvc::bookProf
747  >>> svc = ...
748  >>> histo = svc.bookProf( .... )
749  """
750  return self._ihs.bookProf(*args)
751 
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 764 of file Bindings.py.

764  def getAsAIDA(self, path):
765  """
766  Retrieve the histogram from Histogram Transient Store (by path)
767  The reference to AIDA histogram is returned (if possible)
768  >>> svc = ...
769  >>> histo = svc.getAsAIDA ( 'path/to/my/histogram' )
770  """
771  return self.__getitem__(path)
772 
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 773 of file Bindings.py.

773  def getAsROOT(self, path):
774  """
775  Retrieve the histogram from Histogram Transient Store (by path)
776  The Underlying native ROOT object is returned (if possible)
777  >>> svc = ...
778  >>> histo = svc.getAsROOT ( 'path/to/my/histogram' )
779  """
780  fun = gbl.Gaudi.Utils.Aida2ROOT.aida2root
781  return fun(self.getAsAIDA(path))
782 
783 
784 # ----iNTupleSvc class---------------------------------------------------------
785 
786 
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 719 of file Bindings.py.

719  def retrieve(self, path):
720  """
721  Retrieve AIDA histogram or AIDA profile histogram by path in Histogram Transient Store
722  >>> svc = ...
723  >>> histo = svc.retrieve ( 'path/to/my/histogram' )
724  """
725  h = self.retrieve1D(path)
726  if not h:
727  h = self.retrieve2D(path)
728  if not h:
729  h = self.retrieve3D(path)
730  if not h:
731  h = self.retrieveProfile1D(path)
732  if not h:
733  h = self.retrieveProfile2D(path)
734  return h
735 

◆ retrieve1D()

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

Definition at line 704 of file Bindings.py.

704  def retrieve1D(self, path):
705  return Helper.histo1D(self._ihs, path)
706 

◆ retrieve2D()

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

Definition at line 707 of file Bindings.py.

707  def retrieve2D(self, path):
708  return Helper.histo2D(self._ihs, path)
709 

◆ retrieve3D()

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

Definition at line 710 of file Bindings.py.

710  def retrieve3D(self, path):
711  return Helper.histo3D(self._ihs, path)
712 

◆ retrieveProfile1D()

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

Definition at line 713 of file Bindings.py.

713  def retrieveProfile1D(self, path):
714  return Helper.profile1D(self._ihs, path)
715 

◆ retrieveProfile2D()

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

Definition at line 716 of file Bindings.py.

716  def retrieveProfile2D(self, path):
717  return Helper.profile2D(self._ihs, path)
718 

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