python.draw_obj Namespace Reference

Classes
class	_options

Functions
def	draw_obj (obj, options="", padnum=-1, pad=None, min=None, max=None)
def	get_pad (advance_p=1, padnum=-1)
def	get_canvas (cname="c1")
def	zone (nx, ny)
def	printeps (s="out.eps")

Variables
int	_samecount = 0
int	_lastpad = 0
int	_nextpad = 1
int	_npads = 1
	_canvas = None

Function Documentation

draw_obj()

def python.draw_obj.draw_obj	(		obj,
			options = "",
			padnum = -1,
			pad = None,
			min = None,
			max = None
	)

Draw the root object OBJ in the next available pad.

Inputs:
  obj -         The object to draw.
  options -     Drawing options.
            These are passed through to the root Draw
            method, except that we have special
            handling for the SAME option, and add a new MERGE option.
            See the header for details.
  padnum -      If this is a non-negative integer, then this specifies
            the pad in which to draw, overriding
            other specifications except for PAD.  Note: subpad numbers
            start with 1.
  pad -         Explicitly specify the pad to use for drawing.
            Overrides all other specifications.

Returns:
  The object that we drew (may not be the same as OBJ if we
  made a copy).

Definition at line 109 of file draw_obj.py.

def draw_obj (obj, options = "", padnum = -1, pad = None, min=None, max=None):
    """Draw the root object OBJ in the next available pad.
 
Inputs:
  obj -         The object to draw.
  options -     Drawing options.
                These are passed through to the root Draw
                method, except that we have special
                handling for the SAME option, and add a new MERGE option.
                See the header for details.
  padnum -      If this is a non-negative integer, then this specifies
                the pad in which to draw, overriding
                other specifications except for PAD.  Note: subpad numbers
                start with 1.
  pad -         Explicitly specify the pad to use for drawing.
                Overrides all other specifications.
 
Returns:
  The object that we drew (may not be the same as OBJ if we
  made a copy).
"""
    global _samecount
 
    if min is not None:
        obj.SetMinimum (min)
    if max is not None:
        obj.SetMaximum (max)
        
    op = _options (options)
 
    # Should we advance to the next pad?
    advance_p = 0
 
    # Should we do vertical axis rescaling?
    rescale_p = 0
 
    # For SAME and MERGE, we have to pass SAME on to root.
    if op.same or op.merge:
        op.other += "SAME"
 
    if not op.same:
        # No SAME option.  Reset the count.
        _samecount = 0
 
        # Advance to the next pad.
        advance_p = 1
    else:
        # SAME was specified.  Keep count of the number of such.
        _samecount += 1
        rescale_p = 1
 
    # Handle the MERGE option.
    if op.merge:
        rescale_p = 1
        advance_p = 1
 
    if pad:
        pad.cd()
    else:
        pad = get_pad (advance_p, padnum)
 
    if not op.merge and not op.same:
        pad.SetLogx (not not op.logx)
        pad.SetLogy (not not op.logy)
 
    if isinstance (obj, TH1) and not isinstance (obj, TH2):
        h = obj
        if op.norm:
            h = h.Clone()
            intg =  h.Integral()
            if intg == 0:
                intg = 1
            h.Scale (1. / intg)
            if max is not None:
                h.SetMaximum (max)
 
        # Special handling for 1D histograms.
        # If SAME was specified, rescale the vertical axis, if needed.
        if rescale_p and max is None:
            # Find the first hist already plotted.
            hfirst = None
            prims = pad.GetListOfPrimitives()
            # Avoids RecursiveRemove crash...
            prims.ResetBit(TObject.kMustCleanup)
            for obj in prims:
                if isinstance (obj, TH1):
                    hfirst = obj
                    break
 
            # If the new hist's maximum is larger than the first one,
            # adjust the maximum of the first.
            if hfirst and h.GetMaximum() > hfirst.GetMaximum():
                hfirst.SetMaximum (h.GetMaximum() * 1.1)
 
            if hfirst and h.GetMinimum() < hfirst.GetMinimum():
                hfirst.SetMinimum (h.GetMinimum())
 
        # Draw a copy of the histogram.
        # Adjust the line style.
        hh = h.DrawCopy (op.other)
        if op.linetype >= 0:
            hh.SetLineStyle (op.linetype)
        else:
            hh.SetLineStyle ((_samecount%4)+1)
        if op.color >= 0:
            hh.SetLineColor (op.color)
        elif op.linecolors and _samecount >= 4:
            hh.SetLineColor (_samecount//4 + 1)
        if op.fill >= 0:
            hh.SetFillColor (op.fill)
        obj = hh
    else:
        # Not a 1-D histogram.  Just draw it.
        obj.Draw (op.other)
 
    return obj
 
 

get_canvas()

def python.draw_obj.get_canvas

(

cname = "c1"

)

Return the canvas named CNAME.
Create it if it doesn't exist.

Definition at line 274 of file draw_obj.py.

def get_canvas (cname = "c1"):
    """Return the canvas named CNAME.
Create it if it doesn't exist.
"""
    global _canvas
    _canvas = gROOT.FindObject (cname)
    if not _canvas:
        _canvas = TCanvas (cname, cname, 700, 600)
        _canvas.SetLeftMargin (0.15)
        _canvas.SetBottomMargin (0.15)
        _canvas.SetLogx (0)
        _canvas.SetLogy (0)
    return _canvas
 
 
 

get_pad()

def python.draw_obj.get_pad	(		advance_p = 1,
			padnum = -1
	)

Advance to the next pad, if requested.
Allow clicking on the pads (button 2) to change the next pad.

Definition at line 227 of file draw_obj.py.

def get_pad (advance_p = 1, padnum = -1):
    """Advance to the next pad, if requested.
Allow clicking on the pads (button 2) to change the next pad.
"""
    global _lastpad, _nextpad, _npads
    
    c1 = get_canvas()
    pad = TVirtualPad.Pad()
 
    if advance_p:
        if (pad and
            pad.GetCanvasID() == c1.GetCanvasID() and
            pad.GetNumber() != _lastpad and pad.GetNumber() != 0):
            _nextpad = pad.GetNumber()
            if _nextpad > _npads:
                _nextpad = 1
 
        # Set up to draw on nextpad.
        # Bump it for the next go around.
        if _npads > 1:
            _lastpad = _nextpad
            _nextpad += 1
            if _nextpad > _npads:
                _nextpad = 1
        else:
            _lastpad = 0
 
        # Select the pad.
        c1.cd (_lastpad)
 
    # Handle padnum.
    if padnum >= 0:
        _lastpad = padnum
        if _npads > 0:
            _nextpad = _lastpad + 1
            if _nextpad > _npads:
                _nextpad = 0
        else:
            _nextpad = 0
 
        c1.cd (_lastpad)
 
    # Refetch the pad.
    return TVirtualPad.Pad()
 
 

printeps()

def python.draw_obj.printeps

(

s = "out.eps"

)

Print the current canvas as an eps file.

Definition at line 304 of file draw_obj.py.

def printeps (s = "out.eps"):
    """Print the current canvas as an eps file."""
 
    c1 = get_canvas()
    c1.Print (s, "eps,Portrait")
    return

zone()

def python.draw_obj.zone	(		nx,
			ny
	)

Divide the canvas into subpads.
NX and NY are the number of subpads in x and y, respectively.

Definition at line 290 of file draw_obj.py.

def zone (nx, ny):
    """Divide the canvas into subpads.
NX and NY are the number of subpads in x and y, respectively.
"""
    global _npads, _nextpad, _lastpad
    c1 = get_canvas()
    c1.Clear()
    c1.Divide (nx, ny)
    _npads = nx*ny
    _nextpad = 1
    _lastpad = 0
    return
 
 

Variable Documentation

_canvas

python.draw_obj._canvas = None

private

Definition at line 273 of file draw_obj.py.

_lastpad

int python.draw_obj._lastpad = 0

private

Definition at line 64 of file draw_obj.py.

_nextpad

int python.draw_obj._nextpad = 1

private

Definition at line 67 of file draw_obj.py.

_npads

int python.draw_obj._npads = 1

private

Definition at line 70 of file draw_obj.py.

_samecount

int python.draw_obj._samecount = 0

private

Definition at line 60 of file draw_obj.py.