1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
|
# -*- coding: utf-8 -*-
"""
This module implements the classes used to show plots.
.. :copyright: (c) 2014 by Jelte Fennema.
:license: MIT, see License for more details.
"""
import math
import re
from .base_classes import Command, Container, Environment, LatexObject, Options
from .package import Package
class TikZOptions(Options):
"""Options class, do not escape."""
escape = False
def append_positional(self, option):
"""Add a new positional option."""
self._positional_args.append(option)
class TikZ(Environment):
"""Basic TikZ container class."""
_latex_name = "tikzpicture"
packages = [Package("tikz")]
class Axis(Environment):
"""PGFPlots axis container class, this contains plots."""
packages = [Package("pgfplots"), Command("pgfplotsset", "compat=newest")]
def __init__(self, options=None, *, data=None):
"""
Args
----
options: str, list or `~.Options`
Options to format the axis environment.
"""
super().__init__(options=options, data=data)
class TikZScope(Environment):
"""TikZ Scope Environment."""
_latex_name = "scope"
class TikZCoordinate(LatexObject):
"""A General Purpose Coordinate Class."""
_coordinate_str_regex = re.compile(
r"(\+\+)?\(\s*(-?[0-9]+(\.[0-9]+)?)\s*" r",\s*(-?[0-9]+(\.[0-9]+)?)\s*\)"
)
def __init__(self, x, y, relative=False):
"""
Args
----
x: float or int
X coordinate
y: float or int
Y coordinate
relative: bool
Coordinate is relative or absolute
"""
self._x = float(x)
self._y = float(y)
self.relative = relative
def __repr__(self):
if self.relative:
ret_str = "++"
else:
ret_str = ""
return ret_str + "({},{})".format(self._x, self._y)
def dumps(self):
"""Return representation."""
return self.__repr__()
@classmethod
def from_str(cls, coordinate):
"""Build a TikZCoordinate object from a string."""
m = cls._coordinate_str_regex.match(coordinate)
if m is None:
raise ValueError("invalid coordinate string")
if m.group(1) == "++":
relative = True
else:
relative = False
return TikZCoordinate(float(m.group(2)), float(m.group(4)), relative=relative)
def __eq__(self, other):
if isinstance(other, tuple):
# if comparing to a tuple, assume it to be an absolute coordinate.
other_relative = False
other_x = float(other[0])
other_y = float(other[1])
elif isinstance(other, TikZCoordinate):
other_relative = other.relative
other_x = other._x
other_y = other._y
else:
raise TypeError("can only compare tuple and TiKZCoordinate types")
# prevent comparison between relative and non relative
# by returning False
if other_relative != self.relative:
return False
# return comparison result
return other_x == self._x and other_y == self._y
def _arith_check(self, other):
if isinstance(other, tuple):
other_coord = TikZCoordinate(*other)
elif isinstance(other, TikZCoordinate):
if other.relative is True or self.relative is True:
raise ValueError("refusing to add relative coordinates")
other_coord = other
else:
raise TypeError("can only add tuple or TiKZCoordinate types")
return other_coord
def __add__(self, other):
other_coord = self._arith_check(other)
return TikZCoordinate(self._x + other_coord._x, self._y + other_coord._y)
def __radd__(self, other):
self.__add__(other)
def __sub__(self, other):
other_coord = self._arith_check(other)
return TikZCoordinate(self._x - other_coord._y, self._y - other_coord._y)
def distance_to(self, other):
"""Euclidean distance between two coordinates."""
other_coord = self._arith_check(other)
return math.sqrt(
math.pow(self._x - other_coord._x, 2)
+ math.pow(self._y - other_coord._y, 2)
)
class TikZObject(Container):
"""Abstract Class that most TikZ Objects inherits from."""
def __init__(self, options=None):
"""
Args
----
options: list
Options pertaining to the object
"""
super(TikZObject, self).__init__()
self.options = options
class TikZNodeAnchor(LatexObject):
"""Representation of a node's anchor point."""
def __init__(self, node_handle, anchor_name):
"""
Args
----
node_handle: str
Node's identifier
anchor_name: str
Name of the anchor
"""
self.handle = node_handle
self.anchor = anchor_name
def __repr__(self):
return "({}.{})".format(self.handle, self.anchor)
def dumps(self):
"""Return a representation. Alias for consistency."""
return self.__repr__()
class TikZNode(TikZObject):
"""A class that represents a TiKZ node."""
_possible_anchors = ["north", "south", "east", "west"]
def __init__(self, handle=None, options=None, at=None, text=None):
"""
Args
----
handle: str
Node identifier
options: list
List of options
at: TikZCoordinate
Coordinate where node is placed
text: str
Body text of the node
"""
super(TikZNode, self).__init__(options=options)
self.handle = handle
if isinstance(at, (TikZCoordinate, type(None))):
self._node_position = at
else:
raise TypeError(
"at parameter must be an object of the" "TikzCoordinate class"
)
self._node_text = text
def dumps(self):
"""Return string representation of the node."""
ret_str = []
ret_str.append(Command("node", options=self.options).dumps())
if self.handle is not None:
ret_str.append("({})".format(self.handle))
if self._node_position is not None:
ret_str.append("at {}".format(str(self._node_position)))
if self._node_text is not None:
ret_str.append("{{{text}}};".format(text=self._node_text))
else:
ret_str.append("{};")
return " ".join(ret_str)
def get_anchor_point(self, anchor_name):
"""Return an anchor point of the node, if it exists."""
if anchor_name in self._possible_anchors:
return TikZNodeAnchor(self.handle, anchor_name)
else:
try:
anchor = int(anchor_name.split("_")[1])
except:
anchor = None
if anchor is not None:
return TikZNodeAnchor(self.handle, str(anchor))
raise ValueError('Invalid anchor name: "{}"'.format(anchor_name))
def __getattr__(self, attr_name):
try:
point = self.get_anchor_point(attr_name)
return point
except ValueError:
pass
# raise AttributeError(
# 'Invalid attribute requested: "{}"'.format(attr_name))
class TikZUserPath(LatexObject):
"""Represents a possible TikZ path."""
def __init__(self, path_type, options=None):
"""
Args
----
path_type: str
Type of path used
options: Options
List of options to add
"""
super(TikZUserPath, self).__init__()
self.path_type = path_type
self.options = options
def dumps(self):
"""Return path command representation."""
ret_str = self.path_type
if self.options is not None:
ret_str += self.options.dumps()
return ret_str
class TikZPathList(LatexObject):
"""Represents a path drawing."""
_legal_path_types = ["--", "-|", "|-", "to", "rectangle", "circle", "arc", "edge"]
def __init__(self, *args):
"""
Args
----
args: list
A list of path elements
"""
self._last_item_type = None
self._arg_list = []
# parse list and verify legality
self._parse_arg_list(args)
def append(self, item):
"""Add a new element to the current path."""
self._parse_next_item(item)
def _parse_next_item(self, item):
# assume first item is a point
if self._last_item_type is None:
try:
self._add_point(item)
except (TypeError, ValueError):
# not a point, do something
raise TypeError(
"First element of path list must be a node identifier"
" or coordinate"
)
elif self._last_item_type == "point":
# point after point is permitted, doesnt draw
try:
self._add_point(item)
return
except (ValueError, TypeError):
# not a point, try path
pass
# will raise typeerror if wrong
self._add_path(item)
elif self._last_item_type == "path":
# only point allowed after path
original_exception = None
try:
self._add_point(item)
return
except (TypeError, ValueError) as ex:
# check if trying to insert path after path
try:
self._add_path(item, parse_only=True)
not_a_path = False
original_exception = ex
except (TypeError, ValueError) as ex:
# not a path either!
not_a_path = True
original_exception = ex
# disentangle exceptions
if not_a_path is False:
raise ValueError(
"only a point descriptor can come" " after a path descriptor"
)
if original_exception is not None:
raise original_exception
def _parse_arg_list(self, args):
for item in args:
self._parse_next_item(item)
def _add_path(self, path, parse_only=False):
if isinstance(path, str):
if path in self._legal_path_types:
_path = TikZUserPath(path)
else:
raise ValueError('Illegal user path type: "{}"'.format(path))
elif isinstance(path, TikZUserPath):
_path = path
else:
raise TypeError("Only string or TikZUserPath types are allowed")
# add
if parse_only is False:
self._arg_list.append(_path)
self._last_item_type = "path"
else:
return _path
def _add_point(self, point, parse_only=False):
if isinstance(point, str):
try:
_item = TikZCoordinate.from_str(point)
except ValueError:
raise ValueError('Illegal point string: "{}"'.format(point))
elif isinstance(point, TikZCoordinate):
_item = point
elif isinstance(point, tuple):
_item = TikZCoordinate(*point)
elif isinstance(point, TikZNode):
_item = "({})".format(point.handle)
elif isinstance(point, TikZNodeAnchor):
_item = point.dumps()
else:
raise TypeError(
"Only str, tuple, TikZCoordinate,"
"TikZNode or TikZNodeAnchor types are allowed,"
" got: {}".format(type(point))
)
# add, finally
if parse_only is False:
self._arg_list.append(_item)
self._last_item_type = "point"
else:
return _item
def dumps(self):
"""Return representation of the path command."""
ret_str = []
for item in self._arg_list:
if isinstance(item, TikZUserPath):
ret_str.append(item.dumps())
elif isinstance(item, TikZCoordinate):
ret_str.append(item.dumps())
elif isinstance(item, str):
ret_str.append(item)
return " ".join(ret_str)
class TikZPath(TikZObject):
r"""The TikZ \path command."""
def __init__(self, path=None, options=None):
"""
Args
----
path: TikZPathList
A list of the nodes, path types in the path
options: TikZOptions
A list of options for the command
"""
super(TikZPath, self).__init__(options=options)
if isinstance(path, TikZPathList):
self.path = path
elif isinstance(path, list):
self.path = TikZPathList(*path)
elif path is None:
self.path = TikZPathList()
else:
raise TypeError('argument "path" can only be of types list or TikZPathList')
def append(self, element):
"""Append a path element to the current list."""
self.path.append(element)
def dumps(self):
"""Return a representation for the command."""
ret_str = [Command("path", options=self.options).dumps()]
ret_str.append(self.path.dumps())
return " ".join(ret_str) + ";"
class TikZDraw(TikZPath):
"""A draw command is just a path command with the draw option."""
def __init__(self, path=None, options=None):
"""
Args
----
path: TikZPathList
A list of the nodes, path types in the path
options: TikZOptions
A list of options for the command
"""
super(TikZDraw, self).__init__(path=path, options=options)
# append option
if self.options is not None:
self.options.append_positional("draw")
else:
self.options = TikZOptions("draw")
class Plot(LatexObject):
"""A class representing a PGFPlot."""
packages = [Package("pgfplots"), Command("pgfplotsset", "compat=newest")]
def __init__(
self, name=None, func=None, coordinates=None, error_bar=None, options=None
):
"""
Args
----
name: str
Name of the plot.
func: str
A function that should be plotted.
coordinates: list
A list of exact coordinates tat should be plotted.
options: str, list or `~.Options`
"""
self.name = name
self.func = func
self.coordinates = coordinates
self.error_bar = error_bar
self.options = options
super().__init__()
def dumps(self):
"""Represent the plot as a string in LaTeX syntax.
Returns
-------
str
"""
string = Command("addplot", options=self.options).dumps()
if self.coordinates is not None:
string += " coordinates {%\n"
if self.error_bar is None:
for x, y in self.coordinates:
# ie: "(x,y)"
string += "(" + str(x) + "," + str(y) + ")%\n"
else:
for (x, y), (e_x, e_y) in zip(self.coordinates, self.error_bar):
# ie: "(x,y) +- (e_x,e_y)"
string += (
"("
+ str(x)
+ ","
+ str(y)
+ ") +- ("
+ str(e_x)
+ ","
+ str(e_y)
+ ")%\n"
)
string += "};%\n%\n"
elif self.func is not None:
string += "{" + self.func + "};%\n%\n"
if self.name is not None:
string += Command("addlegendentry", self.name).dumps()
super().dumps()
return string
|