File size: 49,886 Bytes
fe41391 |
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 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 |
import base64
import codecs
import datetime
import gzip
import hashlib
from io import BytesIO
import itertools
import logging
import os
import re
import uuid
import numpy as np
from PIL import Image
import matplotlib as mpl
from matplotlib import cbook, font_manager as fm
from matplotlib.backend_bases import (
_Backend, FigureCanvasBase, FigureManagerBase, RendererBase)
from matplotlib.backends.backend_mixed import MixedModeRenderer
from matplotlib.colors import rgb2hex
from matplotlib.dates import UTC
from matplotlib.path import Path
from matplotlib import _path
from matplotlib.transforms import Affine2D, Affine2DBase
_log = logging.getLogger(__name__)
# ----------------------------------------------------------------------
# SimpleXMLWriter class
#
# Based on an original by Fredrik Lundh, but modified here to:
# 1. Support modern Python idioms
# 2. Remove encoding support (it's handled by the file writer instead)
# 3. Support proper indentation
# 4. Minify things a little bit
# --------------------------------------------------------------------
# The SimpleXMLWriter module is
#
# Copyright (c) 2001-2004 by Fredrik Lundh
#
# By obtaining, using, and/or copying this software and/or its
# associated documentation, you agree that you have read, understood,
# and will comply with the following terms and conditions:
#
# Permission to use, copy, modify, and distribute this software and
# its associated documentation for any purpose and without fee is
# hereby granted, provided that the above copyright notice appears in
# all copies, and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of
# Secret Labs AB or the author not be used in advertising or publicity
# pertaining to distribution of the software without specific, written
# prior permission.
#
# SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
# TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
# ABILITY AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
# BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
# DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
# ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
# OF THIS SOFTWARE.
# --------------------------------------------------------------------
def _escape_cdata(s):
s = s.replace("&", "&")
s = s.replace("<", "<")
s = s.replace(">", ">")
return s
_escape_xml_comment = re.compile(r'-(?=-)')
def _escape_comment(s):
s = _escape_cdata(s)
return _escape_xml_comment.sub('- ', s)
def _escape_attrib(s):
s = s.replace("&", "&")
s = s.replace("'", "'")
s = s.replace('"', """)
s = s.replace("<", "<")
s = s.replace(">", ">")
return s
def _quote_escape_attrib(s):
return ('"' + _escape_cdata(s) + '"' if '"' not in s else
"'" + _escape_cdata(s) + "'" if "'" not in s else
'"' + _escape_attrib(s) + '"')
def _short_float_fmt(x):
"""
Create a short string representation of a float, which is %f
formatting with trailing zeros and the decimal point removed.
"""
return f'{x:f}'.rstrip('0').rstrip('.')
class XMLWriter:
"""
Parameters
----------
file : writable text file-like object
"""
def __init__(self, file):
self.__write = file.write
if hasattr(file, "flush"):
self.flush = file.flush
self.__open = 0 # true if start tag is open
self.__tags = []
self.__data = []
self.__indentation = " " * 64
def __flush(self, indent=True):
# flush internal buffers
if self.__open:
if indent:
self.__write(">\n")
else:
self.__write(">")
self.__open = 0
if self.__data:
data = ''.join(self.__data)
self.__write(_escape_cdata(data))
self.__data = []
def start(self, tag, attrib={}, **extra):
"""
Open a new element. Attributes can be given as keyword
arguments, or as a string/string dictionary. The method returns
an opaque identifier that can be passed to the :meth:`close`
method, to close all open elements up to and including this one.
Parameters
----------
tag
Element tag.
attrib
Attribute dictionary. Alternatively, attributes can be given as
keyword arguments.
Returns
-------
An element identifier.
"""
self.__flush()
tag = _escape_cdata(tag)
self.__data = []
self.__tags.append(tag)
self.__write(self.__indentation[:len(self.__tags) - 1])
self.__write(f"<{tag}")
for k, v in {**attrib, **extra}.items():
if v:
k = _escape_cdata(k)
v = _quote_escape_attrib(v)
self.__write(f' {k}={v}')
self.__open = 1
return len(self.__tags) - 1
def comment(self, comment):
"""
Add a comment to the output stream.
Parameters
----------
comment : str
Comment text.
"""
self.__flush()
self.__write(self.__indentation[:len(self.__tags)])
self.__write(f"<!-- {_escape_comment(comment)} -->\n")
def data(self, text):
"""
Add character data to the output stream.
Parameters
----------
text : str
Character data.
"""
self.__data.append(text)
def end(self, tag=None, indent=True):
"""
Close the current element (opened by the most recent call to
:meth:`start`).
Parameters
----------
tag
Element tag. If given, the tag must match the start tag. If
omitted, the current element is closed.
indent : bool, default: True
"""
if tag:
assert self.__tags, f"unbalanced end({tag})"
assert _escape_cdata(tag) == self.__tags[-1], \
f"expected end({self.__tags[-1]}), got {tag}"
else:
assert self.__tags, "unbalanced end()"
tag = self.__tags.pop()
if self.__data:
self.__flush(indent)
elif self.__open:
self.__open = 0
self.__write("/>\n")
return
if indent:
self.__write(self.__indentation[:len(self.__tags)])
self.__write(f"</{tag}>\n")
def close(self, id):
"""
Close open elements, up to (and including) the element identified
by the given identifier.
Parameters
----------
id
Element identifier, as returned by the :meth:`start` method.
"""
while len(self.__tags) > id:
self.end()
def element(self, tag, text=None, attrib={}, **extra):
"""
Add an entire element. This is the same as calling :meth:`start`,
:meth:`data`, and :meth:`end` in sequence. The *text* argument can be
omitted.
"""
self.start(tag, attrib, **extra)
if text:
self.data(text)
self.end(indent=False)
def flush(self):
"""Flush the output stream."""
pass # replaced by the constructor
def _generate_transform(transform_list):
parts = []
for type, value in transform_list:
if (type == 'scale' and (value == (1,) or value == (1, 1))
or type == 'translate' and value == (0, 0)
or type == 'rotate' and value == (0,)):
continue
if type == 'matrix' and isinstance(value, Affine2DBase):
value = value.to_values()
parts.append('{}({})'.format(
type, ' '.join(_short_float_fmt(x) for x in value)))
return ' '.join(parts)
def _generate_css(attrib):
return "; ".join(f"{k}: {v}" for k, v in attrib.items())
_capstyle_d = {'projecting': 'square', 'butt': 'butt', 'round': 'round'}
def _check_is_str(info, key):
if not isinstance(info, str):
raise TypeError(f'Invalid type for {key} metadata. Expected str, not '
f'{type(info)}.')
def _check_is_iterable_of_str(infos, key):
if np.iterable(infos):
for info in infos:
if not isinstance(info, str):
raise TypeError(f'Invalid type for {key} metadata. Expected '
f'iterable of str, not {type(info)}.')
else:
raise TypeError(f'Invalid type for {key} metadata. Expected str or '
f'iterable of str, not {type(infos)}.')
class RendererSVG(RendererBase):
def __init__(self, width, height, svgwriter, basename=None, image_dpi=72,
*, metadata=None):
self.width = width
self.height = height
self.writer = XMLWriter(svgwriter)
self.image_dpi = image_dpi # actual dpi at which we rasterize stuff
if basename is None:
basename = getattr(svgwriter, "name", "")
if not isinstance(basename, str):
basename = ""
self.basename = basename
self._groupd = {}
self._image_counter = itertools.count()
self._clipd = {}
self._markers = {}
self._path_collection_id = 0
self._hatchd = {}
self._has_gouraud = False
self._n_gradients = 0
super().__init__()
self._glyph_map = dict()
str_height = _short_float_fmt(height)
str_width = _short_float_fmt(width)
svgwriter.write(svgProlog)
self._start_id = self.writer.start(
'svg',
width=f'{str_width}pt',
height=f'{str_height}pt',
viewBox=f'0 0 {str_width} {str_height}',
xmlns="http://www.w3.org/2000/svg",
version="1.1",
attrib={'xmlns:xlink': "http://www.w3.org/1999/xlink"})
self._write_metadata(metadata)
self._write_default_style()
def finalize(self):
self._write_clips()
self._write_hatches()
self.writer.close(self._start_id)
self.writer.flush()
def _write_metadata(self, metadata):
# Add metadata following the Dublin Core Metadata Initiative, and the
# Creative Commons Rights Expression Language. This is mainly for
# compatibility with Inkscape.
if metadata is None:
metadata = {}
metadata = {
'Format': 'image/svg+xml',
'Type': 'http://purl.org/dc/dcmitype/StillImage',
'Creator':
f'Matplotlib v{mpl.__version__}, https://matplotlib.org/',
**metadata
}
writer = self.writer
if 'Title' in metadata:
title = metadata['Title']
_check_is_str(title, 'Title')
writer.element('title', text=title)
# Special handling.
date = metadata.get('Date', None)
if date is not None:
if isinstance(date, str):
dates = [date]
elif isinstance(date, (datetime.datetime, datetime.date)):
dates = [date.isoformat()]
elif np.iterable(date):
dates = []
for d in date:
if isinstance(d, str):
dates.append(d)
elif isinstance(d, (datetime.datetime, datetime.date)):
dates.append(d.isoformat())
else:
raise TypeError(
f'Invalid type for Date metadata. '
f'Expected iterable of str, date, or datetime, '
f'not {type(d)}.')
else:
raise TypeError(f'Invalid type for Date metadata. '
f'Expected str, date, datetime, or iterable '
f'of the same, not {type(date)}.')
metadata['Date'] = '/'.join(dates)
elif 'Date' not in metadata:
# Do not add `Date` if the user explicitly set `Date` to `None`
# Get source date from SOURCE_DATE_EPOCH, if set.
# See https://reproducible-builds.org/specs/source-date-epoch/
date = os.getenv("SOURCE_DATE_EPOCH")
if date:
date = datetime.datetime.fromtimestamp(int(date), datetime.timezone.utc)
metadata['Date'] = date.replace(tzinfo=UTC).isoformat()
else:
metadata['Date'] = datetime.datetime.today().isoformat()
mid = None
def ensure_metadata(mid):
if mid is not None:
return mid
mid = writer.start('metadata')
writer.start('rdf:RDF', attrib={
'xmlns:dc': "http://purl.org/dc/elements/1.1/",
'xmlns:cc': "http://creativecommons.org/ns#",
'xmlns:rdf': "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
})
writer.start('cc:Work')
return mid
uri = metadata.pop('Type', None)
if uri is not None:
mid = ensure_metadata(mid)
writer.element('dc:type', attrib={'rdf:resource': uri})
# Single value only.
for key in ['Title', 'Coverage', 'Date', 'Description', 'Format',
'Identifier', 'Language', 'Relation', 'Source']:
info = metadata.pop(key, None)
if info is not None:
mid = ensure_metadata(mid)
_check_is_str(info, key)
writer.element(f'dc:{key.lower()}', text=info)
# Multiple Agent values.
for key in ['Creator', 'Contributor', 'Publisher', 'Rights']:
agents = metadata.pop(key, None)
if agents is None:
continue
if isinstance(agents, str):
agents = [agents]
_check_is_iterable_of_str(agents, key)
# Now we know that we have an iterable of str
mid = ensure_metadata(mid)
writer.start(f'dc:{key.lower()}')
for agent in agents:
writer.start('cc:Agent')
writer.element('dc:title', text=agent)
writer.end('cc:Agent')
writer.end(f'dc:{key.lower()}')
# Multiple values.
keywords = metadata.pop('Keywords', None)
if keywords is not None:
if isinstance(keywords, str):
keywords = [keywords]
_check_is_iterable_of_str(keywords, 'Keywords')
# Now we know that we have an iterable of str
mid = ensure_metadata(mid)
writer.start('dc:subject')
writer.start('rdf:Bag')
for keyword in keywords:
writer.element('rdf:li', text=keyword)
writer.end('rdf:Bag')
writer.end('dc:subject')
if mid is not None:
writer.close(mid)
if metadata:
raise ValueError('Unknown metadata key(s) passed to SVG writer: ' +
','.join(metadata))
def _write_default_style(self):
writer = self.writer
default_style = _generate_css({
'stroke-linejoin': 'round',
'stroke-linecap': 'butt'})
writer.start('defs')
writer.element('style', type='text/css', text='*{%s}' % default_style)
writer.end('defs')
def _make_id(self, type, content):
salt = mpl.rcParams['svg.hashsalt']
if salt is None:
salt = str(uuid.uuid4())
m = hashlib.sha256()
m.update(salt.encode('utf8'))
m.update(str(content).encode('utf8'))
return f'{type}{m.hexdigest()[:10]}'
def _make_flip_transform(self, transform):
return transform + Affine2D().scale(1, -1).translate(0, self.height)
def _get_hatch(self, gc, rgbFace):
"""
Create a new hatch pattern
"""
if rgbFace is not None:
rgbFace = tuple(rgbFace)
edge = gc.get_hatch_color()
if edge is not None:
edge = tuple(edge)
dictkey = (gc.get_hatch(), rgbFace, edge)
oid = self._hatchd.get(dictkey)
if oid is None:
oid = self._make_id('h', dictkey)
self._hatchd[dictkey] = ((gc.get_hatch_path(), rgbFace, edge), oid)
else:
_, oid = oid
return oid
def _write_hatches(self):
if not len(self._hatchd):
return
HATCH_SIZE = 72
writer = self.writer
writer.start('defs')
for (path, face, stroke), oid in self._hatchd.values():
writer.start(
'pattern',
id=oid,
patternUnits="userSpaceOnUse",
x="0", y="0", width=str(HATCH_SIZE),
height=str(HATCH_SIZE))
path_data = self._convert_path(
path,
Affine2D()
.scale(HATCH_SIZE).scale(1.0, -1.0).translate(0, HATCH_SIZE),
simplify=False)
if face is None:
fill = 'none'
else:
fill = rgb2hex(face)
writer.element(
'rect',
x="0", y="0", width=str(HATCH_SIZE+1),
height=str(HATCH_SIZE+1),
fill=fill)
hatch_style = {
'fill': rgb2hex(stroke),
'stroke': rgb2hex(stroke),
'stroke-width': str(mpl.rcParams['hatch.linewidth']),
'stroke-linecap': 'butt',
'stroke-linejoin': 'miter'
}
if stroke[3] < 1:
hatch_style['stroke-opacity'] = str(stroke[3])
writer.element(
'path',
d=path_data,
style=_generate_css(hatch_style)
)
writer.end('pattern')
writer.end('defs')
def _get_style_dict(self, gc, rgbFace):
"""Generate a style string from the GraphicsContext and rgbFace."""
attrib = {}
forced_alpha = gc.get_forced_alpha()
if gc.get_hatch() is not None:
attrib['fill'] = f"url(#{self._get_hatch(gc, rgbFace)})"
if (rgbFace is not None and len(rgbFace) == 4 and rgbFace[3] != 1.0
and not forced_alpha):
attrib['fill-opacity'] = _short_float_fmt(rgbFace[3])
else:
if rgbFace is None:
attrib['fill'] = 'none'
else:
if tuple(rgbFace[:3]) != (0, 0, 0):
attrib['fill'] = rgb2hex(rgbFace)
if (len(rgbFace) == 4 and rgbFace[3] != 1.0
and not forced_alpha):
attrib['fill-opacity'] = _short_float_fmt(rgbFace[3])
if forced_alpha and gc.get_alpha() != 1.0:
attrib['opacity'] = _short_float_fmt(gc.get_alpha())
offset, seq = gc.get_dashes()
if seq is not None:
attrib['stroke-dasharray'] = ','.join(
_short_float_fmt(val) for val in seq)
attrib['stroke-dashoffset'] = _short_float_fmt(float(offset))
linewidth = gc.get_linewidth()
if linewidth:
rgb = gc.get_rgb()
attrib['stroke'] = rgb2hex(rgb)
if not forced_alpha and rgb[3] != 1.0:
attrib['stroke-opacity'] = _short_float_fmt(rgb[3])
if linewidth != 1.0:
attrib['stroke-width'] = _short_float_fmt(linewidth)
if gc.get_joinstyle() != 'round':
attrib['stroke-linejoin'] = gc.get_joinstyle()
if gc.get_capstyle() != 'butt':
attrib['stroke-linecap'] = _capstyle_d[gc.get_capstyle()]
return attrib
def _get_style(self, gc, rgbFace):
return _generate_css(self._get_style_dict(gc, rgbFace))
def _get_clip_attrs(self, gc):
cliprect = gc.get_clip_rectangle()
clippath, clippath_trans = gc.get_clip_path()
if clippath is not None:
clippath_trans = self._make_flip_transform(clippath_trans)
dictkey = (id(clippath), str(clippath_trans))
elif cliprect is not None:
x, y, w, h = cliprect.bounds
y = self.height-(y+h)
dictkey = (x, y, w, h)
else:
return {}
clip = self._clipd.get(dictkey)
if clip is None:
oid = self._make_id('p', dictkey)
if clippath is not None:
self._clipd[dictkey] = ((clippath, clippath_trans), oid)
else:
self._clipd[dictkey] = (dictkey, oid)
else:
clip, oid = clip
return {'clip-path': f'url(#{oid})'}
def _write_clips(self):
if not len(self._clipd):
return
writer = self.writer
writer.start('defs')
for clip, oid in self._clipd.values():
writer.start('clipPath', id=oid)
if len(clip) == 2:
clippath, clippath_trans = clip
path_data = self._convert_path(
clippath, clippath_trans, simplify=False)
writer.element('path', d=path_data)
else:
x, y, w, h = clip
writer.element(
'rect',
x=_short_float_fmt(x),
y=_short_float_fmt(y),
width=_short_float_fmt(w),
height=_short_float_fmt(h))
writer.end('clipPath')
writer.end('defs')
def open_group(self, s, gid=None):
# docstring inherited
if gid:
self.writer.start('g', id=gid)
else:
self._groupd[s] = self._groupd.get(s, 0) + 1
self.writer.start('g', id=f"{s}_{self._groupd[s]:d}")
def close_group(self, s):
# docstring inherited
self.writer.end('g')
def option_image_nocomposite(self):
# docstring inherited
return not mpl.rcParams['image.composite_image']
def _convert_path(self, path, transform=None, clip=None, simplify=None,
sketch=None):
if clip:
clip = (0.0, 0.0, self.width, self.height)
else:
clip = None
return _path.convert_to_string(
path, transform, clip, simplify, sketch, 6,
[b'M', b'L', b'Q', b'C', b'z'], False).decode('ascii')
def draw_path(self, gc, path, transform, rgbFace=None):
# docstring inherited
trans_and_flip = self._make_flip_transform(transform)
clip = (rgbFace is None and gc.get_hatch_path() is None)
simplify = path.should_simplify and clip
path_data = self._convert_path(
path, trans_and_flip, clip=clip, simplify=simplify,
sketch=gc.get_sketch_params())
if gc.get_url() is not None:
self.writer.start('a', {'xlink:href': gc.get_url()})
self.writer.element('path', d=path_data, **self._get_clip_attrs(gc),
style=self._get_style(gc, rgbFace))
if gc.get_url() is not None:
self.writer.end('a')
def draw_markers(
self, gc, marker_path, marker_trans, path, trans, rgbFace=None):
# docstring inherited
if not len(path.vertices):
return
writer = self.writer
path_data = self._convert_path(
marker_path,
marker_trans + Affine2D().scale(1.0, -1.0),
simplify=False)
style = self._get_style_dict(gc, rgbFace)
dictkey = (path_data, _generate_css(style))
oid = self._markers.get(dictkey)
style = _generate_css({k: v for k, v in style.items()
if k.startswith('stroke')})
if oid is None:
oid = self._make_id('m', dictkey)
writer.start('defs')
writer.element('path', id=oid, d=path_data, style=style)
writer.end('defs')
self._markers[dictkey] = oid
writer.start('g', **self._get_clip_attrs(gc))
trans_and_flip = self._make_flip_transform(trans)
attrib = {'xlink:href': f'#{oid}'}
clip = (0, 0, self.width*72, self.height*72)
for vertices, code in path.iter_segments(
trans_and_flip, clip=clip, simplify=False):
if len(vertices):
x, y = vertices[-2:]
attrib['x'] = _short_float_fmt(x)
attrib['y'] = _short_float_fmt(y)
attrib['style'] = self._get_style(gc, rgbFace)
writer.element('use', attrib=attrib)
writer.end('g')
def draw_path_collection(self, gc, master_transform, paths, all_transforms,
offsets, offset_trans, facecolors, edgecolors,
linewidths, linestyles, antialiaseds, urls,
offset_position):
# Is the optimization worth it? Rough calculation:
# cost of emitting a path in-line is
# (len_path + 5) * uses_per_path
# cost of definition+use is
# (len_path + 3) + 9 * uses_per_path
len_path = len(paths[0].vertices) if len(paths) > 0 else 0
uses_per_path = self._iter_collection_uses_per_path(
paths, all_transforms, offsets, facecolors, edgecolors)
should_do_optimization = \
len_path + 9 * uses_per_path + 3 < (len_path + 5) * uses_per_path
if not should_do_optimization:
return super().draw_path_collection(
gc, master_transform, paths, all_transforms,
offsets, offset_trans, facecolors, edgecolors,
linewidths, linestyles, antialiaseds, urls,
offset_position)
writer = self.writer
path_codes = []
writer.start('defs')
for i, (path, transform) in enumerate(self._iter_collection_raw_paths(
master_transform, paths, all_transforms)):
transform = Affine2D(transform.get_matrix()).scale(1.0, -1.0)
d = self._convert_path(path, transform, simplify=False)
oid = 'C{:x}_{:x}_{}'.format(
self._path_collection_id, i, self._make_id('', d))
writer.element('path', id=oid, d=d)
path_codes.append(oid)
writer.end('defs')
for xo, yo, path_id, gc0, rgbFace in self._iter_collection(
gc, path_codes, offsets, offset_trans,
facecolors, edgecolors, linewidths, linestyles,
antialiaseds, urls, offset_position):
url = gc0.get_url()
if url is not None:
writer.start('a', attrib={'xlink:href': url})
clip_attrs = self._get_clip_attrs(gc0)
if clip_attrs:
writer.start('g', **clip_attrs)
attrib = {
'xlink:href': f'#{path_id}',
'x': _short_float_fmt(xo),
'y': _short_float_fmt(self.height - yo),
'style': self._get_style(gc0, rgbFace)
}
writer.element('use', attrib=attrib)
if clip_attrs:
writer.end('g')
if url is not None:
writer.end('a')
self._path_collection_id += 1
def draw_gouraud_triangle(self, gc, points, colors, trans):
# docstring inherited
self._draw_gouraud_triangle(gc, points, colors, trans)
def _draw_gouraud_triangle(self, gc, points, colors, trans):
# This uses a method described here:
#
# http://www.svgopen.org/2005/papers/Converting3DFaceToSVG/index.html
#
# that uses three overlapping linear gradients to simulate a
# Gouraud triangle. Each gradient goes from fully opaque in
# one corner to fully transparent along the opposite edge.
# The line between the stop points is perpendicular to the
# opposite edge. Underlying these three gradients is a solid
# triangle whose color is the average of all three points.
writer = self.writer
if not self._has_gouraud:
self._has_gouraud = True
writer.start(
'filter',
id='colorAdd')
writer.element(
'feComposite',
attrib={'in': 'SourceGraphic'},
in2='BackgroundImage',
operator='arithmetic',
k2="1", k3="1")
writer.end('filter')
# feColorMatrix filter to correct opacity
writer.start(
'filter',
id='colorMat')
writer.element(
'feColorMatrix',
attrib={'type': 'matrix'},
values='1 0 0 0 0 \n0 1 0 0 0 \n0 0 1 0 0' +
' \n1 1 1 1 0 \n0 0 0 0 1 ')
writer.end('filter')
avg_color = np.average(colors, axis=0)
if avg_color[-1] == 0:
# Skip fully-transparent triangles
return
trans_and_flip = self._make_flip_transform(trans)
tpoints = trans_and_flip.transform(points)
writer.start('defs')
for i in range(3):
x1, y1 = tpoints[i]
x2, y2 = tpoints[(i + 1) % 3]
x3, y3 = tpoints[(i + 2) % 3]
rgba_color = colors[i]
if x2 == x3:
xb = x2
yb = y1
elif y2 == y3:
xb = x1
yb = y2
else:
m1 = (y2 - y3) / (x2 - x3)
b1 = y2 - (m1 * x2)
m2 = -(1.0 / m1)
b2 = y1 - (m2 * x1)
xb = (-b1 + b2) / (m1 - m2)
yb = m2 * xb + b2
writer.start(
'linearGradient',
id=f"GR{self._n_gradients:x}_{i:d}",
gradientUnits="userSpaceOnUse",
x1=_short_float_fmt(x1), y1=_short_float_fmt(y1),
x2=_short_float_fmt(xb), y2=_short_float_fmt(yb))
writer.element(
'stop',
offset='1',
style=_generate_css({
'stop-color': rgb2hex(avg_color),
'stop-opacity': _short_float_fmt(rgba_color[-1])}))
writer.element(
'stop',
offset='0',
style=_generate_css({'stop-color': rgb2hex(rgba_color),
'stop-opacity': "0"}))
writer.end('linearGradient')
writer.end('defs')
# triangle formation using "path"
dpath = "M " + _short_float_fmt(x1)+',' + _short_float_fmt(y1)
dpath += " L " + _short_float_fmt(x2) + ',' + _short_float_fmt(y2)
dpath += " " + _short_float_fmt(x3) + ',' + _short_float_fmt(y3) + " Z"
writer.element(
'path',
attrib={'d': dpath,
'fill': rgb2hex(avg_color),
'fill-opacity': '1',
'shape-rendering': "crispEdges"})
writer.start(
'g',
attrib={'stroke': "none",
'stroke-width': "0",
'shape-rendering': "crispEdges",
'filter': "url(#colorMat)"})
writer.element(
'path',
attrib={'d': dpath,
'fill': f'url(#GR{self._n_gradients:x}_0)',
'shape-rendering': "crispEdges"})
writer.element(
'path',
attrib={'d': dpath,
'fill': f'url(#GR{self._n_gradients:x}_1)',
'filter': 'url(#colorAdd)',
'shape-rendering': "crispEdges"})
writer.element(
'path',
attrib={'d': dpath,
'fill': f'url(#GR{self._n_gradients:x}_2)',
'filter': 'url(#colorAdd)',
'shape-rendering': "crispEdges"})
writer.end('g')
self._n_gradients += 1
def draw_gouraud_triangles(self, gc, triangles_array, colors_array,
transform):
self.writer.start('g', **self._get_clip_attrs(gc))
transform = transform.frozen()
for tri, col in zip(triangles_array, colors_array):
self._draw_gouraud_triangle(gc, tri, col, transform)
self.writer.end('g')
def option_scale_image(self):
# docstring inherited
return True
def get_image_magnification(self):
return self.image_dpi / 72.0
def draw_image(self, gc, x, y, im, transform=None):
# docstring inherited
h, w = im.shape[:2]
if w == 0 or h == 0:
return
clip_attrs = self._get_clip_attrs(gc)
if clip_attrs:
# Can't apply clip-path directly to the image because the image has
# a transformation, which would also be applied to the clip-path.
self.writer.start('g', **clip_attrs)
url = gc.get_url()
if url is not None:
self.writer.start('a', attrib={'xlink:href': url})
attrib = {}
oid = gc.get_gid()
if mpl.rcParams['svg.image_inline']:
buf = BytesIO()
Image.fromarray(im).save(buf, format="png")
oid = oid or self._make_id('image', buf.getvalue())
attrib['xlink:href'] = (
"data:image/png;base64,\n" +
base64.b64encode(buf.getvalue()).decode('ascii'))
else:
if self.basename is None:
raise ValueError("Cannot save image data to filesystem when "
"writing SVG to an in-memory buffer")
filename = f'{self.basename}.image{next(self._image_counter)}.png'
_log.info('Writing image file for inclusion: %s', filename)
Image.fromarray(im).save(filename)
oid = oid or 'Im_' + self._make_id('image', filename)
attrib['xlink:href'] = filename
attrib['id'] = oid
if transform is None:
w = 72.0 * w / self.image_dpi
h = 72.0 * h / self.image_dpi
self.writer.element(
'image',
transform=_generate_transform([
('scale', (1, -1)), ('translate', (0, -h))]),
x=_short_float_fmt(x),
y=_short_float_fmt(-(self.height - y - h)),
width=_short_float_fmt(w), height=_short_float_fmt(h),
attrib=attrib)
else:
alpha = gc.get_alpha()
if alpha != 1.0:
attrib['opacity'] = _short_float_fmt(alpha)
flipped = (
Affine2D().scale(1.0 / w, 1.0 / h) +
transform +
Affine2D()
.translate(x, y)
.scale(1.0, -1.0)
.translate(0.0, self.height))
attrib['transform'] = _generate_transform(
[('matrix', flipped.frozen())])
attrib['style'] = (
'image-rendering:crisp-edges;'
'image-rendering:pixelated')
self.writer.element(
'image',
width=_short_float_fmt(w), height=_short_float_fmt(h),
attrib=attrib)
if url is not None:
self.writer.end('a')
if clip_attrs:
self.writer.end('g')
def _update_glyph_map_defs(self, glyph_map_new):
"""
Emit definitions for not-yet-defined glyphs, and record them as having
been defined.
"""
writer = self.writer
if glyph_map_new:
writer.start('defs')
for char_id, (vertices, codes) in glyph_map_new.items():
char_id = self._adjust_char_id(char_id)
# x64 to go back to FreeType's internal (integral) units.
path_data = self._convert_path(
Path(vertices * 64, codes), simplify=False)
writer.element(
'path', id=char_id, d=path_data,
transform=_generate_transform([('scale', (1 / 64,))]))
writer.end('defs')
self._glyph_map.update(glyph_map_new)
def _adjust_char_id(self, char_id):
return char_id.replace("%20", "_")
def _draw_text_as_path(self, gc, x, y, s, prop, angle, ismath, mtext=None):
# docstring inherited
writer = self.writer
writer.comment(s)
glyph_map = self._glyph_map
text2path = self._text2path
color = rgb2hex(gc.get_rgb())
fontsize = prop.get_size_in_points()
style = {}
if color != '#000000':
style['fill'] = color
alpha = gc.get_alpha() if gc.get_forced_alpha() else gc.get_rgb()[3]
if alpha != 1:
style['opacity'] = _short_float_fmt(alpha)
font_scale = fontsize / text2path.FONT_SCALE
attrib = {
'style': _generate_css(style),
'transform': _generate_transform([
('translate', (x, y)),
('rotate', (-angle,)),
('scale', (font_scale, -font_scale))]),
}
writer.start('g', attrib=attrib)
if not ismath:
font = text2path._get_font(prop)
_glyphs = text2path.get_glyphs_with_font(
font, s, glyph_map=glyph_map, return_new_glyphs_only=True)
glyph_info, glyph_map_new, rects = _glyphs
self._update_glyph_map_defs(glyph_map_new)
for glyph_id, xposition, yposition, scale in glyph_info:
attrib = {'xlink:href': f'#{glyph_id}'}
if xposition != 0.0:
attrib['x'] = _short_float_fmt(xposition)
if yposition != 0.0:
attrib['y'] = _short_float_fmt(yposition)
writer.element('use', attrib=attrib)
else:
if ismath == "TeX":
_glyphs = text2path.get_glyphs_tex(
prop, s, glyph_map=glyph_map, return_new_glyphs_only=True)
else:
_glyphs = text2path.get_glyphs_mathtext(
prop, s, glyph_map=glyph_map, return_new_glyphs_only=True)
glyph_info, glyph_map_new, rects = _glyphs
self._update_glyph_map_defs(glyph_map_new)
for char_id, xposition, yposition, scale in glyph_info:
char_id = self._adjust_char_id(char_id)
writer.element(
'use',
transform=_generate_transform([
('translate', (xposition, yposition)),
('scale', (scale,)),
]),
attrib={'xlink:href': f'#{char_id}'})
for verts, codes in rects:
path = Path(verts, codes)
path_data = self._convert_path(path, simplify=False)
writer.element('path', d=path_data)
writer.end('g')
def _draw_text_as_text(self, gc, x, y, s, prop, angle, ismath, mtext=None):
writer = self.writer
color = rgb2hex(gc.get_rgb())
style = {}
if color != '#000000':
style['fill'] = color
alpha = gc.get_alpha() if gc.get_forced_alpha() else gc.get_rgb()[3]
if alpha != 1:
style['opacity'] = _short_float_fmt(alpha)
if not ismath:
attrib = {}
font_parts = []
if prop.get_style() != 'normal':
font_parts.append(prop.get_style())
if prop.get_variant() != 'normal':
font_parts.append(prop.get_variant())
weight = fm.weight_dict[prop.get_weight()]
if weight != 400:
font_parts.append(f'{weight}')
def _normalize_sans(name):
return 'sans-serif' if name in ['sans', 'sans serif'] else name
def _expand_family_entry(fn):
fn = _normalize_sans(fn)
# prepend generic font families with all configured font names
if fn in fm.font_family_aliases:
# get all of the font names and fix spelling of sans-serif
# (we accept 3 ways CSS only supports 1)
for name in fm.FontManager._expand_aliases(fn):
yield _normalize_sans(name)
# whether a generic name or a family name, it must appear at
# least once
yield fn
def _get_all_quoted_names(prop):
# only quote specific names, not generic names
return [name if name in fm.font_family_aliases else repr(name)
for entry in prop.get_family()
for name in _expand_family_entry(entry)]
font_parts.extend([
f'{_short_float_fmt(prop.get_size())}px',
# ensure expansion, quoting, and dedupe of font names
", ".join(dict.fromkeys(_get_all_quoted_names(prop)))
])
style['font'] = ' '.join(font_parts)
if prop.get_stretch() != 'normal':
style['font-stretch'] = prop.get_stretch()
attrib['style'] = _generate_css(style)
if mtext and (angle == 0 or mtext.get_rotation_mode() == "anchor"):
# If text anchoring can be supported, get the original
# coordinates and add alignment information.
# Get anchor coordinates.
transform = mtext.get_transform()
ax, ay = transform.transform(mtext.get_unitless_position())
ay = self.height - ay
# Don't do vertical anchor alignment. Most applications do not
# support 'alignment-baseline' yet. Apply the vertical layout
# to the anchor point manually for now.
angle_rad = np.deg2rad(angle)
dir_vert = np.array([np.sin(angle_rad), np.cos(angle_rad)])
v_offset = np.dot(dir_vert, [(x - ax), (y - ay)])
ax = ax + v_offset * dir_vert[0]
ay = ay + v_offset * dir_vert[1]
ha_mpl_to_svg = {'left': 'start', 'right': 'end',
'center': 'middle'}
style['text-anchor'] = ha_mpl_to_svg[mtext.get_ha()]
attrib['x'] = _short_float_fmt(ax)
attrib['y'] = _short_float_fmt(ay)
attrib['style'] = _generate_css(style)
attrib['transform'] = _generate_transform([
("rotate", (-angle, ax, ay))])
else:
attrib['transform'] = _generate_transform([
('translate', (x, y)),
('rotate', (-angle,))])
writer.element('text', s, attrib=attrib)
else:
writer.comment(s)
width, height, descent, glyphs, rects = \
self._text2path.mathtext_parser.parse(s, 72, prop)
# Apply attributes to 'g', not 'text', because we likely have some
# rectangles as well with the same style and transformation.
writer.start('g',
style=_generate_css(style),
transform=_generate_transform([
('translate', (x, y)),
('rotate', (-angle,))]),
)
writer.start('text')
# Sort the characters by font, and output one tspan for each.
spans = {}
for font, fontsize, thetext, new_x, new_y in glyphs:
entry = fm.ttfFontProperty(font)
font_parts = []
if entry.style != 'normal':
font_parts.append(entry.style)
if entry.variant != 'normal':
font_parts.append(entry.variant)
if entry.weight != 400:
font_parts.append(f'{entry.weight}')
font_parts.extend([
f'{_short_float_fmt(fontsize)}px',
f'{entry.name!r}', # ensure quoting
])
style = {'font': ' '.join(font_parts)}
if entry.stretch != 'normal':
style['font-stretch'] = entry.stretch
style = _generate_css(style)
if thetext == 32:
thetext = 0xa0 # non-breaking space
spans.setdefault(style, []).append((new_x, -new_y, thetext))
for style, chars in spans.items():
chars.sort()
if len({y for x, y, t in chars}) == 1: # Are all y's the same?
ys = str(chars[0][1])
else:
ys = ' '.join(str(c[1]) for c in chars)
attrib = {
'style': style,
'x': ' '.join(_short_float_fmt(c[0]) for c in chars),
'y': ys
}
writer.element(
'tspan',
''.join(chr(c[2]) for c in chars),
attrib=attrib)
writer.end('text')
for x, y, width, height in rects:
writer.element(
'rect',
x=_short_float_fmt(x),
y=_short_float_fmt(-y-1),
width=_short_float_fmt(width),
height=_short_float_fmt(height)
)
writer.end('g')
def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
# docstring inherited
clip_attrs = self._get_clip_attrs(gc)
if clip_attrs:
# Cannot apply clip-path directly to the text, because
# it has a transformation
self.writer.start('g', **clip_attrs)
if gc.get_url() is not None:
self.writer.start('a', {'xlink:href': gc.get_url()})
if mpl.rcParams['svg.fonttype'] == 'path':
self._draw_text_as_path(gc, x, y, s, prop, angle, ismath, mtext)
else:
self._draw_text_as_text(gc, x, y, s, prop, angle, ismath, mtext)
if gc.get_url() is not None:
self.writer.end('a')
if clip_attrs:
self.writer.end('g')
def flipy(self):
# docstring inherited
return True
def get_canvas_width_height(self):
# docstring inherited
return self.width, self.height
def get_text_width_height_descent(self, s, prop, ismath):
# docstring inherited
return self._text2path.get_text_width_height_descent(s, prop, ismath)
class FigureCanvasSVG(FigureCanvasBase):
filetypes = {'svg': 'Scalable Vector Graphics',
'svgz': 'Scalable Vector Graphics'}
fixed_dpi = 72
def print_svg(self, filename, *, bbox_inches_restore=None, metadata=None):
"""
Parameters
----------
filename : str or path-like or file-like
Output target; if a string, a file will be opened for writing.
metadata : dict[str, Any], optional
Metadata in the SVG file defined as key-value pairs of strings,
datetimes, or lists of strings, e.g., ``{'Creator': 'My software',
'Contributor': ['Me', 'My Friend'], 'Title': 'Awesome'}``.
The standard keys and their value types are:
* *str*: ``'Coverage'``, ``'Description'``, ``'Format'``,
``'Identifier'``, ``'Language'``, ``'Relation'``, ``'Source'``,
``'Title'``, and ``'Type'``.
* *str* or *list of str*: ``'Contributor'``, ``'Creator'``,
``'Keywords'``, ``'Publisher'``, and ``'Rights'``.
* *str*, *date*, *datetime*, or *tuple* of same: ``'Date'``. If a
non-*str*, then it will be formatted as ISO 8601.
Values have been predefined for ``'Creator'``, ``'Date'``,
``'Format'``, and ``'Type'``. They can be removed by setting them
to `None`.
Information is encoded as `Dublin Core Metadata`__.
.. _DC: https://www.dublincore.org/specifications/dublin-core/
__ DC_
"""
with cbook.open_file_cm(filename, "w", encoding="utf-8") as fh:
if not cbook.file_requires_unicode(fh):
fh = codecs.getwriter('utf-8')(fh)
dpi = self.figure.dpi
self.figure.dpi = 72
width, height = self.figure.get_size_inches()
w, h = width * 72, height * 72
renderer = MixedModeRenderer(
self.figure, width, height, dpi,
RendererSVG(w, h, fh, image_dpi=dpi, metadata=metadata),
bbox_inches_restore=bbox_inches_restore)
self.figure.draw(renderer)
renderer.finalize()
def print_svgz(self, filename, **kwargs):
with cbook.open_file_cm(filename, "wb") as fh, \
gzip.GzipFile(mode='w', fileobj=fh) as gzipwriter:
return self.print_svg(gzipwriter, **kwargs)
def get_default_filetype(self):
return 'svg'
def draw(self):
self.figure.draw_without_rendering()
return super().draw()
FigureManagerSVG = FigureManagerBase
svgProlog = """\
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
"""
@_Backend.export
class _BackendSVG(_Backend):
backend_version = mpl.__version__
FigureCanvas = FigureCanvasSVG
|