The Gaudi Framework  v38r0 (2143aa4c)
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=cppyy.nullptr)
 
def dump (self, node=cppyy.nullptr)
 
def getList (self, node=cppyy.nullptr, lst=[], rootFID=None)
 
def getHistoNames (self, node=cppyy.nullptr, lst=[])
 
def setRoot (self, name, obj)
 
def selectOnlyStore (self)
 
def selectStore (self, n)
 
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 695 of file Bindings.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 696 of file Bindings.py.

696  def __init__(self, name, ihs):
697  self.__dict__["_ihs"] = InterfaceCast(gbl.IHistogramSvc)(ihs)
698  iDataSvc.__init__(self, name, ihs)
699 

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

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

◆ book()

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

Definition at line 732 of file Bindings.py.

732  def book(self, *args):
733  """
734  Book the histograms(1D,2D&3D) , see IHistogramSvc::book
735  >>> svc = ...
736  >>> histo = svc.book( .... )
737  """
738  return self._ihs.book(*args)
739 

◆ bookProf()

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

Definition at line 740 of file Bindings.py.

740  def bookProf(self, *args):
741  """
742  Book the profile(1D&2D) histograms, see IHistogramSvc::bookProf
743  >>> svc = ...
744  >>> histo = svc.bookProf( .... )
745  """
746  return self._ihs.bookProf(*args)
747 

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

760  def getAsAIDA(self, path):
761  """
762  Retrieve the histogram from Histogram Transient Store (by path)
763  The reference to AIDA histogram is returned (if possible)
764  >>> svc = ...
765  >>> histo = svc.getAsAIDA ( 'path/to/my/histogram' )
766  """
767  return self.__getitem__(path)
768 

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

769  def getAsROOT(self, path):
770  """
771  Retrieve the histogram from Histogram Transient Store (by path)
772  The Underlying native ROOT object is returned (if possible)
773  >>> svc = ...
774  >>> histo = svc.getAsROOT ( 'path/to/my/histogram' )
775  """
776  fun = gbl.Gaudi.Utils.Aida2ROOT.aida2root
777  return fun(self.getAsAIDA(path))
778 
779 
780 # ----iNTupleSvc class---------------------------------------------------------
781 
782 

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

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

◆ retrieve1D()

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

Definition at line 700 of file Bindings.py.

700  def retrieve1D(self, path):
701  return Helper.histo1D(self._ihs, path)
702 

◆ retrieve2D()

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

Definition at line 703 of file Bindings.py.

703  def retrieve2D(self, path):
704  return Helper.histo2D(self._ihs, path)
705 

◆ retrieve3D()

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

Definition at line 706 of file Bindings.py.

706  def retrieve3D(self, path):
707  return Helper.histo3D(self._ihs, path)
708 

◆ retrieveProfile1D()

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

Definition at line 709 of file Bindings.py.

709  def retrieveProfile1D(self, path):
710  return Helper.profile1D(self._ihs, path)
711 

◆ retrieveProfile2D()

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

Definition at line 712 of file Bindings.py.

712  def retrieveProfile2D(self, path):
713  return Helper.profile2D(self._ihs, path)
714 

The documentation for this class was generated from the following file:
GaudiAlg.HistoUtils.getAsROOT
def getAsROOT(path, **kwargs)
Definition: HistoUtils.py:381
GaudiPython.Pythonizations.__getitem__
__getitem__
Definition: Pythonizations.py:141
GaudiAlg.HistoUtils.book
def book(*args, **kwargs)
Definition: HistoUtils.py:126
GaudiPartProp.Service.InterfaceCast
InterfaceCast
Definition: Service.py:39
GaudiAlg.HistoUtils.bookProf
def bookProf(*args, **kwargs)
Definition: HistoUtils.py:270
GaudiAlg.HistoUtils.getAsAIDA
def getAsAIDA(path, **kwargs)
Definition: HistoUtils.py:354