The Gaudi Framework  v36r9p1 (5c15b2bb)
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 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 684 of file Bindings.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 685 of file Bindings.py.

685  def __init__(self, name, ihs):
686  self.__dict__["_ihs"] = InterfaceCast(gbl.IHistogramSvc)(ihs)
687  iDataSvc.__init__(self, name, ihs)
688 

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

737  def __getitem__(self, path):
738  """
739  Retrieve the object from Histogram Transient Store (by path)
740  The reference to AIDA histogram is returned (if possible)
741  >>> svc = ...
742  >>> histo = svc['path/to/my/histogram']
743  """
744  h = self.retrieve(path)
745  if h:
746  return h
747  return iDataSvc.__getitem__(self, path)
748 

◆ book()

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

Definition at line 721 of file Bindings.py.

721  def book(self, *args):
722  """
723  Book the histograms(1D,2D&3D) , see IHistogramSvc::book
724  >>> svc = ...
725  >>> histo = svc.book( .... )
726  """
727  return self._ihs.book(*args)
728 

◆ bookProf()

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

Definition at line 729 of file Bindings.py.

729  def bookProf(self, *args):
730  """
731  Book the profile(1D&2D) histograms, see IHistogramSvc::bookProf
732  >>> svc = ...
733  >>> histo = svc.bookProf( .... )
734  """
735  return self._ihs.bookProf(*args)
736 

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

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

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

758  def getAsROOT(self, path):
759  """
760  Retrieve the histogram from Histogram Transient Store (by path)
761  The Underlying native ROOT object is returned (if possible)
762  >>> svc = ...
763  >>> histo = svc.getAsROOT ( 'path/to/my/histogram' )
764  """
765  fun = gbl.Gaudi.Utils.Aida2ROOT.aida2root
766  return fun(self.getAsAIDA(path))
767 
768 
769 # ----iNTupleSvc class---------------------------------------------------------
770 
771 

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

704  def retrieve(self, path):
705  """
706  Retrieve AIDA histogram or AIDA profile histogram by path in Histogram Transient Store
707  >>> svc = ...
708  >>> histo = svc.retrieve ( 'path/to/my/histogram' )
709  """
710  h = self.retrieve1D(path)
711  if not h:
712  h = self.retrieve2D(path)
713  if not h:
714  h = self.retrieve3D(path)
715  if not h:
716  h = self.retrieveProfile1D(path)
717  if not h:
718  h = self.retrieveProfile2D(path)
719  return h
720 

◆ retrieve1D()

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

Definition at line 689 of file Bindings.py.

689  def retrieve1D(self, path):
690  return Helper.histo1D(self._ihs, path)
691 

◆ retrieve2D()

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

Definition at line 692 of file Bindings.py.

692  def retrieve2D(self, path):
693  return Helper.histo2D(self._ihs, path)
694 

◆ retrieve3D()

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

Definition at line 695 of file Bindings.py.

695  def retrieve3D(self, path):
696  return Helper.histo3D(self._ihs, path)
697 

◆ retrieveProfile1D()

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

Definition at line 698 of file Bindings.py.

698  def retrieveProfile1D(self, path):
699  return Helper.profile1D(self._ihs, path)
700 

◆ retrieveProfile2D()

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

Definition at line 701 of file Bindings.py.

701  def retrieveProfile2D(self, path):
702  return Helper.profile2D(self._ihs, path)
703 

The documentation for this class was generated from the following file:
GaudiPython.HistoUtils.bookProf
def bookProf(*args, **kwargs)
Definition: HistoUtils.py:271
GaudiPython.Pythonizations.__getitem__
__getitem__
Definition: Pythonizations.py:144
GaudiPython.HistoUtils.getAsAIDA
def getAsAIDA(path, **kwargs)
Definition: HistoUtils.py:355
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
GaudiPython.HistoUtils.getAsROOT
def getAsROOT(path, **kwargs)
Definition: HistoUtils.py:382