svgfig.Curve Class Reference

Inheritance diagram for svgfig.Curve:

Classes
class	Sample
	nested class Sample More...
class	Samples
	end Sample More...

Public Member Functions
def	__init__ (self, f, low, high, loop=False, attr)
def	__repr__ (self)
def	Path (self, trans=None, local=False)
def	sample (self, trans=None)
	end nested class More...
def	subsample (self, left, right, depth, trans=None)
def	SVG (self, trans=None)

Public Attributes
	attr
	f
	high
	last_samples
	loop
	low

Static Public Attributes
dictionary	defaults = {}
int	discontinuity_limit = 5.
float	linearity_limit = 0.05
bool	random_sampling = True
int	recursion_limit = 15

Detailed Description

Draws a parametric function as a path.

Curve(f, low, high, loop, attribute=value)

f                      required         a Python callable or string in
                                        the form "f(t), g(t)"
low, high              required         left and right endpoints
loop                   default=False    if True, connect the endpoints
attribute=value pairs  keyword list     SVG attributes

Definition at line 1499 of file svgfig.py.

Constructor & Destructor Documentation

__init__()

def svgfig.Curve.__init__	(		self,
			f,
			low,
			high,
			loop = False,
			attr
	)

Definition at line 1519 of file svgfig.py.

  def __init__(self, f, low, high, loop=False, **attr):
    self.f = f
    self.low = low
    self.high = high
    self.loop = loop

    self.attr = dict(self.defaults)
    self.attr.update(attr)

Member Function Documentation

__repr__()

def svgfig.Curve.__repr__

(

self

)

Definition at line 1516 of file svgfig.py.

References svgfig.SVG.attr, svgfig.Path.attr, svgfig.Curve.attr, hippyaddtobaddatafiles.KeepWhileOpenFile.f, svgfig.Curve.f, svgfig.Curve.high, and svgfig.Curve.low.

Referenced by data_sources.json_file.__str__(), and datamodel.Object.__str__().

  def __repr__(self):
    return "<Curve %s [%s, %s] %s>" % (self.f, self.low, self.high, self.attr)

Path()

def svgfig.Curve.Path	(		self,
			trans = None,
			local = False
	)

Apply the transformation "trans" and return a Path object in
global coordinates.  If local=True, return a Path in local coordinates
(which must be transformed again).

Definition at line 1654 of file svgfig.py.

References svgfig.SVG.attr, svgfig.Path.attr, svgfig.Curve.attr, hippyaddtobaddatafiles.KeepWhileOpenFile.f, svgfig.Curve.f, svgfig.funcRtoR2(), svgfig.Curve.last_samples, svgfig.Curve.loop, CastorLedAnalysis.sample, HcalLedAnalysis.sample, HcalPedestalAnalysis.sample, CastorPedestalAnalysis.sample, svgfig.Curve.sample(), and svgfig.totrans().

Referenced by svgfig.Curve.SVG(), svgfig.Poly.SVG(), svgfig.Line.SVG(), svgfig.Rect.SVG(), and svgfig.Ellipse.SVG().

  def Path(self, trans=None, local=False):
    """Apply the transformation "trans" and return a Path object in
    global coordinates.  If local=True, return a Path in local coordinates
    (which must be transformed again)."""

    if isinstance(trans, str): trans = totrans(trans)
    if isinstance(self.f, str): self.f = funcRtoR2(self.f)

    self.sample(trans)

    output = []
    for s in self.last_samples:
      if s.X != None and s.Y != None:
        if s.left == None or s.left.Y == None:
          command = "M"
        else:
          command = "L"

        if local: output.append((command, s.x, s.y, False))
        else: output.append((command, s.X, s.Y, True))

    if self.loop: output.append(("Z",))
    return Path(output, **self.attr)

sample()

def svgfig.Curve.sample	(		self,
			trans = None
	)

end nested class

Adaptive-sampling algorithm that chooses the best sample points
for a parametric curve between two endpoints and detects
discontinuities.  Called by SVG().

Definition at line 1576 of file svgfig.py.

References funct.abs(), hippyaddtobaddatafiles.KeepWhileOpenFile.f, svgfig.Curve.f, nano_mu_digi_cff.float, svgfig.Curve.high, svgfig.Curve.linearity_limit, svgfig.Curve.low, svgfig.Curve.recursion_limit, and svgfig.Curve.subsample().

Referenced by svgfig.Curve.Path().

  def sample(self, trans=None):
    """Adaptive-sampling algorithm that chooses the best sample points
    for a parametric curve between two endpoints and detects
    discontinuities.  Called by SVG()."""
    oldrecursionlimit = sys.getrecursionlimit()
    sys.setrecursionlimit(self.recursion_limit + 100)
    try:
      # the best way to keep all the information while sampling is to make a linked list
      if not (self.low < self.high): raise ValueError("low must be less than high")
      low, high = self.Sample(float(self.low)), self.Sample(float(self.high))
      low.link(None, high)
      high.link(low, None)

      low.evaluate(self.f, trans)
      high.evaluate(self.f, trans)

      # adaptive sampling between the low and high points
      self.subsample(low, high, 0, trans)

      # Prune excess points where the curve is nearly linear
      left = low
      while left.right != None:
        # increment mid and right
        mid = left.right
        right = mid.right
        if right != None and left.X != None and left.Y != None and mid.X != None and mid.Y != None and right.X != None and right.Y != None:
          numer = left.X*(right.Y - mid.Y) + mid.X*(left.Y - right.Y) + right.X*(mid.Y - left.Y)
          denom = math.sqrt((left.X - right.X)**2 + (left.Y - right.Y)**2)
          if denom != 0. and abs(numer/denom) < self.linearity_limit:
            # drop mid (the garbage collector will get it)
            left.right = right
            right.left = left
          else:
            # increment left
            left = left.right
        else:
          left = left.right

      self.last_samples = self.Samples(low, high)

    finally:
      sys.setrecursionlimit(oldrecursionlimit)

subsample()

def svgfig.Curve.subsample	(		self,
			left,
			right,
			depth,
			trans = None
	)

Part of the adaptive-sampling algorithm that chooses the best
sample points.  Called by sample().

Definition at line 1619 of file svgfig.py.

References funct.abs(), svgfig.Curve.discontinuity_limit, hippyaddtobaddatafiles.KeepWhileOpenFile.f, svgfig.Curve.f, svgfig.Curve.linearity_limit, svgfig.Curve.random_sampling, svgfig.Curve.recursion_limit, and svgfig.Curve.subsample().

Referenced by svgfig.Curve.sample(), and svgfig.Curve.subsample().

  def subsample(self, left, right, depth, trans=None):
    """Part of the adaptive-sampling algorithm that chooses the best
    sample points.  Called by sample()."""

    if self.random_sampling:
      mid = self.Sample(left.t + random.uniform(0.3, 0.7) * (right.t - left.t))
    else:
      mid = self.Sample(left.t + 0.5 * (right.t - left.t))

    left.right = mid
    right.left = mid
    mid.link(left, right)
    mid.evaluate(self.f, trans)

    # calculate the distance of closest approach of mid to the line between left and right
    numer = left.X*(right.Y - mid.Y) + mid.X*(left.Y - right.Y) + right.X*(mid.Y - left.Y)
    denom = math.sqrt((left.X - right.X)**2 + (left.Y - right.Y)**2)

    # if we haven't sampled enough or left fails to be close enough to right, or mid fails to be linear enough...
    if depth < 3 or (denom == 0 and left.t != right.t) or denom > self.discontinuity_limit or (denom != 0. and abs(numer/denom) > self.linearity_limit):

      # and we haven't sampled too many points
      if depth < self.recursion_limit:
        self.subsample(left, mid, depth+1, trans)
        self.subsample(mid, right, depth+1, trans)

      else:
        # We've sampled many points and yet it's still not a small linear gap.
        # Break the line: it's a discontinuity
        mid.y = mid.Y = None

SVG()

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

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

Definition at line 1650 of file svgfig.py.

References SiStripHistoPlotter::PlotParameter.Path, jsoncollector::Json::PathArgument.Path, and svgfig.Curve.Path().

  def SVG(self, trans=None):
    """Apply the transformation "trans" and return an SVG object."""
    return self.Path(trans).SVG()

Member Data Documentation

attr

svgfig.Curve.attr

Definition at line 1525 of file svgfig.py.

Referenced by svgfig.Curve.__repr__(), svgfig.Poly.__repr__(), svgfig.Text.__repr__(), svgfig.TextGlobal.__repr__(), svgfig.Dots.__repr__(), svgfig.Line.__repr__(), svgfig.LineGlobal.__repr__(), svgfig.VLine.__repr__(), svgfig.HLine.__repr__(), svgfig.Rect.__repr__(), svgfig.Ellipse.__repr__(), svgfig.Ticks.__repr__(), svgfig.CurveAxis.__repr__(), svgfig.LineAxis.__repr__(), svgfig.XAxis.__repr__(), svgfig.YAxis.__repr__(), svgfig.Axes.__repr__(), svgfig.HGrid.__repr__(), svgfig.VGrid.__repr__(), svgfig.Grid.__repr__(), svgfig.Curve.Path(), svgfig.Poly.Path(), svgfig.Rect.Path(), svgfig.Text.SVG(), svgfig.TextGlobal.SVG(), svgfig.LineGlobal.SVG(), svgfig.Axes.SVG(), svgfig.XErrorBars.SVG(), and svgfig.YErrorBars.SVG().

defaults

dictionary svgfig.Curve.defaults = {}

static

Definition at line 1510 of file svgfig.py.

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

discontinuity_limit

int svgfig.Curve.discontinuity_limit = 5.

static

Definition at line 1514 of file svgfig.py.

Referenced by svgfig.Curve.subsample().

f

svgfig.Curve.f

Definition at line 1520 of file svgfig.py.

Referenced by svgfig.Curve.__repr__(), svgfig.Ticks.__repr__(), svgfig.CurveAxis.__repr__(), ztail.Decoder.follow(), ztail.Decoder.initial_synchronize(), svgfig.Ticks.orient_tickmark(), svgfig.Curve.Path(), DQMIO2histo.DQMIO.print_index(), svgfig.Curve.sample(), svgfig.Curve.subsample(), svgfig.LineAxis.SVG(), electronCompare.flushfile.write(), electronStore.flushfile.write(), and DQMIO2histo.DQMIO.write_to_file().

high

svgfig.Curve.high

Definition at line 1522 of file svgfig.py.

Referenced by svgfig.Curve.__repr__(), svgfig.Ticks.__repr__(), svgfig.CurveAxis.__repr__(), svgfig.HGrid.__repr__(), svgfig.VGrid.__repr__(), svgfig.Ticks.compute_logminiticks(), svgfig.Ticks.compute_logticks(), svgfig.Ticks.compute_miniticks(), svgfig.Ticks.compute_ticks(), svgfig.Ticks.interpret(), svgfig.Ticks.orient_tickmark(), svgfig.Ticks.regular_miniticks(), and svgfig.Curve.sample().

last_samples

svgfig.Curve.last_samples

Definition at line 1614 of file svgfig.py.

Referenced by svgfig.Curve.Path().

linearity_limit

float svgfig.Curve.linearity_limit = 0.05

static

Definition at line 1513 of file svgfig.py.

Referenced by svgfig.Curve.sample(), and svgfig.Curve.subsample().

loop

svgfig.Curve.loop

Definition at line 1523 of file svgfig.py.

Referenced by svgfig.Poly.__repr__(), svgfig.Curve.Path(), and svgfig.Poly.Path().

low

svgfig.Curve.low

Definition at line 1521 of file svgfig.py.

Referenced by svgfig.Curve.__repr__(), svgfig.Ticks.__repr__(), svgfig.CurveAxis.__repr__(), svgfig.HGrid.__repr__(), svgfig.VGrid.__repr__(), svgfig.Ticks.compute_logminiticks(), svgfig.Ticks.compute_logticks(), svgfig.Ticks.compute_miniticks(), svgfig.Ticks.compute_ticks(), svgfig.Ticks.interpret(), svgfig.Ticks.orient_tickmark(), svgfig.Ticks.regular_miniticks(), and svgfig.Curve.sample().

random_sampling

bool svgfig.Curve.random_sampling = True

static

Definition at line 1511 of file svgfig.py.

Referenced by svgfig.Curve.subsample().

recursion_limit

int svgfig.Curve.recursion_limit = 15

static

Definition at line 1512 of file svgfig.py.

Referenced by svgfig.Curve.sample(), and svgfig.Curve.subsample().