plotting.Plot Class Reference

Public Member Functions
def	__init__ (self, name, kwargs)
def	addToLegend (self, legend, legendLabels, denomUncertainty)
def	clone (self, kwargs)
def	create (self, tdirNEvents, requireAllHistograms=False)
def	draw (self, pad, ratio, ratioFactor, nrows)
def	drawRatioUncertainty (self)
def	getName (self)
def	getNumberOfHistograms (self)
def	isEmpty (self)
def	isRatio (self, ratio)
def	isTGraph2D (self)
def	setName (self, name)
def	setProperties (self, kwargs)

Private Member Functions
def	_createOne (self, name, index, tdir, nevents)
def	_normalize (self)
def	_setStats (self, histos, startingX, startingY)

Private Attributes
	_forLegend
	_frame
	_histograms
	_mainAdditional
	_name
	_ratioAdditional
	_ratios
	_tmp_histos
	_xtitle
	_ytitle

Detailed Description

Represents one plot, comparing one or more histograms.

Definition at line 1673 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def plotting.Plot.__init__	(		self,
			name,
			kwargs
	)

Constructor.

Arguments:
name -- String for name of the plot, or Efficiency object

Keyword arguments:
fallback     -- Dictionary for specifying fallback (default None)
outname      -- String for an output name of the plot (default None for the same as 'name')
title        -- String for a title of the plot (default None)
xtitle       -- String for x axis title (default None)
xtitlesize   -- Float for x axis title size (default None)
xtitleoffset -- Float for x axis title offset (default None)
xlabelsize   -- Float for x axis label size (default None)
ytitle       -- String for y axis title (default None)
ytitlesize   -- Float for y axis title size (default None)
ytitleoffset -- Float for y axis title offset (default None)
ztitle       -- String for z axis title (default None)
ztitleoffset -- Float for z axis title offset (default None)
xmin         -- Float for x axis minimum (default None, i.e. automatic)
xmax         -- Float for x axis maximum (default None, i.e. automatic)
ymin         -- Float for y axis minimum (default 0)
ymax         -- Float for y axis maximum (default None, i.e. automatic)
xlog         -- Bool for x axis log status (default False)
ylog         -- Bool for y axis log status (default False)
xgrid        -- Bool for x axis grid status (default True)
ygrid        -- Bool for y axis grid status (default True)
stat         -- Draw stat box? (default False)
fit          -- Do gaussian fit? (default False)
statx        -- Stat box x coordinate (default 0.65)
staty        -- Stat box y coordinate (default 0.8)
statyadjust  -- List of floats for stat box y coordinate adjustments (default None)
normalizeToUnitArea -- Normalize histograms to unit area? (default False)
normalizeToNumberOfEvents -- Normalize histograms to number of events? If yes, the PlotFolder needs 'numberOfEventsHistogram' set to a histogram filled once per event (default False)
profileX     -- Take histograms via ProfileX()? (default False)
fitSlicesY   -- Take histograms via FitSlicesY() (default False)
rebinX       -- rebin x axis (default None)
scale        -- Scale histograms by a number (default None)
xbinlabels   -- List of x axis bin labels (if given, default None)
xbinlabelsize -- Size of x axis bin labels (default None)
xbinlabeloption -- Option string for x axis bin labels (default None)
removeEmptyBins -- Bool for removing empty bins, but only if histogram has bin labels (default False)
printBins    -- Bool for printing bin values, but only if histogram has bin labels (default False)
drawStyle    -- If "hist", draw as line instead of points (default None)
drawCommand  -- Deliver this to Draw() (default: None for same as drawStyle)
lineWidth    -- If drawStyle=="hist", the width of line (default 2)
legendDx     -- Float for moving TLegend in x direction for separate=True (default None)
legendDy     -- Float for moving TLegend in y direction for separate=True (default None)
legendDw     -- Float for changing TLegend width for separate=True (default None)
legendDh     -- Float for changing TLegend height for separate=True (default None)
legend       -- Bool to enable/disable legend (default True)
adjustMarginLeft  -- Float for adjusting left margin (default None)
adjustMarginRight  -- Float for adjusting right margin (default None)
ratio        -- Possibility to disable ratio for this particular plot (default None)
ratioYmin    -- Float for y axis minimum in ratio pad (default: list of values)
ratioYmax    -- Float for y axis maximum in ratio pad (default: list of values)
ratioFit     -- Fit straight line in ratio? (default None)
ratioUncertainty -- Plot uncertainties on ratio? (default True)
ratioCoverageXrange -- Range of x axis values (xmin,xmax) to limit the automatic ratio y axis range calculation to (default None for disabled)
histogramModifier -- Function to be called in create() to modify the histograms (default None)

Definition at line 1675 of file plotting.py.

    def __init__(self, name, **kwargs):
        """ Constructor.

        Arguments:
        name -- String for name of the plot, or Efficiency object

        Keyword arguments:
        fallback     -- Dictionary for specifying fallback (default None)
        outname      -- String for an output name of the plot (default None for the same as 'name')
        title        -- String for a title of the plot (default None)
        xtitle       -- String for x axis title (default None)
        xtitlesize   -- Float for x axis title size (default None)
        xtitleoffset -- Float for x axis title offset (default None)
        xlabelsize   -- Float for x axis label size (default None)
        ytitle       -- String for y axis title (default None)
        ytitlesize   -- Float for y axis title size (default None)
        ytitleoffset -- Float for y axis title offset (default None)
        ztitle       -- String for z axis title (default None)
        ztitleoffset -- Float for z axis title offset (default None)
        xmin         -- Float for x axis minimum (default None, i.e. automatic)
        xmax         -- Float for x axis maximum (default None, i.e. automatic)
        ymin         -- Float for y axis minimum (default 0)
        ymax         -- Float for y axis maximum (default None, i.e. automatic)
        xlog         -- Bool for x axis log status (default False)
        ylog         -- Bool for y axis log status (default False)
        xgrid        -- Bool for x axis grid status (default True)
        ygrid        -- Bool for y axis grid status (default True)
        stat         -- Draw stat box? (default False)
        fit          -- Do gaussian fit? (default False)
        statx        -- Stat box x coordinate (default 0.65)
        staty        -- Stat box y coordinate (default 0.8)
        statyadjust  -- List of floats for stat box y coordinate adjustments (default None)
        normalizeToUnitArea -- Normalize histograms to unit area? (default False)
        normalizeToNumberOfEvents -- Normalize histograms to number of events? If yes, the PlotFolder needs 'numberOfEventsHistogram' set to a histogram filled once per event (default False)
        profileX     -- Take histograms via ProfileX()? (default False)
        fitSlicesY   -- Take histograms via FitSlicesY() (default False)
        rebinX       -- rebin x axis (default None)
        scale        -- Scale histograms by a number (default None)
        xbinlabels   -- List of x axis bin labels (if given, default None)
        xbinlabelsize -- Size of x axis bin labels (default None)
        xbinlabeloption -- Option string for x axis bin labels (default None)
        removeEmptyBins -- Bool for removing empty bins, but only if histogram has bin labels (default False)
        printBins    -- Bool for printing bin values, but only if histogram has bin labels (default False)
        drawStyle    -- If "hist", draw as line instead of points (default None)
        drawCommand  -- Deliver this to Draw() (default: None for same as drawStyle)
        lineWidth    -- If drawStyle=="hist", the width of line (default 2)
        legendDx     -- Float for moving TLegend in x direction for separate=True (default None)
        legendDy     -- Float for moving TLegend in y direction for separate=True (default None)
        legendDw     -- Float for changing TLegend width for separate=True (default None)
        legendDh     -- Float for changing TLegend height for separate=True (default None)
        legend       -- Bool to enable/disable legend (default True)
        adjustMarginLeft  -- Float for adjusting left margin (default None)
        adjustMarginRight  -- Float for adjusting right margin (default None)
        ratio        -- Possibility to disable ratio for this particular plot (default None)
        ratioYmin    -- Float for y axis minimum in ratio pad (default: list of values)
        ratioYmax    -- Float for y axis maximum in ratio pad (default: list of values)
        ratioFit     -- Fit straight line in ratio? (default None)
        ratioUncertainty -- Plot uncertainties on ratio? (default True)
        ratioCoverageXrange -- Range of x axis values (xmin,xmax) to limit the automatic ratio y axis range calculation to (default None for disabled)
        histogramModifier -- Function to be called in create() to modify the histograms (default None)
        """
        self._name = name

        def _set(attr, default):
            setattr(self, "_"+attr, kwargs.get(attr, default))

        _set("fallback", None)
        _set("outname", None)

        _set("title", None)
        _set("xtitle", None)
        _set("xtitlesize", None)
        _set("xtitleoffset", None)
        _set("xlabelsize", None)
        _set("ytitle", None)
        _set("ytitlesize", None)
        _set("ytitleoffset", None)
        _set("ztitle", None)
        _set("ztitleoffset", None)

        _set("xmin", None)
        _set("xmax", None)
        _set("ymin", 0.)
        _set("ymax", None)

        _set("xlog", False)
        _set("ylog", False)
        _set("xgrid", True)
        _set("ygrid", True)

        _set("stat", False)
        _set("fit", False)

        _set("statx", 0.65)
        _set("staty", 0.8)
        _set("statyadjust", None)

        _set("normalizeToUnitArea", False)
        _set("normalizeToNumberOfEvents", False)
        _set("profileX", False)
        _set("fitSlicesY", False)
        _set("rebinX", None)

        _set("scale", None)
        _set("xbinlabels", None)
        _set("xbinlabelsize", None)
        _set("xbinlabeloption", None)
        _set("removeEmptyBins", False)
        _set("printBins", False)

        _set("drawStyle", "EP")
        _set("drawCommand", None)
        _set("lineWidth", 2)

        _set("legendDx", None)
        _set("legendDy", None)
        _set("legendDw", None)
        _set("legendDh", None)
        _set("legend", True)

        _set("adjustMarginLeft", None)
        _set("adjustMarginRight", None)

        _set("ratio", None)
        _set("ratioYmin", [0, 0.2, 0.5, 0.7, 0.8, 0.9, 0.95])
        _set("ratioYmax", [1.05, 1.1, 1.2, 1.3, 1.5, 1.8, 2, 2.5, 3, 4, 5])
        _set("ratioFit", None)
        _set("ratioUncertainty", True)
        _set("ratioCoverageXrange", None)

        _set("histogramModifier", None)

        self._histograms = []

Member Function Documentation

_createOne()

def plotting.Plot._createOne (   self,   name,   index,   tdir,   nevents  )

private

Create one histogram from a TDirectory.

Definition at line 1856 of file plotting.py.

References plotting._getOrCreateObject().

Referenced by plotting.Plot.create().

    def _createOne(self, name, index, tdir, nevents):
        """Create one histogram from a TDirectory."""
        if tdir == None:
            return None

        # If name is a list, pick the name by the index
        if isinstance(name, list):
            name = name[index]

        h = _getOrCreateObject(tdir, name)
        if h is not None and self._normalizeToNumberOfEvents and nevents is not None and nevents != 0:
            h.Scale(1.0/nevents)
        return h

_normalize()

def plotting.Plot._normalize (   self )

private

Normalise histograms to unit area

Definition at line 1962 of file plotting.py.

References RunHistogramManager._histograms, and plotting.Plot._histograms.

Referenced by plotting.Plot.draw().

    def _normalize(self):
        """Normalise histograms to unit area"""

        for h in self._histograms:
            if h is None:
                continue
            i = h.Integral()
            if i == 0:
                continue
            if h.GetSumw2().fN <= 0: # to suppress warning
                h.Sumw2()
            h.Scale(1.0/i)

_setStats()

def plotting.Plot._setStats (   self,   histos,   startingX,   startingY  )

private

Set stats box.

Definition at line 1920 of file plotting.py.

References DTSC._stat, and DTTrigGeom._stat.

    def _setStats(self, histos, startingX, startingY):
        """Set stats box."""
        if not self._stat:
            for h in histos:
                if h is not None and hasattr(h, "SetStats"):
                    h.SetStats(0)
            return

        def _doStats(h, col, dy):
            if h is None:
                return
            h.SetStats(True)

            if self._fit and h.GetEntries() > 0.5:
                h.Fit("gaus", "Q")
                f = h.GetListOfFunctions().FindObject("gaus")
                if f == None:
                    h.SetStats(0)
                    return
                f.SetLineColor(col)
                f.SetLineWidth(1)
            h.Draw()
            ROOT.gPad.Update()
            st = h.GetListOfFunctions().FindObject("stats")
            if self._fit:
                st.SetOptFit(0o010)
                st.SetOptStat(1001)
            st.SetOptStat(1110)
            st.SetX1NDC(startingX)
            st.SetX2NDC(startingX+0.3)
            st.SetY1NDC(startingY+dy)
            st.SetY2NDC(startingY+dy+0.12)
            st.SetTextColor(col)

        dy = 0.0
        for i, h in enumerate(histos):
            if self._statyadjust is not None and i < len(self._statyadjust):
                dy += self._statyadjust[i]

            _doStats(h, _plotStylesColor[i], dy)
            dy -= 0.16

addToLegend()

def plotting.Plot.addToLegend	(		self,
			legend,
			legendLabels,
			denomUncertainty
	)

Add histograms to a legend.

Arguments:
legend       -- TLegend
legendLabels -- List of strings for the legend labels

Definition at line 2208 of file plotting.py.

References RunHistogramManager._histograms, plotting.Plot._histograms, and reco.zip().

    def addToLegend(self, legend, legendLabels, denomUncertainty):
        """Add histograms to a legend.

        Arguments:
        legend       -- TLegend
        legendLabels -- List of strings for the legend labels
        """
        first = denomUncertainty
        for h, label in zip(self._histograms, legendLabels):
            if h is None:
                first = False
                continue
            if first:
                self._forLegend = h.Clone()
                self._forLegend.SetFillStyle(1001)
                self._forLegend.SetFillColor(ROOT.kGray)
                entry = legend.AddEntry(self._forLegend, label, "lpf")
                first = False
            else:
                legend.AddEntry(h, label, "LP")

clone()

def plotting.Plot.clone	(		self,
			kwargs
	)

Definition at line 1815 of file plotting.py.

References GenericMVAComputerCache.isEmpty(), TkPhase2OTMeasurementDet.isEmpty(), TkPixelMeasurementDet.isEmpty(), TkStackMeasurementDet.isEmpty(), TkDoubleSensMeasurementDet.isEmpty(), reco::PFDisplacedVertexSeed.isEmpty(), MultipleKinematicConstraint.isEmpty(), KinematicTree.isEmpty(), L1MuDTTrackAssembler.isEmpty(), L1MuBMTrackAssembler.isEmpty(), L1MuGMTInputEvent.isEmpty(), cond::TagInfo_t.isEmpty(), BPHKinematicFit.isEmpty(), L1RegionData< T1 >.isEmpty(), cond::persistency::IOVArray.isEmpty(), TkStripMeasurementDet.isEmpty(), BXVector< T >.isEmpty(), HistoData.isEmpty, FWGeometry.isEmpty(), DDXMLElement.isEmpty(), html.Page.isEmpty(), DMRplotter.DMRplotter.isEmpty, plotting.PlotEmpty.isEmpty(), and plotting.Plot.isEmpty().

    def clone(self, **kwargs):
        if not self.isEmpty():
            raise Exception("Plot can be cloned only before histograms have been created")
        cl = copy.copy(self)
        cl.setProperties(**kwargs)
        return cl

create()

def plotting.Plot.create	(		self,
			tdirNEvents,
			requireAllHistograms = False
	)

Create histograms from list of TDirectories

Definition at line 1870 of file plotting.py.

References plotting.Plot._createOne(), RunHistogramManager._histograms, plotting.Plot._histograms, ModulesProxy._ModuleProxy._name, FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, condhdf5tohdf5.H5DataProduct._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, condhdf5tohdf5.H5Tag._name, CutApplicatorBase._name, condhdf5tohdf5.H5GlobalTag._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, conddb2hdf5.DBGlobalTag._name, SequenceTypes.SequencePlaceholder._name, plotting.Subtract._name, plotting.Transform._name, plotting.FakeDuplicate._name, plotting.CutEfficiency._name, plotting.AggregateBins._name, plotting.AggregateHistos._name, plotting.ROC._name, SequenceTypes._TaskBasePlaceholder._name, plotting.Plot._name, plotting.AggregateBins._scale, HistoParams< TH1F >._title, HistoParams< TProfile >._title, HistoParams< T >._title, HistoParams< TH2F >._title, HistoParams< TProfile2D >._title, html.PageSet._title, plotting.Subtract._title, html.HtmlReport._title, plotting.Transform._title, plotting.FakeDuplicate._title, plotting.CutEfficiency._title, genParticles_cff.map, and FastTimerService_cff.range.

    def create(self, tdirNEvents, requireAllHistograms=False):
        """Create histograms from list of TDirectories"""
        self._histograms = [self._createOne(self._name, i, tdirNEvent[0], tdirNEvent[1]) for i, tdirNEvent in enumerate(tdirNEvents)]

        if self._fallback is not None:
            profileX = [self._profileX]*len(self._histograms)
            for i in range(0, len(self._histograms)):
                if self._histograms[i] is None:
                    self._histograms[i] = self._createOne(self._fallback["name"], i, tdirNEvents[i][0], tdirNEvents[i][1])
                    profileX[i] = self._fallback.get("profileX", self._profileX)

        if self._histogramModifier is not None:
            self._histograms = self._histogramModifier(self._histograms)

        if len(self._histograms) > len(_plotStylesColor):
            raise Exception("More histograms (%d) than there are plot styles (%d) defined. Please define more plot styles in this file" % (len(self._histograms), len(_plotStylesColor)))

        # Modify histograms here in case self._name returns numbers
        # and self._histogramModifier creates the histograms from
        # these numbers
        def _modifyHisto(th1, profileX):
            if th1 is None:
                return None

            if profileX:
                th1 = th1.ProfileX()

            if self._fitSlicesY:
                ROOT.TH1.AddDirectory(True)
                th1.FitSlicesY()
                th1 = ROOT.gDirectory.Get(th1.GetName()+"_2")
                th1.SetDirectory(None)
                #th1.SetName(th1.GetName()+"_ref")
                ROOT.TH1.AddDirectory(False)

            if self._title is not None:
                th1.SetTitle(self._title)

            if self._scale is not None:
                th1.Scale(self._scale)

            return th1

        if self._fallback is not None:
            self._histograms = list(map(_modifyHisto, self._histograms, profileX))
        else:
            self._histograms = list(map(lambda h: _modifyHisto(h, self._profileX), self._histograms))
        if requireAllHistograms and None in self._histograms:
            self._histograms = [None]*len(self._histograms)

draw()

def plotting.Plot.draw	(		self,
			pad,
			ratio,
			ratioFactor,
			nrows
	)

Draw the histograms using values for a given algorithm.

Definition at line 1975 of file plotting.py.

References RunHistogramManager._histograms, plotting.Plot._histograms, plotting._mergeBinLabelsX(), plotting._mergeBinLabelsY(), plotting.Plot._normalize(), plotting._th1IncludeOnlyBins(), HistoData.getName(), MaterialInformation.getName(), trklet::MemoryBase.getName(), EcalLogicID.getName(), PCaloHit.getName(), emtf::Node.getName(), trklet::ProcessBase.getName(), CocoaMaterialElementary.getName(), ecaldqm::DBReaderWorker.getName(), ParticleFlux.getName(), FittedEntry.getName(), hcaldqm::mapper::Mapper.getName(), ecaldqm::DBWriterWorker.getName(), FieldHandlerBase< TOutput >.getName(), IdealResult.getName(), TrackingRecHitAlgorithm.getName(), PassiveHit.getName(), jsoncollector::JsonMonitorable.getName(), QCriterion.getName(), hcaldqm::mapper::HashMapper.getName(), CSGAction.getName(), MVAVariableManager< ParticleType >.getName(), AnyMVAEstimatorRun2Base.getName(), DTTPGLutFile.getName(), AlignmentAlgorithm.getName(), L1TUtmCondition.getName(), L1TriggerLutFile.getName(), TkOfflineVariables.getName(), fastsim::InteractionModel.getName(), L1MuGMTReg.getName(), GenericMVAComputer::TaggingVariableIterator< Iter_t >::Value.getName(), pos::PixelPortcardMap.getName(), GEMStation.getName(), PhysicsTools::Variable::Value.getName(), edm::messagelogger::ELseverityLevel.getName(), edm::ELseverityLevel.getName(), RPCDCCLink.getName(), RPCAMCLink.getName(), L1TUtmAlgorithm.getName(), L1TUtmScale.getName(), L1MuGMTRegMMConfig.getName(), L1TUtmCut.getName(), JanAlignmentAlgorithm.getName(), L1TUtmObject.getName(), FourVectorHLT::PathInfo.getName(), cscdqm::HistoDef.getName(), jsoncollector::DataPoint.getName(), L1TUtmTriggerMenu.getName(), RPCLBLink.getName(), ecaldqm::DQWorker.getName(), PhysicsTools::Variable.getName(), PrepareDMRTrends.getName(), dqm::impl::MonitorElement.getName(), L1MuGMTRegSortRankOffset.getName(), L1MuGMTRegCDLConfig.getName(), cscdqm::CSCHistoDef.getName(), plotting.PlotEmpty.getName(), plotting.Plot.getName(), plotting.Plot.isTGraph2D(), and print().

    def draw(self, pad, ratio, ratioFactor, nrows):
        """Draw the histograms using values for a given algorithm."""
#        if len(self._histograms) == 0:
#            print "No histograms for plot {name}".format(name=self._name)
#            return

        isTGraph2D = self.isTGraph2D()
        if isTGraph2D:
            # Ratios for the TGraph2Ds is not that interesting
            ratioOrig = ratio
            ratio = False

        if self._normalizeToUnitArea:
            self._normalize()

        if self._rebinX is not None:
            for h in self._histograms:
                h.Rebin(self._rebinX)

        def _styleMarker(h, msty, col):
            h.SetMarkerStyle(msty)
            h.SetMarkerColor(col)
            h.SetMarkerSize(0.7)
            h.SetLineColor(1)
            h.SetLineWidth(1)

        def _styleHist(h, msty, col):
            _styleMarker(h, msty, col)
            h.SetLineColor(col)
            h.SetLineWidth(self._lineWidth)

        # Use marker or hist style
        style = _styleMarker
        if "hist" in self._drawStyle.lower():
            style = _styleHist
        if len(self._histograms) > 0 and isinstance(self._histograms[0], ROOT.TGraph):
            if "l" in self._drawStyle.lower():
                style = _styleHist

        # Apply style to histograms, filter out Nones
        histos = []
        for i, h in enumerate(self._histograms):
            if h is None:
                continue
            style(h, _plotStylesMarker[i], _plotStylesColor[i])
            histos.append(h)
        if len(histos) == 0:
            if verbose:
                print("No histograms for plot {name}".format(name=self.getName()))
            return

        # Extract x bin labels, make sure that only bins with same
        # label are compared with each other
        histosHaveBinLabels = len(histos[0].GetXaxis().GetBinLabel(1)) > 0
        xbinlabels = self._xbinlabels
        ybinlabels = None
        if xbinlabels is None:
            if histosHaveBinLabels:
                xbinlabels = _mergeBinLabelsX(histos)
                if isinstance(histos[0], ROOT.TH2):
                    ybinlabels = _mergeBinLabelsY(histos)

                if len(histos) > 1: # don't bother if only one histogram
                    # doing this for TH2 is pending for use case, for now there is only 1 histogram/plot for TH2
                    histos = _th1IncludeOnlyBins(histos, xbinlabels)
                    self._tmp_histos = histos # need to keep these in memory too ...

        # Remove empty bins, but only if histograms have bin labels
        if self._removeEmptyBins and histosHaveBinLabels:
            # at this point, all histograms have been "equalized" by their x binning and labels
            # therefore remove bins which are empty in all histograms
            if isinstance(histos[0], ROOT.TH2):
                (histos, xbinlabels, ybinlabels) = _th2RemoveEmptyBins(histos, xbinlabels, ybinlabels)
            else:
                (histos, xbinlabels) = _th1RemoveEmptyBins(histos, xbinlabels)
            self._tmp_histos = histos # need to keep these in memory too ...
            if len(histos) == 0:
                if verbose:
                    print("No histograms with non-empty bins for plot {name}".format(name=self.getName()))
                return

        if self._printBins and histosHaveBinLabels:
            print("####################")
            print(self._name)
            width = max([len(l) for l in xbinlabels])
            tmp = "%%-%ds " % width
            for b in range(1, histos[0].GetNbinsX()+1):
                s = tmp % xbinlabels[b-1]
                for h in histos:
                    s += "%.3f " % h.GetBinContent(b)
                print(s)
            print()

        bounds = _findBounds(histos, self._ylog,
                             xmin=self._xmin, xmax=self._xmax,
                             ymin=self._ymin, ymax=self._ymax)
        zmax = None
        if isinstance(histos[0], ROOT.TH2):
            zmax = max([h.GetMaximum() for h in histos])

        # need to keep these in memory
        self._mainAdditional = []
        self._ratioAdditional = []

        if ratio:
            self._ratios = _calculateRatios(histos, self._ratioUncertainty) # need to keep these in memory too ...
            ratioHistos = [h for h in [r.getRatio() for r in self._ratios[1:]] if h is not None]

            if len(ratioHistos) > 0:
                ratioBoundsY = _findBoundsY(ratioHistos, ylog=False, ymin=self._ratioYmin, ymax=self._ratioYmax, coverage=0.68, coverageRange=self._ratioCoverageXrange)
            else:
                ratioBoundsY = (0.9, 1,1) # hardcoded default in absence of valid ratio calculations

            if self._ratioFit is not None:
                for i, rh in enumerate(ratioHistos):
                    tf_line = ROOT.TF1("line%d"%i, "[0]+x*[1]")
                    tf_line.SetRange(self._ratioFit["rangemin"], self._ratioFit["rangemax"])
                    fitres = rh.Fit(tf_line, "RINSQ")
                    tf_line.SetLineColor(rh.GetMarkerColor())
                    tf_line.SetLineWidth(2)
                    self._ratioAdditional.append(tf_line)
                    box = PlotTextBox(xmin=self._ratioFit.get("boxXmin", 0.14), ymin=None, # None for automatix
                                      xmax=self._ratioFit.get("boxXmax", 0.35), ymax=self._ratioFit.get("boxYmax", 0.09),
                                      color=rh.GetMarkerColor(), font=43, size=11, lineheight=0.02)
                    box.move(dx=(box.width()+0.01)*i)
                    #box.addText("Const: %.4f" % fitres.Parameter(0))
                    #box.addText("Slope: %.4f" % fitres.Parameter(1))
                    box.addText("Const: %.4f#pm%.4f" % (fitres.Parameter(0), fitres.ParError(0)))
                    box.addText("Slope: %.4f#pm%.4f" % (fitres.Parameter(1), fitres.ParError(1)))
                    self._mainAdditional.append(box)


        # Create bounds before stats in order to have the
        # SetRangeUser() calls made before the fit
        #
        # stats is better to be called before frame, otherwise get
        # mess in the plot (that frame creation cleans up)
        if ratio:
            pad.cd(1)
        self._setStats(histos, self._statx, self._staty)

        # Create frame
        if isTGraph2D:
            frame = FrameTGraph2D(pad, bounds, histos, ratioOrig, ratioFactor)
        else:
            if ratio:
                ratioBounds = (bounds[0], ratioBoundsY[0], bounds[2], ratioBoundsY[1])
                frame = FrameRatio(pad, bounds, zmax, ratioBounds, ratioFactor, nrows, xbinlabels, self._xbinlabelsize, self._xbinlabeloption)
            else:
                frame = Frame(pad, bounds, zmax, nrows, xbinlabels, self._xbinlabelsize, self._xbinlabeloption, ybinlabels=ybinlabels)

        # Set log and grid
        frame.setLogx(self._xlog)
        frame.setLogy(self._ylog)
        frame.setGridx(self._xgrid)
        frame.setGridy(self._ygrid)

        # Construct draw option string
        opt = "sames" # s for statbox or something?
        ds = ""
        if self._drawStyle is not None:
            ds = self._drawStyle
        if self._drawCommand is not None:
            ds = self._drawCommand
        if len(ds) > 0:
            opt += " "+ds

        # Set properties of frame
        frame.setTitle(histos[0].GetTitle())
        if self._xtitle == 'Default':
            frame.setXTitle( histos[0].GetXaxis().GetTitle() )
        elif self._xtitle is not None:
            frame.setXTitle(self._xtitle)
        if self._xtitlesize is not None:
            frame.setXTitleSize(self._xtitlesize)
        if self._xtitleoffset is not None:
            frame.setXTitleOffset(self._xtitleoffset)
        if self._xlabelsize is not None:
            frame.setXLabelSize(self._xlabelsize)
        if self._ytitle == 'Default':
            frame.setYTitle( histos[0].GetYaxis().GetTitle() )
        elif self._ytitle is not None:
            frame.setYTitle(self._ytitle)
        if self._ytitlesize is not None:
            frame.setYTitleSize(self._ytitlesize)
        if self._ytitleoffset is not None:
            frame.setYTitleOffset(self._ytitleoffset)
        if self._ztitle is not None:
            frame.setZTitle(self._ztitle)
        if self._ztitleoffset is not None:
            frame.setZTitleOffset(self._ztitleoffset)
        if self._adjustMarginLeft is not None:
            frame.adjustMarginLeft(self._adjustMarginLeft)
        if self._adjustMarginRight is not None:
            frame.adjustMarginRight(self._adjustMarginRight)
        elif "z" in opt:
            frame.adjustMarginLeft(0.03)
            frame.adjustMarginRight(0.08)

        # Draw histograms
        if ratio:
            frame._pad.cd()

        for i, h in enumerate(histos):
            o = opt
            if isTGraph2D and i == 0:
                o = o.replace("sames", "")
            h.Draw(o)

        for addl in self._mainAdditional:
            addl.Draw("same")

        # Draw ratios
        if ratio and len(self._ratios) > 0:
            frame._padRatio.cd()
            firstRatio = self._ratios[0].getRatio()
            if self._ratioUncertainty and firstRatio is not None:
                firstRatio.SetFillStyle(1001)
                firstRatio.SetFillColor(ROOT.kGray)
                firstRatio.SetLineColor(ROOT.kGray)
                firstRatio.SetMarkerColor(ROOT.kGray)
                firstRatio.SetMarkerSize(0)
                self._ratios[0].draw("E2")
                frame._padRatio.RedrawAxis("G") # redraw grid on top of the uncertainty of denominator
            for r in self._ratios[1:]:
                r.draw()

            for addl in self._ratioAdditional:
                addl.Draw("same")

        frame.redrawAxis()
        self._frame = frame # keep the frame in memory for sure

drawRatioUncertainty()

def plotting.Plot.drawRatioUncertainty

(

self

)

Return true if the ratio uncertainty should be drawn

Definition at line 1852 of file plotting.py.

    def drawRatioUncertainty(self):
        """Return true if the ratio uncertainty should be drawn"""
        return self._ratioUncertainty

getName()

def plotting.Plot.getName

(

self

)

Definition at line 1844 of file plotting.py.

References ModulesProxy._ModuleProxy._name, FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, condhdf5tohdf5.H5DataProduct._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, condhdf5tohdf5.H5Tag._name, CutApplicatorBase._name, condhdf5tohdf5.H5GlobalTag._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, conddb2hdf5.DBGlobalTag._name, SequenceTypes.SequencePlaceholder._name, plotting.Subtract._name, plotting.Transform._name, plotting.FakeDuplicate._name, plotting.CutEfficiency._name, plotting.AggregateBins._name, plotting.AggregateHistos._name, plotting.ROC._name, SequenceTypes._TaskBasePlaceholder._name, plotting.Plot._name, and str.

Referenced by plotting.Plot.draw().

    def getName(self):
        if self._outname is not None:
            return self._outname
        if isinstance(self._name, list):
            return str(self._name[0])
        else:
            return str(self._name)

getNumberOfHistograms()

def plotting.Plot.getNumberOfHistograms

(

self

)

Return number of existing histograms.

Definition at line 1822 of file plotting.py.

References RunHistogramManager._histograms, and plotting.Plot._histograms.

Referenced by plotting.Plot.isEmpty().

    def getNumberOfHistograms(self):
        """Return number of existing histograms."""
        return len([h for h in self._histograms if h is not None])

isEmpty()

def plotting.Plot.isEmpty

(

self

)

Return true if there are no histograms created for the plot

Definition at line 1826 of file plotting.py.

References plotting.PlotEmpty.getNumberOfHistograms(), and plotting.Plot.getNumberOfHistograms().

Referenced by plotting.Plot.clone().

    def isEmpty(self):
        """Return true if there are no histograms created for the plot"""
        return self.getNumberOfHistograms() == 0

isRatio()

def plotting.Plot.isRatio	(		self,
			ratio
	)

Definition at line 1836 of file plotting.py.

    def isRatio(self, ratio):
        if self._ratio is None:
            return ratio
        return ratio and self._ratio

isTGraph2D()

def plotting.Plot.isTGraph2D

(

self

)

Definition at line 1830 of file plotting.py.

References RunHistogramManager._histograms, and plotting.Plot._histograms.

Referenced by plotting.Plot.draw().

    def isTGraph2D(self):
        for h in self._histograms:
            if isinstance(h, ROOT.TGraph2D):
                return True
        return False

setName()

def plotting.Plot.setName	(		self,
			name
	)

Definition at line 1841 of file plotting.py.

References ModulesProxy._ModuleProxy._name, FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, condhdf5tohdf5.H5DataProduct._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, condhdf5tohdf5.H5Tag._name, CutApplicatorBase._name, condhdf5tohdf5.H5GlobalTag._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._name, conddb2hdf5.DBGlobalTag._name, SequenceTypes.SequencePlaceholder._name, plotting.Subtract._name, plotting.Transform._name, plotting.FakeDuplicate._name, plotting.CutEfficiency._name, plotting.AggregateBins._name, plotting.AggregateHistos._name, plotting.ROC._name, SequenceTypes._TaskBasePlaceholder._name, and plotting.Plot._name.

    def setName(self, name):
        self._name = name

setProperties()

def plotting.Plot.setProperties	(		self,
			kwargs
	)

Definition at line 1809 of file plotting.py.

    def setProperties(self, **kwargs):
        for name, value in kwargs.items():
            if not hasattr(self, "_"+name):
                raise Exception("No attribute '%s'" % name)
            setattr(self, "_"+name, value)

Member Data Documentation

_forLegend

plotting.Plot._forLegend

private

Definition at line 2221 of file plotting.py.

_frame

plotting.Plot._frame

private

Definition at line 2206 of file plotting.py.

_histograms

plotting.Plot._histograms

private

Definition at line 1807 of file plotting.py.

Referenced by plotting.Plot._normalize(), plotting.Plot.addToLegend(), plotting.Plot.create(), plotting.Plot.draw(), plotting.Plot.getNumberOfHistograms(), and plotting.Plot.isTGraph2D().

_mainAdditional

plotting.Plot._mainAdditional

private

Definition at line 2076 of file plotting.py.

_name

plotting.Plot._name

private

Definition at line 1736 of file plotting.py.

Referenced by trackingPlots.TimePerEventPlot.__str__(), trackingPlots.TimePerTrackPlot.__str__(), trackingPlots.TimePerEventPlot._create(), plotting.PlotGroup._drawSeparate(), plotting.PlotGroup._save(), 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(), plotting.PlotGroup.remove(), and plotting.Plot.setName().

_ratioAdditional

plotting.Plot._ratioAdditional

private

Definition at line 2077 of file plotting.py.

_ratios

plotting.Plot._ratios

private

Definition at line 2080 of file plotting.py.

_tmp_histos

plotting.Plot._tmp_histos

private

Definition at line 2040 of file plotting.py.

_xtitle

plotting.Plot._xtitle

private

Definition at line 2144 of file plotting.py.

_ytitle

plotting.Plot._ytitle

private

Definition at line 2154 of file plotting.py.