The Gaudi Framework  master (594c33fa)
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 698 of file Bindings.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 699 of file Bindings.py.

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

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

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

◆ book()

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

Definition at line 735 of file Bindings.py.

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

◆ bookProf()

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

Definition at line 743 of file Bindings.py.

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

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

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

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

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

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

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

◆ retrieve1D()

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

Definition at line 703 of file Bindings.py.

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

◆ retrieve2D()

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

Definition at line 706 of file Bindings.py.

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

◆ retrieve3D()

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

Definition at line 709 of file Bindings.py.

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

◆ retrieveProfile1D()

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

Definition at line 712 of file Bindings.py.

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

◆ retrieveProfile2D()

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

Definition at line 715 of file Bindings.py.

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

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:40
GaudiAlg.HistoUtils.bookProf
def bookProf(*args, **kwargs)
Definition: HistoUtils.py:270
GaudiAlg.HistoUtils.getAsAIDA
def getAsAIDA(path, **kwargs)
Definition: HistoUtils.py:354