The Gaudi Framework  v37r1 (a7f61348)
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 674 of file Bindings.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from GaudiPython.Bindings.iDataSvc.

Definition at line 675 of file Bindings.py.

675  def __init__(self, name, ihs):
676  self.__dict__["_ihs"] = InterfaceCast(gbl.IHistogramSvc)(ihs)
677  iDataSvc.__init__(self, name, ihs)
678 

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

727  def __getitem__(self, path):
728  """
729  Retrieve the object from Histogram Transient Store (by path)
730  The reference to AIDA histogram is returned (if possible)
731  >>> svc = ...
732  >>> histo = svc['path/to/my/histogram']
733  """
734  h = self.retrieve(path)
735  if h:
736  return h
737  return iDataSvc.__getitem__(self, path)
738 

◆ book()

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

Definition at line 711 of file Bindings.py.

711  def book(self, *args):
712  """
713  Book the histograms(1D,2D&3D) , see IHistogramSvc::book
714  >>> svc = ...
715  >>> histo = svc.book( .... )
716  """
717  return self._ihs.book(*args)
718 

◆ bookProf()

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

Definition at line 719 of file Bindings.py.

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

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

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

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

748  def getAsROOT(self, path):
749  """
750  Retrieve the histogram from Histogram Transient Store (by path)
751  The Underlying native ROOT object is returned (if possible)
752  >>> svc = ...
753  >>> histo = svc.getAsROOT ( 'path/to/my/histogram' )
754  """
755  fun = gbl.Gaudi.Utils.Aida2ROOT.aida2root
756  return fun(self.getAsAIDA(path))
757 
758 
759 # ----iNTupleSvc class---------------------------------------------------------
760 
761 

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

694  def retrieve(self, path):
695  """
696  Retrieve AIDA histogram or AIDA profile histogram by path in Histogram Transient Store
697  >>> svc = ...
698  >>> histo = svc.retrieve ( 'path/to/my/histogram' )
699  """
700  h = self.retrieve1D(path)
701  if not h:
702  h = self.retrieve2D(path)
703  if not h:
704  h = self.retrieve3D(path)
705  if not h:
706  h = self.retrieveProfile1D(path)
707  if not h:
708  h = self.retrieveProfile2D(path)
709  return h
710 

◆ retrieve1D()

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

Definition at line 679 of file Bindings.py.

679  def retrieve1D(self, path):
680  return Helper.histo1D(self._ihs, path)
681 

◆ retrieve2D()

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

Definition at line 682 of file Bindings.py.

682  def retrieve2D(self, path):
683  return Helper.histo2D(self._ihs, path)
684 

◆ retrieve3D()

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

Definition at line 685 of file Bindings.py.

685  def retrieve3D(self, path):
686  return Helper.histo3D(self._ihs, path)
687 

◆ retrieveProfile1D()

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

Definition at line 688 of file Bindings.py.

688  def retrieveProfile1D(self, path):
689  return Helper.profile1D(self._ihs, path)
690 

◆ retrieveProfile2D()

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

Definition at line 691 of file Bindings.py.

691  def retrieveProfile2D(self, path):
692  return Helper.profile2D(self._ihs, path)
693 

The documentation for this class was generated from the following file:
GaudiAlg.HistoUtils.getAsROOT
def getAsROOT(path, **kwargs)
Definition: HistoUtils.py:382
GaudiPython.Pythonizations.__getitem__
__getitem__
Definition: Pythonizations.py:144
GaudiAlg.HistoUtils.book
def book(*args, **kwargs)
Definition: HistoUtils.py:127
GaudiAlg.HistoUtils.bookProf
def bookProf(*args, **kwargs)
Definition: HistoUtils.py:271
GaudiAlg.HistoUtils.getAsAIDA
def getAsAIDA(path, **kwargs)
Definition: HistoUtils.py:355