plotting.PlotGroup Class Reference

Inheritance diagram for plotting.PlotGroup:

Public Member Functions
def	__init__ (self, name, plots, kwargs)
def	append (self, plot)
def	clear (self)
def	create (self, tdirectoryNEvents, requireAllHistograms=False)
def	draw (self, legendLabels, prefix=None, separate=False, saveFormat=".pdf", ratio=True, directory="")
def	getName (self)
def	getPlot (self, name)
def	getPlots (self)
def	onlyForPileup (self)
def	remove (self, name)
def	setProperties (self, kwargs)

Private Member Functions
def	_createLegend (self, plot, legendLabels, lx1, ly1, lx2, ly2, textSize=0.016, denomUncertainty=True)
def	_drawSeparate (self, legendLabels, prefix, saveFormat, ratio, directory)
def	_modifyPadForRatio (self, pad)
def	_save (self, canvas, saveFormat, prefix=None, postfix=None, single=False, directory="")

Private Attributes
	_name
	_plots
	_ratioFactor

Detailed Description

Group of plots, results a TCanvas

Definition at line 2251 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def plotting.PlotGroup.__init__	(		self,
			name,
			plots,
			kwargs
	)

Constructor.

Arguments:
name  -- String for name of the TCanvas, used also as the basename of the picture files
plots -- List of Plot objects

Keyword arguments:
ncols    -- Number of columns (default 2)
legendDx -- Float for moving TLegend in x direction (default None)
legendDy -- Float for moving TLegend in y direction (default None)
legendDw -- Float for changing TLegend width (default None)
legendDh -- Float for changing TLegend height (default None)
legend   -- Bool for disabling legend (default True for legend being enabled)
overrideLegendLabels -- List of strings for legend labels, if given, these are used instead of the ones coming from Plotter (default None)
onlyForPileup  -- Plots this group only for pileup samples

Definition at line 2253 of file plotting.py.

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

        Arguments:
        name  -- String for name of the TCanvas, used also as the basename of the picture files
        plots -- List of Plot objects

        Keyword arguments:
        ncols    -- Number of columns (default 2)
        legendDx -- Float for moving TLegend in x direction (default None)
        legendDy -- Float for moving TLegend in y direction (default None)
        legendDw -- Float for changing TLegend width (default None)
        legendDh -- Float for changing TLegend height (default None)
        legend   -- Bool for disabling legend (default True for legend being enabled)
        overrideLegendLabels -- List of strings for legend labels, if given, these are used instead of the ones coming from Plotter (default None)
        onlyForPileup  -- Plots this group only for pileup samples
        """
        super(PlotGroup, self).__init__()

        self._name = name
        self._plots = plots

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

        _set("ncols", 2)

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

        _set("overrideLegendLabels", None)

        _set("onlyForPileup", False)

        self._ratioFactor = 1.25

Member Function Documentation

_createLegend()

def plotting.PlotGroup._createLegend (   self,   plot,   legendLabels,   lx1,   ly1,   lx2,   ly2,   textSize = 0.016,   denomUncertainty = True  )

private

Definition at line 2481 of file plotting.py.

References GeometryComparisonPlotter._legend.

Referenced by plotting.PlotGroup._drawSeparate(), and plotting.PlotGroup.draw().

    def _createLegend(self, plot, legendLabels, lx1, ly1, lx2, ly2, textSize=0.016, denomUncertainty=True):
        if not self._legend:
            return None

        l = ROOT.TLegend(lx1, ly1, lx2, ly2)
        l.SetTextSize(textSize)
        l.SetLineColor(1)
        l.SetLineWidth(1)
        l.SetLineStyle(1)
        l.SetFillColor(0)
        l.SetMargin(0.07)

        plot.addToLegend(l, legendLabels, denomUncertainty)
        l.Draw()
        return l

_drawSeparate()

def plotting.PlotGroup._drawSeparate (   self,   legendLabels,   prefix,   saveFormat,   ratio,   directory  )

private

Internal method to do the drawing to separate files per Plot instead of a file per PlotGroup

Definition at line 2415 of file plotting.py.

References plotting._createCanvas(), plotting.PlotGroup._createLegend(), plotting.PlotGroup._modifyPadForRatio(), FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, CutApplicatorBase._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._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.PlotGroup._name, plotting.PlotGroup._plots, plotting.PlotGroup._ratioFactor, plotting.PlotGroup._save(), and createfilelist.int.

Referenced by plotting.PlotGroup.draw().

    def _drawSeparate(self, legendLabels, prefix, saveFormat, ratio, directory):
        """Internal method to do the drawing to separate files per Plot instead of a file per PlotGroup"""
        width = 500
        height = 500

        lx1def = 0.6
        lx2def = 0.95
        ly1def = 0.85
        ly2def = 0.95

        ret = []

        for plot in self._plots:
            if plot.isEmpty():
                continue

            canvas = _createCanvas(self._name+"Single", width, height)
            canvasRatio = _createCanvas(self._name+"SingleRatio", width, int(height*self._ratioFactor))

            # from TDRStyle
            for c in [canvas, canvasRatio]:
                c.SetTopMargin(0.05)
                c.SetBottomMargin(0.13)
                c.SetLeftMargin(0.16)
                c.SetRightMargin(0.05)

            ratioForThisPlot = plot.isRatio(ratio)
            c = canvas
            if ratioForThisPlot:
                c = canvasRatio
                c.cd()
                self._modifyPadForRatio(c)

            # Draw plot to canvas
            c.cd()
            plot.draw(c, ratioForThisPlot, self._ratioFactor, 1)

            if plot._legend:
                # Setup legend
                lx1 = lx1def
                lx2 = lx2def
                ly1 = ly1def
                ly2 = ly2def

                if plot._legendDx is not None:
                    lx1 += plot._legendDx
                    lx2 += plot._legendDx
                if plot._legendDy is not None:
                    ly1 += plot._legendDy
                    ly2 += plot._legendDy
                if plot._legendDw is not None:
                    lx2 += plot._legendDw
                if plot._legendDh is not None:
                    ly1 -= plot._legendDh

                c.cd()
                legend = self._createLegend(plot, legendLabels, lx1, ly1, lx2, ly2, textSize=0.03,
                                            denomUncertainty=(ratioForThisPlot and plot.drawRatioUncertainty))

            ret.extend(self._save(c, saveFormat, prefix=prefix, postfix="/"+plot.getName(), single=True, directory=directory))
        return ret

_modifyPadForRatio()

def plotting.PlotGroup._modifyPadForRatio (   self,   pad  )

private

Internal method to set divide a pad to two for ratio plots

Definition at line 2477 of file plotting.py.

References plotting.PlotGroup._ratioFactor.

Referenced by plotting.PlotGroup._drawSeparate(), and plotting.PlotGroup.draw().

    def _modifyPadForRatio(self, pad):
        """Internal method to set divide a pad to two for ratio plots"""
        _modifyPadForRatio(pad, self._ratioFactor)

_save()

def plotting.PlotGroup._save (   self,   canvas,   saveFormat,   prefix = None,   postfix = None,   single = False,   directory = ""  )

private

Definition at line 2497 of file plotting.py.

References FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, CutApplicatorBase._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._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 plotting.PlotGroup._name.

Referenced by plotting.PlotGroup._drawSeparate(), and plotting.PlotGroup.draw().

    def _save(self, canvas, saveFormat, prefix=None, postfix=None, single=False, directory=""):
        # Save the canvas to file and clear
        name = self._name
        if not os.path.exists(directory+'/'+name):
            os.makedirs(directory+'/'+name, exist_ok=True)
        if prefix is not None:
            name = prefix+name
        if postfix is not None:
            name = name+postfix
        name = os.path.join(directory, name)

        if not verbose: # silence saved file printout
            backup = ROOT.gErrorIgnoreLevel
            ROOT.gErrorIgnoreLevel = ROOT.kWarning
        canvas.SaveAs(name+saveFormat)
        if not verbose:
            ROOT.gErrorIgnoreLevel = backup

        if single:
            canvas.Clear()
            canvas.SetLogx(False)
            canvas.SetLogy(False)
        else:
            canvas.Clear("D") # keep subpads

        return [name+saveFormat]

append()

def plotting.PlotGroup.append	(		self,
			plot
	)

Definition at line 2314 of file plotting.py.

References plotting.PlotGroup._plots.

Referenced by diclist.diclist.add().

    def append(self, plot):
        self._plots.append(plot)

clear()

def plotting.PlotGroup.clear

(

self

)

Definition at line 2311 of file plotting.py.

References plotting.PlotGroup._plots.

    def clear(self):
        self._plots = []

create()

def plotting.PlotGroup.create	(		self,
			tdirectoryNEvents,
			requireAllHistograms = False
	)

Create histograms from a list of TDirectories.

Arguments:
tdirectoryNEvents    -- List of (TDirectory, nevents) pairs
requireAllHistograms -- If True, a plot is produced if histograms from all files are present (default: False)

Definition at line 2327 of file plotting.py.

References plotting.PlotGroup._plots.

    def create(self, tdirectoryNEvents, requireAllHistograms=False):
        """Create histograms from a list of TDirectories.

        Arguments:
        tdirectoryNEvents    -- List of (TDirectory, nevents) pairs
        requireAllHistograms -- If True, a plot is produced if histograms from all files are present (default: False)
        """
        for plot in self._plots:
            plot.create(tdirectoryNEvents, requireAllHistograms)

draw()

def plotting.PlotGroup.draw	(		self,
			legendLabels,
			prefix = None,
			separate = False,
			saveFormat = ".pdf",
			ratio = True,
			directory = ""
	)

Draw the histograms using values for a given algorithm.

Arguments:
legendLabels  -- List of strings for legend labels (corresponding to the tdirectories in create())
prefix        -- Optional string for file name prefix (default None)
separate      -- Save the plots of a group to separate files instead of a file per group (default False)
saveFormat   -- String specifying the plot format (default '.pdf')
ratio        -- Add ratio to the plot (default True)
directory     -- Directory where to save the file (default "")

Definition at line 2337 of file plotting.py.

References plotting._createCanvas(), plotting.PlotGroup._createLegend(), plotting.PlotGroup._drawSeparate(), plotting.PlotGroup._modifyPadForRatio(), FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, CutApplicatorBase._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._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.PlotGroup._name, plotting.PlotGroup._plots, plotting.PlotGroup._ratioFactor, plotting.PlotGroup._save(), createfilelist.int, and SiStripPI.max.

    def draw(self, legendLabels, prefix=None, separate=False, saveFormat=".pdf", ratio=True, directory=""):
        """Draw the histograms using values for a given algorithm.

        Arguments:
        legendLabels  -- List of strings for legend labels (corresponding to the tdirectories in create())
        prefix        -- Optional string for file name prefix (default None)
        separate      -- Save the plots of a group to separate files instead of a file per group (default False)
        saveFormat   -- String specifying the plot format (default '.pdf')
        ratio        -- Add ratio to the plot (default True)
        directory     -- Directory where to save the file (default "")
        """

        if self._overrideLegendLabels is not None:
            legendLabels = self._overrideLegendLabels

        # Do not draw the group if it would be empty
        onlyEmptyPlots = True
        for plot in self._plots:
            if not plot.isEmpty():
                onlyEmptyPlots = False
                break
        if onlyEmptyPlots:
            return []

        if separate:
            return self._drawSeparate(legendLabels, prefix, saveFormat, ratio, directory)

        cwidth = 500*self._ncols
        nrows = int((len(self._plots)+self._ncols-1)/self._ncols) # this should work also for odd n
        cheight = 500 * nrows

        if ratio:
            cheight = int(cheight*self._ratioFactor)

        canvas = _createCanvas(self._name, cwidth, cheight)

        canvas.Divide(self._ncols, nrows)
        if ratio:
            for i, plot in enumerate(self._plots):
                pad = canvas.cd(i+1)
                self._modifyPadForRatio(pad)

        # Draw plots to canvas
        for i, plot in enumerate(self._plots):
            pad = canvas.cd(i+1)
            if not plot.isEmpty():
                plot.draw(pad, ratio, self._ratioFactor, nrows)

        if plot._legend:
          # Setup legend
          canvas.cd()
          if len(self._plots) <= 4:
              lx1 = 0.2
              lx2 = 0.9
              ly1 = 0.48
              ly2 = 0.53
          else:
              lx1 = 0.1
              lx2 = 0.9
              ly1 = 0.64
              ly2 = 0.67
          if self._legendDx is not None:
              lx1 += self._legendDx
              lx2 += self._legendDx
          if self._legendDy is not None:
              ly1 += self._legendDy
              ly2 += self._legendDy
          if self._legendDw is not None:
              lx2 += self._legendDw
          if self._legendDh is not None:
              ly1 -= self._legendDh
          plot = max(self._plots, key=lambda p: p.getNumberOfHistograms())
          denomUnc = sum([p.drawRatioUncertainty() for p in self._plots]) > 0
          legend = self._createLegend(plot, legendLabels, lx1, ly1, lx2, ly2,
                                      denomUncertainty=(ratio and denomUnc))

        return self._save(canvas, saveFormat, prefix=prefix, directory=directory)

getName()

def plotting.PlotGroup.getName

(

self

)

Definition at line 2298 of file plotting.py.

References FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, CutApplicatorBase._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._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 plotting.PlotGroup._name.

    def getName(self):
        return self._name

getPlot()

def plotting.PlotGroup.getPlot	(		self,
			name
	)

Definition at line 2317 of file plotting.py.

References plotting.PlotGroup._plots.

    def getPlot(self, name):
        for plot in self._plots:
            if plot.getName() == name:
                return plot
        raise Exception("No Plot named '%s'" % name)

getPlots()

def plotting.PlotGroup.getPlots

(

self

)

Definition at line 2301 of file plotting.py.

References plotting.PlotGroup._plots.

    def getPlots(self):
        return self._plots

onlyForPileup()

def plotting.PlotGroup.onlyForPileup

(

self

)

Return True if the PlotGroup is intended only for pileup samples

Definition at line 2323 of file plotting.py.

References plotting.PlotFolder._onlyForPileup.

    def onlyForPileup(self):
        """Return True if the PlotGroup is intended only for pileup samples"""
        return self._onlyForPileup

remove()

def plotting.PlotGroup.remove	(		self,
			name
	)

Definition at line 2304 of file plotting.py.

References FP420HitsObject._name, TrackerHitsObject._name, PGeometricDet::Item._name, TrackingRecHitAlgorithm._name, Logger._name, hcaldqm::DQModule._name, citk::IsolationConeDefinitionBase._name, WValidation._name, DrellYanValidation._name, hcaldqm::flag::Flag._name, hcaldqm::quantity::Quantity._name, HistoParams< T >._name, CutApplicatorBase._name, HistoParams< TH2F >._name, HistoParams< TProfile2D >._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.PlotGroup._name, and plotting.PlotGroup._plots.

    def remove(self, name):
        for i, plot in enumerate(self._plots):
            if plot.getName() == name:
                del self._plots[i]
                return
        raise Exception("Did not find Plot '%s' from PlotGroup '%s'" % (name, self._name))

setProperties()

def plotting.PlotGroup.setProperties	(		self,
			kwargs
	)

Definition at line 2292 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

_name

plotting.PlotGroup._name

private

Definition at line 2272 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.PlotGroup.draw(), 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().

_plots

plotting.PlotGroup._plots

private

Definition at line 2273 of file plotting.py.

Referenced by plotting.PlotGroup._drawSeparate(), plotting.PlotGroup.append(), plotting.Plotter.append(), plotting.Plotter.appendTable(), plotting.PlotGroup.clear(), plotting.Plotter.clear(), trackingPlots.TrackingSeedingLayerTable.create(), plotting.PlotGroup.create(), trackingPlots.TrackingSeedingLayerTable.draw(), plotting.PlotGroup.draw(), plotting.PlotGroup.getPlot(), plotting.Plotter.getPlotFolder(), plotting.Plotter.getPlotFolderNames(), plotting.Plotter.getPlotFolders(), plotting.PlotGroup.getPlots(), plotting.Plotter.readDirs(), and plotting.PlotGroup.remove().

_ratioFactor

plotting.PlotGroup._ratioFactor

private

Definition at line 2290 of file plotting.py.

Referenced by plotting.PlotGroup._drawSeparate(), plotting.PlotGroup._modifyPadForRatio(), and plotting.PlotGroup.draw().