CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Attributes
plotting.AggregateBins Class Reference

Public Member Functions

def __init__
 
def __str__
 
def create
 

Private Attributes

 _histoName
 
 _ignoreMissingBins
 
 _mapping
 
 _minExistingBins
 
 _name
 
 _normalizeTo
 
 _originalOrder
 
 _renameBin
 
 _scale
 

Detailed Description

Class to create a histogram by aggregating bins of another histogram to a bin of the resulting histogram.

Definition at line 779 of file plotting.py.

Constructor & Destructor Documentation

def plotting.AggregateBins.__init__ (   self,
  name,
  histoName,
  mapping,
  normalizeTo = None,
  scale = None,
  renameBin = None,
  ignoreMissingBins = False,
  minExistingBins = None,
  originalOrder = False 
) 
Constructor.

Arguments:
name      -- String for the name of the resulting histogram
histoName -- String for the name of the source histogram
mapping   -- Dictionary for mapping the bins (see below)

Keyword arguments:
normalizeTo -- Optional string of a bin label in the source histogram. If given, all bins of the resulting histogram are divided by the value of this bin.
scale       -- Optional number for scaling the histogram (passed to ROOT.TH1.Scale())
renameBin   -- Optional function (string -> string) to rename the bins of the input histogram
originalOrder -- Boolean for using the order of bins in the histogram (default False)

Mapping structure (mapping):

Dictionary (you probably want to use collections.OrderedDict)
should be a mapping from the destination bin label to a list
of source bin labels ("dst -> [src]").

Definition at line 781 of file plotting.py.

781 
782  def __init__(self, name, histoName, mapping, normalizeTo=None, scale=None, renameBin=None, ignoreMissingBins=False, minExistingBins=None, originalOrder=False):
783  """Constructor.
784 
785  Arguments:
786  name -- String for the name of the resulting histogram
787  histoName -- String for the name of the source histogram
788  mapping -- Dictionary for mapping the bins (see below)
789 
790  Keyword arguments:
791  normalizeTo -- Optional string of a bin label in the source histogram. If given, all bins of the resulting histogram are divided by the value of this bin.
792  scale -- Optional number for scaling the histogram (passed to ROOT.TH1.Scale())
793  renameBin -- Optional function (string -> string) to rename the bins of the input histogram
794  originalOrder -- Boolean for using the order of bins in the histogram (default False)
795 
796  Mapping structure (mapping):
797 
798  Dictionary (you probably want to use collections.OrderedDict)
799  should be a mapping from the destination bin label to a list
800  of source bin labels ("dst -> [src]").
801  """
802  self._name = name
803  self._histoName = histoName
804  self._mapping = mapping
805  self._normalizeTo = normalizeTo
806  self._scale = scale
807  self._renameBin = renameBin
808  self._ignoreMissingBins = ignoreMissingBins
809  self._minExistingBins = minExistingBins
810  self._originalOrder = originalOrder

Member Function Documentation

def plotting.AggregateBins.__str__ (   self) 
String representation, returns the name

Definition at line 811 of file plotting.py.

References FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, LikelihoodSpecies._name, L1TMuon::PtAssignmentUnit._name, L1TMuon::PtRefinementUnit._name, LikelihoodPdfProduct._name, LikelihoodPdf._name, citk::IsolationConeDefinitionBase._name, Logger._name, hcaldqm::DQModule._name, DrellYanValidation._name, WValidation._name, HistoParams< T >._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, CutApplicatorBase._name, ElectronMVAEstimatorRun2Phys14NonTrig._name, PhotonMVAEstimatorRun2Spring15NonTrig._name, PhotonMVAEstimatorRun2Phys14NonTrig._name, GeometricDetExtra._name, ElectronMVAEstimatorRun2Spring15Trig._name, ElectronMVAEstimatorRun2Spring15NonTrig._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, Vispa.Views.PropertyView.Property._name, SequenceTypes.SequencePlaceholder._name, plotting.Subtract._name, plotting.Transform._name, plotting.FakeDuplicate._name, plotting.CutEfficiency._name, and plotting.AggregateBins._name.

811 
812  def __str__(self):
813  """String representation, returns the name"""
814  return self._name
def plotting.AggregateBins.create (   self,
  tdirectory 
) 
Create and return the histogram from a TDirectory

Definition at line 815 of file plotting.py.

References plotting._getOrCreateObject(), plotting.AggregateBins._histoName, plotting.AggregateBins._ignoreMissingBins, plotting.AggregateBins._mapping, plotting.AggregateBins._minExistingBins, FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, LikelihoodSpecies._name, L1TMuon::PtAssignmentUnit._name, L1TMuon::PtRefinementUnit._name, LikelihoodPdfProduct._name, LikelihoodPdf._name, citk::IsolationConeDefinitionBase._name, Logger._name, hcaldqm::DQModule._name, DrellYanValidation._name, WValidation._name, HistoParams< T >._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, CutApplicatorBase._name, ElectronMVAEstimatorRun2Phys14NonTrig._name, PhotonMVAEstimatorRun2Spring15NonTrig._name, PhotonMVAEstimatorRun2Phys14NonTrig._name, GeometricDetExtra._name, ElectronMVAEstimatorRun2Spring15Trig._name, ElectronMVAEstimatorRun2Spring15NonTrig._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, Vispa.Views.PropertyView.Property._name, SequenceTypes.SequencePlaceholder._name, plotting.Subtract._name, plotting.Transform._name, plotting.FakeDuplicate._name, plotting.CutEfficiency._name, plotting.AggregateBins._name, plotting.AggregateBins._normalizeTo, plotting.AggregateBins._originalOrder, plotting.AggregateBins._renameBin, Vispa.Gui.VispaWidget.VispaWidget._scale, plotting.AggregateBins._scale, plotting._th1ToOrderedDict(), alcazmumu_cfi.filter, cmsHarvester.index, and ComparisonHelper.zip().

815 
816  def create(self, tdirectory):
817  """Create and return the histogram from a TDirectory"""
818  th1 = _getOrCreateObject(tdirectory, self._histoName)
819  if th1 is None:
820  return None
821 
822  binLabels = [""]*len(self._mapping)
823  binValues = [None]*len(self._mapping)
824 
825  # TH1 can't really be used as a map/dict, so convert it here:
826  values = _th1ToOrderedDict(th1, self._renameBin)
827 
828  binIndexOrder = [] # for reordering bins if self._originalOrder is True
829  for i, (key, labels) in enumerate(self._mapping.iteritems()):
830  sumTime = 0.
831  sumErrorSq = 0.
832  nsum = 0
833  for l in labels:
834  try:
835  sumTime += values[l][0]
836  sumErrorSq += values[l][1]**2
837  nsum += 1
838  except KeyError:
839  pass
840 
841  if nsum > 0:
842  binValues[i] = (sumTime, math.sqrt(sumErrorSq))
843  binLabels[i] = key
844 
845  ivalue = len(values)+1
846  if len(labels) > 0:
847  # first label doesn't necessarily exist (especially for
848  # the iteration timing plots), so let's test them all
849  for lab in labels:
850  if lab in values:
851  ivalue = values.keys().index(lab)
852  break
853  binIndexOrder.append( (ivalue, i) )
854 
855  if self._originalOrder:
856  binIndexOrder.sort(key=lambda t: t[0])
857  tmpVal = []
858  tmpLab = []
859  for i in xrange(0, len(binValues)):
860  fromIndex = binIndexOrder[i][1]
861  tmpVal.append(binValues[fromIndex])
862  tmpLab.append(binLabels[fromIndex])
863  binValues = tmpVal
864  binLabels = tmpLab
865 
866  if self._minExistingBins is not None and (len(binValues)-binValues.count(None)) < self._minExistingBins:
867  return None
868 
869  if self._ignoreMissingBins:
870  for i, val in enumerate(binValues):
871  if val is None:
872  binLabels[i] = None
873  binValues = filter(lambda v: v is not None, binValues)
874  binLabels = filter(lambda v: v is not None, binLabels)
875  if len(binValues) == 0:
876  return None
877 
878  result = ROOT.TH1F(self._name, self._name, len(binValues), 0, len(binValues))
879  for i, (value, label) in enumerate(zip(binValues, binLabels)):
880  if value is not None:
881  result.SetBinContent(i+1, value[0])
882  result.SetBinError(i+1, value[1])
883  result.GetXaxis().SetBinLabel(i+1, label)
884 
885  if self._normalizeTo is not None:
886  bin = th1.GetXaxis().FindBin(self._normalizeTo)
887  if bin <= 0:
888  print "Trying to normalize {name} to {binlabel}, which does not exist".format(name=self._name, binlabel=self._normalizeTo)
889  sys.exit(1)
890  value = th1.GetBinContent(bin)
891  if value != 0:
892  result.Scale(1/value)
893 
894  if self._scale is not None:
895  result.Scale(self._scale)
896 
897  return result
plotting._th1ToOrderedDict
def _th1ToOrderedDict
Definition: plotting.py:96
alcazmumu_cfi.filter
tuple filter
Definition: alcazmumu_cfi.py:34
ComparisonHelper::zip
OutputIterator zip(InputIterator1 first1, InputIterator1 last1, InputIterator2 first2, InputIterator2 last2, OutputIterator result, Compare comp)
Definition: L1TStage2CaloLayer1.h:38
plotting._getOrCreateObject
def _getOrCreateObject
Definition: plotting.py:53

Member Data Documentation

plotting.AggregateBins._histoName
private

Definition at line 802 of file plotting.py.

Referenced by plotting.AggregateBins.create().

plotting.AggregateBins._ignoreMissingBins
private

Definition at line 807 of file plotting.py.

Referenced by plotting.AggregateBins.create().

plotting.AggregateBins._mapping
private

Definition at line 803 of file plotting.py.

Referenced by plotting.AggregateBins.create().

plotting.AggregateBins._minExistingBins
private

Definition at line 808 of file plotting.py.

Referenced by plotting.AggregateBins.create().

plotting.AggregateBins._name
private

Definition at line 801 of file plotting.py.

Referenced by plotting.AggregateBins.__str__(), plotting.AggregateHistos.__str__(), plotting.ROC.__str__(), trackingPlots.TimePerTrackPlot.__str__(), plotting.PlotGroup._drawSeparate(), plotting.PlotGroup._save(), plotting.AggregateBins.create(), plotting.AggregateHistos.create(), trackingPlots.TimePerTrackPlot.create(), plotting.Plot.create(), plotting.PlotGroup.draw(), plotting.Plot.getName(), plotting.PlotGroup.getName(), plotting.PlotterFolder.getName(), plotting.PlotterItem.getName(), plotting.PlotterFolder.getSelectionNameIterator(), validation.SimpleSample.name(), trackingPlots.Iteration.name(), plotting.PlotterItem.readDirs(), and plotting.PlotGroup.remove().

plotting.AggregateBins._normalizeTo
private

Definition at line 804 of file plotting.py.

Referenced by plotting.AggregateBins.create(), and plotting.AggregateHistos.create().

plotting.AggregateBins._originalOrder
private

Definition at line 809 of file plotting.py.

Referenced by plotting.AggregateBins.create().

plotting.AggregateBins._renameBin
private

Definition at line 806 of file plotting.py.

Referenced by plotting.AggregateBins.create().

plotting.AggregateBins._scale
private

Definition at line 805 of file plotting.py.

Referenced by plotting.AggregateBins.create(), and plotting.Plot.create().

Generated for CMSSW Reference Manual by doxygen 1.8.5