svgfig.LineAxis Class Reference

Inheritance diagram for svgfig.LineAxis:

Public Member Functions
def	__init__ (self, x1, y1, x2, y2, start=0., end=1., ticks=-10, miniticks=True, labels=True, logbase=None, arrow_start=None, arrow_end=None, exclude=None, text_attr={}, **attr)
def	__repr__ (self)
def	interpret (self)
def	SVG (self, trans=None)
Public Member Functions inherited from svgfig.Line
def	__init__ (self, x1, y1, x2, y2, arrow_start=None, arrow_end=None, **attr)
def	Path (self, trans=None, local=False)
Public Member Functions inherited from svgfig.Curve
def	__init__ (self, f, low, high, loop=False, **attr)
def	sample (self, trans=None)
	end nested class More...
def	subsample (self, left, right, depth, trans=None)
Public Member Functions inherited from svgfig.Ticks
def	__init__ (self, f, low, high, ticks=-10, miniticks=True, labels=True, logbase=None, arrow_start=None, arrow_end=None, text_attr={}, **attr)
def	compute_logminiticks (self, base)
def	compute_logticks (self, base, N, format)
def	compute_miniticks (self, original_ticks)
def	compute_ticks (self, N, format)
def	orient_tickmark (self, t, trans=None)
def	regular_miniticks (self, N)

Public Attributes
	end
	exclude
	f
	high
	low
	start
Public Attributes inherited from svgfig.Line
	arrow_end
	attr
	f
	high
	loop
	low
	y2
Public Attributes inherited from svgfig.Curve
	attr
	f
	high
	last_samples
	loop
	low
Public Attributes inherited from svgfig.Ticks
	arrow_end
	arrow_start
	attr
	f
	high
	labels
	last_miniticks
	logbase
	low
	miniticks
	text_attr
	ticks

Static Public Attributes
dictionary	defaults = {"stroke-width":"0.25pt"}
dictionary	text_defaults = {"stroke":"none", "fill":"black", "font-size":5}
Static Public Attributes inherited from svgfig.Line
dictionary	defaults = {}
Static Public Attributes inherited from svgfig.Curve
dictionary	defaults = {}
int	discontinuity_limit = 5.
float	linearity_limit = 0.05
bool	random_sampling = True
int	recursion_limit = 15
Static Public Attributes inherited from svgfig.Ticks
dictionary	defaults = {"stroke-width":"0.25pt"}
float	minitick_end = 0.75
float	minitick_start = -0.75
int	text_angle = 0.
dictionary	text_defaults = {"stroke":"none", "fill":"black", "font-size":5}
float	text_start = 2.5
float	tick_end = 1.5
float	tick_start = -1.5

Detailed Description

Draws an axis with tick marks along a line.

LineAxis(x1, y1, x2, y2, start, end, ticks, miniticks, labels, logbase,
arrow_start, arrow_end, text_attr, attribute=value)

x1, y1                  required        starting point
x2, y2                  required        ending point
start, end              default=0, 1    values to start and end labeling
ticks                   default=-10     request ticks according to the standard
                                        tick specification (see help(Ticks))
miniticks               default=True    request miniticks according to the
                                        standard minitick specification
labels                  True            request tick labels according to the
                                        standard tick label specification
logbase                 default=None    if a number, the x axis is logarithmic
                                        with ticks at the given base (usually 10)
arrow_start             default=None    if a new string identifier, draw an arrow
                                        at the low-end of the axis, referenced by
                                        that identifier; if an SVG marker object,
                                        use that marker
arrow_end               default=None    if a new string identifier, draw an arrow
                                        at the high-end of the axis, referenced by
                                        that identifier; if an SVG marker object,
                                        use that marker
text_attr               default={}      SVG attributes for the text labels
attribute=value pairs   keyword list    SVG attributes

Definition at line 2852 of file svgfig.py.

Constructor & Destructor Documentation

__init__()

def svgfig.LineAxis.__init__	(		self,
			x1,
			y1,
			x2,
			y2,
			start = 0.,
			end = 1.,
			ticks = -10,
			miniticks = True,
			labels = True,
			logbase = None,
			arrow_start = None,
			arrow_end = None,
			exclude = None,
			text_attr = {},
		**	attr
	)

Definition at line 2886 of file svgfig.py.

  def __init__(self, x1, y1, x2, y2, start=0., end=1., ticks=-10, miniticks=True, labels=True, logbase=None, arrow_start=None, arrow_end=None, exclude=None, text_attr={}, **attr):
    self.start = start
    self.end = end
    self.exclude = exclude
    tattr = dict(self.text_defaults)
    tattr.update(text_attr)
    Line.__init__(self, x1, y1, x2, y2, **attr)
    Ticks.__init__(self, None, None, None, ticks, miniticks, labels, logbase, arrow_start, arrow_end, tattr, **attr)
 

Member Function Documentation

__repr__()

def svgfig.LineAxis.__repr__

(

self

)

Reimplemented from svgfig.Line.

Reimplemented in svgfig.YAxis, and svgfig.XAxis.

Definition at line 2883 of file svgfig.py.

  def __repr__(self):
    return "<LineAxis (%g, %g) to (%g, %g) ticks=%s labels=%s %s>" % (self.x1, self.y1, self.x2, self.y2, str(self.ticks), str(self.labels), self.attr)
 

References svgfig.SVG.attr, svgfig.Path.attr, svgfig.Curve.attr, svgfig.Ticks.labels, str, svgfig.Ticks.ticks, reco::PdfInfo.x1, L1MonitorDigi.x1(), L1DataEmulDigi.x1(), TrackingTools_PatternTools::dictionary.x1, CTPPSFastTrack.x1(), DDTrap.x1(), cms::dd::DDTrap.x1(), DDPseudoTrap.x1(), APD.x1, Exhume::CrossSection.x1, svgfig.VLine.x1, svgfig.YAxis.x1, reco::PdfInfo.x2, L1MonitorDigi.x2(), L1DataEmulDigi.x2(), TrackingTools_PatternTools::dictionary.x2, CTPPSFastTrack.x2(), DDTrap.x2(), cms::dd::DDTrap.x2(), DDPseudoTrap.x2(), APD.x2, Exhume::CrossSection.x2, trklet::IMATH_TrackletCalculatorDisk.x2, trklet::IMATH_TrackletCalculatorOverlap.x2, trklet::IMATH_TrackletCalculator.x2, svgfig.VLine.x2, svgfig.YAxis.x2, CTPPSFastTrack.y1(), DDTrap.y1(), cms::dd::DDTrap.y1(), DDPseudoTrap.y1(), svgfig.HLine.y1, svgfig.XAxis.y1, and svgfig.Line.y2.

Referenced by data_sources.json_file.__str__().

interpret()

def svgfig.LineAxis.interpret

(

self

)

Evaluate and return optimal ticks and miniticks according to
the standard minitick specification.

Normally only used internally.

Reimplemented from svgfig.Ticks.

Definition at line 2895 of file svgfig.py.

  def interpret(self):
    if self.exclude != None and not (isinstance(self.exclude, (tuple, list)) and len(self.exclude) == 2 and \
                                     isinstance(self.exclude[0], (int, long, float)) and isinstance(self.exclude[1], (int, long, float))):
      raise TypeError("exclude must either be None or (low, high)")
 
    ticks, miniticks = Ticks.interpret(self)
    if self.exclude == None: return ticks, miniticks
 
    ticks2 = {}
    for loc, label in ticks.items():
      if self.exclude[0] <= loc <= self.exclude[1]:
        ticks2[loc] = ""
      else:
        ticks2[loc] = label
 
    return ticks2, miniticks
 

References svgfig.LineAxis.exclude.

SVG()

def svgfig.LineAxis.SVG	(		self,
			trans = None
	)

Apply the transformation "trans" and return an SVG object.

Reimplemented from svgfig.Line.

Reimplemented in svgfig.YAxis, and svgfig.XAxis.

Definition at line 2912 of file svgfig.py.

  def SVG(self, trans=None):
    """Apply the transformation "trans" and return an SVG object."""
    line = Line.SVG(self, trans) # must be evaluated first, to set self.f, self.low, self.high
 
    f01 = self.f
    self.f = lambda t: f01(1. * (t - self.start) / (self.end - self.start))
    self.low = self.start
    self.high = self.end
 
    if self.arrow_start != False and self.arrow_start != None:
      if isinstance(self.arrow_start, str):
        line.attr["marker-start"] = "url(#%s)" % self.arrow_start
      else:
        line.attr["marker-start"] = "url(#%s)" % self.arrow_start.id
 
    if self.arrow_end != False and self.arrow_end != None:
      if isinstance(self.arrow_end, str):
        line.attr["marker-end"] = "url(#%s)" % self.arrow_end
      else:
        line.attr["marker-end"] = "url(#%s)" % self.arrow_end.id
 
    ticks = Ticks.SVG(self, trans) # returns a <g />
    ticks.append(line)
    return ticks

References hippyaddtobaddatafiles.KeepWhileOpenFile.f, and svgfig.Curve.f.

Member Data Documentation

defaults

dictionary svgfig.LineAxis.defaults = {"stroke-width":"0.25pt"}

static

Definition at line 2880 of file svgfig.py.

Referenced by tree.Tree.reset(), and tree.Tree.var().

end

svgfig.LineAxis.end

Definition at line 2888 of file svgfig.py.

Referenced by OrderedSet.OrderedSet.__iter__(), validateAlignments.ValidationJob.__next__(), validateAlignments.ValidationJobMultiIOV.__next__(), OrderedSet.OrderedSet.__reversed__(), OrderedSet.OrderedSet.add(), Types.LuminosityBlockRange.cppID(), Types.EventRange.cppID(), o2olib.O2ORunMgr.endJob(), esMonitoring.FDOutputListener.handle_line(), and OrderedSet.OrderedSet.pop().

exclude

svgfig.LineAxis.exclude

Definition at line 2889 of file svgfig.py.

Referenced by svgfig.LineAxis.interpret().

f

svgfig.LineAxis.f

Definition at line 2917 of file svgfig.py.

Referenced by ztail.Decoder.follow(), ztail.Decoder.initial_synchronize(), DQMIO2histo.DQMIO.print_index(), electronCompare.flushfile.write(), electronStore.flushfile.write(), and DQMIO2histo.DQMIO.write_to_file().

high

svgfig.LineAxis.high

Definition at line 2919 of file svgfig.py.

low

svgfig.LineAxis.low

Definition at line 2918 of file svgfig.py.

start

svgfig.LineAxis.start

Definition at line 2887 of file svgfig.py.

Referenced by progressbar.ProgressBar.__next__(), validateAlignments.ValidationJob.__next__(), validateAlignments.ValidationJobMultiIOV.__next__(), Types.LuminosityBlockRange.cppID(), Types.EventRange.cppID(), o2olib.O2ORunMgr.endJob(), and esMonitoring.FDOutputListener.handle_line().

text_defaults

dictionary svgfig.LineAxis.text_defaults = {"stroke":"none", "fill":"black", "font-size":5}

static

Definition at line 2881 of file svgfig.py.