The Gaudi Framework  v36r11 (bdb84f5f)
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 683 of file Bindings.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 684 of file Bindings.py.

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

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

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

◆ book()

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

Definition at line 720 of file Bindings.py.

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

◆ bookProf()

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

Definition at line 728 of file Bindings.py.

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

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

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

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

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

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

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

◆ retrieve1D()

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

Definition at line 688 of file Bindings.py.

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

◆ retrieve2D()

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

Definition at line 691 of file Bindings.py.

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

◆ retrieve3D()

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

Definition at line 694 of file Bindings.py.

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

◆ retrieveProfile1D()

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

Definition at line 697 of file Bindings.py.

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

◆ retrieveProfile2D()

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

Definition at line 700 of file Bindings.py.

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

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