plotting.PlotTextBox Class Reference

Public Member Functions
def	__init__ (self, xmin, ymin, xmax, ymax, lineheight=0.04, fillColor=ROOT.kWhite, transparent=True, **kwargs)
def	addText (self, text)
def	Draw (self, options="")
def	move (self, dx=0, dy=0, dw=0, dh=0)
def	width (self)

Private Attributes
	_currenty
	_fillColor
	_lineheight
	_pave
	_textArgs
	_texts
	_transparent
	_xmax
	_xmin
	_ymax
	_ymin

Detailed Description

Class for drawing text and a background box.

Definition at line 1584 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def plotting.PlotTextBox.__init__	(		self,
			xmin,
			ymin,
			xmax,
			ymax,
			lineheight = 0.04,
			fillColor = ROOT.kWhite,
			transparent = True,
		**	kwargs
	)

Constructor

Arguments:
xmin        -- X min coordinate of the box (NDC)
ymin        -- Y min coordinate of the box (NDC) (if None, deduced automatically)
xmax        -- X max coordinate of the box (NDC)
ymax        -- Y max coordinate of the box (NDC)
lineheight  -- Line height
fillColor   -- Fill color of the box
transparent -- Should the box be transparent? (in practive the TPave is not created)

Keyword arguments are forwarded to constructor of PlotText

Definition at line 1586 of file plotting.py.

    def __init__(self, xmin, ymin, xmax, ymax, lineheight=0.04, fillColor=ROOT.kWhite, transparent=True, **kwargs):
        """Constructor
 
        Arguments:
        xmin        -- X min coordinate of the box (NDC)
        ymin        -- Y min coordinate of the box (NDC) (if None, deduced automatically)
        xmax        -- X max coordinate of the box (NDC)
        ymax        -- Y max coordinate of the box (NDC)
        lineheight  -- Line height
        fillColor   -- Fill color of the box
        transparent -- Should the box be transparent? (in practive the TPave is not created)
 
        Keyword arguments are forwarded to constructor of PlotText
        """
        # ROOT.TPave Set/GetX1NDC() etc don't seem to work as expected.
        self._xmin = xmin
        self._xmax = xmax
        self._ymin = ymin
        self._ymax = ymax
        self._lineheight = lineheight
        self._fillColor = fillColor
        self._transparent = transparent
        self._texts = []
        self._textArgs = {}
        self._textArgs.update(kwargs)
 
        self._currenty = ymax
 

Member Function Documentation

addText()

def plotting.PlotTextBox.addText	(		self,
			text
	)

Add text to current position

Definition at line 1614 of file plotting.py.

    def addText(self, text):
        """Add text to current position"""
        self._currenty -= self._lineheight
        self._texts.append(PlotText(self._xmin+0.01, self._currenty, text, **self._textArgs))
 

References plotting.PlotTextBox._currenty, plotting.PlotTextBox._lineheight, plotting.PlotTextBox._textArgs, plotting.PlotTextBox._texts, MEGeom._xmin, HistoParams< T >._xmin, HistoParams< TH2F >._xmin, HistoParams< TProfile2D >._xmin, plotting.PlotTextBox._xmin, and mps_setup.append.

Draw()

def plotting.PlotTextBox.Draw	(		self,
			options = ""
	)

Draw the box and the text to the current TPad.

Arguments:
options -- Forwarded to ROOT.TPave.Draw(), and the Draw() of the contained objects

Definition at line 1648 of file plotting.py.

    def Draw(self, options=""):
        """Draw the box and the text to the current TPad.
 
        Arguments:
        options -- Forwarded to ROOT.TPave.Draw(), and the Draw() of the contained objects
        """
        if not self._transparent:
            ymin = self.ymin
            if ymin is None:
                ymin = self.currenty - 0.01
            self._pave = ROOT.TPave(self.xmin, self.ymin, self.xmax, self.ymax, 0, "NDC")
            self._pave.SetFillColor(self.fillColor)
            self._pave.Draw(options)
        for t in self._texts:
            t.Draw(options)
 

References plotting.PlotTextBox._transparent, fftjetcms::LookupTable2d.ymin(), PixelClusterizerBase::AccretionCluster.ymin, MTDClusterizerBase::AccretionCluster.ymin, dqmoffline::l1t::HistDefinition.ymin, Exhume::Event.ymin, cscdqm::AddressBox.ymin, and TrackerMap.ymin.

move()

def plotting.PlotTextBox.move	(		self,
			dx = 0,
			dy = 0,
			dw = 0,
			dh = 0
	)

Move the box and the contained text objects

Arguments:
dx -- Movement in x (positive is to right)
dy -- Movement in y (positive is to up)
dw -- Increment of width (negative to decrease width)
dh -- Increment of height (negative to decrease height)

dx and dy affect to both box and text objects, dw and dh
affect the box only.

Definition at line 1622 of file plotting.py.

    def move(self, dx=0, dy=0, dw=0, dh=0):
        """Move the box and the contained text objects
 
        Arguments:
        dx -- Movement in x (positive is to right)
        dy -- Movement in y (positive is to up)
        dw -- Increment of width (negative to decrease width)
        dh -- Increment of height (negative to decrease height)
 
        dx and dy affect to both box and text objects, dw and dh
        affect the box only.
        """
        self._xmin += dx
        self._xmax += dx
        if self._ymin is not None:
            self._ymin += dy
        self._ymax += dy
 
        self._xmax += dw
        if self._ymin is not None:
            self._ymin -= dh
 
        for t in self._texts:
            t._x += dx
            t._y += dy
 

References plotting.PlotTextBox._texts, MEGeom._xmax, HistoParams< T >._xmax, HistoParams< TH2F >._xmax, HistoParams< TProfile2D >._xmax, plotting.PlotTextBox._xmax, MEGeom._xmin, HistoParams< T >._xmin, HistoParams< TH2F >._xmin, HistoParams< TProfile2D >._xmin, plotting.PlotTextBox._xmin, MEGeom._ymax, HistoParams< T >._ymax, HistoParams< TH2F >._ymax, HistoParams< TProfile2D >._ymax, plotting.PlotTextBox._ymax, MEGeom._ymin, HistoParams< T >._ymin, HistoParams< TH2F >._ymin, HistoParams< TProfile2D >._ymin, and plotting.PlotTextBox._ymin.

width()

def plotting.PlotTextBox.width

(

self

)

Definition at line 1619 of file plotting.py.

    def width(self):
        return self._xmax-self._xmin
 

References MEGeom._xmax, HistoParams< T >._xmax, HistoParams< TH2F >._xmax, HistoParams< TProfile2D >._xmax, plotting.PlotTextBox._xmax, MEGeom._xmin, HistoParams< T >._xmin, HistoParams< TH2F >._xmin, HistoParams< TProfile2D >._xmin, and plotting.PlotTextBox._xmin.

Member Data Documentation

_currenty

plotting.PlotTextBox._currenty

private

Definition at line 1612 of file plotting.py.

Referenced by plotting.PlotTextBox.addText().

_fillColor

plotting.PlotTextBox._fillColor

private

Definition at line 1606 of file plotting.py.

_lineheight

plotting.PlotTextBox._lineheight

private

Definition at line 1605 of file plotting.py.

Referenced by plotting.PlotTextBox.addText().

_pave

plotting.PlotTextBox._pave

private

Definition at line 1658 of file plotting.py.

_textArgs

plotting.PlotTextBox._textArgs

private

Definition at line 1609 of file plotting.py.

Referenced by plotting.PlotTextBox.addText().

_texts

plotting.PlotTextBox._texts

private

Definition at line 1608 of file plotting.py.

Referenced by plotting.PlotTextBox.addText(), and plotting.PlotTextBox.move().

_transparent

plotting.PlotTextBox._transparent

private

Definition at line 1607 of file plotting.py.

Referenced by plotting.PlotTextBox.Draw().

_xmax

plotting.PlotTextBox._xmax

private

Definition at line 1602 of file plotting.py.

Referenced by plotting.PlotTextBox.move(), and plotting.PlotTextBox.width().

_xmin

plotting.PlotTextBox._xmin

private

Definition at line 1601 of file plotting.py.

Referenced by plotting.PlotTextBox.addText(), plotting.PlotTextBox.move(), and plotting.PlotTextBox.width().

_ymax

plotting.PlotTextBox._ymax

private

Definition at line 1604 of file plotting.py.

Referenced by plotting.PlotTextBox.move().

_ymin

plotting.PlotTextBox._ymin

private

Definition at line 1603 of file plotting.py.

Referenced by plotting.PlotTextBox.move().