{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathdviread.html
More file actions
503 lines (459 loc) · 32 KB
/
Copy pathdviread.html
File metadata and controls
503 lines (459 loc) · 32 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.dviread — Matplotlib 3.3.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.0-3-g8994f1b60" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.figure" href="figure_api.html" />
<link rel="prev" title="matplotlib.dates" href="dates_api.html" />
<link rel="top" title="Matplotlib 3.3.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/dviread.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.0). For the latest version see <a href="https://matplotlib.org/stable/api/dviread.html">https://matplotlib.org/stable/api/dviread.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.0</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="figure_api.html" title="matplotlib.figure"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dates_api.html" title="matplotlib.dates"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="dates_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.dates</span></code></a></li>
<li>Next: <a href="figure_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/dviread.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.dviread">
<span id="matplotlib-dviread"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.dviread</span></code><a class="headerlink" href="#module-matplotlib.dviread" title="Permalink to this headline">¶</a></h1>
<p>A module for reading dvi files output by TeX. Several limitations make
this not (currently) useful as a general-purpose dvi preprocessor, but
it is currently used by the pdf backend for processing usetex text.</p>
<p>Interface:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">Dvi</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="mi">72</span><span class="p">)</span> <span class="k">as</span> <span class="n">dvi</span><span class="p">:</span>
<span class="c1"># iterate over pages:</span>
<span class="k">for</span> <span class="n">page</span> <span class="ow">in</span> <span class="n">dvi</span><span class="p">:</span>
<span class="n">w</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">d</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="n">page</span><span class="o">.</span><span class="n">height</span><span class="p">,</span> <span class="n">page</span><span class="o">.</span><span class="n">descent</span>
<span class="k">for</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">font</span><span class="p">,</span> <span class="n">glyph</span><span class="p">,</span> <span class="n">width</span> <span class="ow">in</span> <span class="n">page</span><span class="o">.</span><span class="n">text</span><span class="p">:</span>
<span class="n">fontname</span> <span class="o">=</span> <span class="n">font</span><span class="o">.</span><span class="n">texname</span>
<span class="n">pointsize</span> <span class="o">=</span> <span class="n">font</span><span class="o">.</span><span class="n">size</span>
<span class="o">...</span>
<span class="k">for</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="n">width</span> <span class="ow">in</span> <span class="n">page</span><span class="o">.</span><span class="n">boxes</span><span class="p">:</span>
<span class="o">...</span>
</pre></div>
</div>
<dl class="class">
<dt id="matplotlib.dviread.Dvi">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">Dvi</code><span class="sig-paren">(</span><em>filename</em>, <em>dpi</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dviread.html#Dvi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.Dvi" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A reader for a dvi ("device-independent") file, as produced by TeX.
The current implementation can only iterate through pages in order,
and does not even attempt to verify the postamble.</p>
<p>This class can be used as a context manager to close the underlying
file upon exit. Pages can be read via iteration. Here is an overly
simple way to extract text without trying to detect whitespace:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">with</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">dviread</span><span class="o">.</span><span class="n">Dvi</span><span class="p">(</span><span class="s1">'input.dvi'</span><span class="p">,</span> <span class="mi">72</span><span class="p">)</span> <span class="k">as</span> <span class="n">dvi</span><span class="p">:</span>
<span class="gp">... </span> <span class="k">for</span> <span class="n">page</span> <span class="ow">in</span> <span class="n">dvi</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">chr</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">glyph</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">page</span><span class="o">.</span><span class="n">text</span><span class="p">))</span>
</pre></div>
</div>
<p>Read the data from the file named <em>filename</em> and convert
TeX's internal units to units of <em>dpi</em> per inch.
<em>dpi</em> only sets the units and does not limit the resolution.
Use None to return TeX's internal units.</p>
<dl class="method">
<dt id="matplotlib.dviread.Dvi.close">
<code class="descname">close</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dviread.html#Dvi.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.Dvi.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Close the underlying file if it is open.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dviread.DviFont">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">DviFont</code><span class="sig-paren">(</span><em>scale</em>, <em>tfm</em>, <em>texname</em>, <em>vf</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dviread.html#DviFont"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.DviFont" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Encapsulation of a font that a DVI file can refer to.</p>
<p>This class holds a font's texname and size, supports comparison,
and knows the widths of glyphs in the same units as the AFM file.
There are also internal attributes (for use by dviread.py) that
are <em>not</em> used for comparison.</p>
<p>The size is in Adobe points (converted from TeX points).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>scale</strong><span class="classifier">float</span></dt><dd><p>Factor by which the font is scaled from its natural size.</p>
</dd>
<dt><strong>tfm</strong><span class="classifier">Tfm</span></dt><dd><p>TeX font metrics for this font</p>
</dd>
<dt><strong>texname</strong><span class="classifier">bytes</span></dt><dd><p>Name of the font as used internally by TeX and friends, as an
ASCII bytestring. This is usually very different from any external
font names, and <code class="xref py py-class docutils literal notranslate"><span class="pre">dviread.PsfontsMap</span></code> can be used to find
the external name of the font.</p>
</dd>
<dt><strong>vf</strong><span class="classifier">Vf</span></dt><dd><p>A TeX "virtual font" file, or None if this font is not virtual.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>texname</strong><span class="classifier">bytes</span></dt><dd></dd>
<dt><strong>size</strong><span class="classifier">float</span></dt><dd><p>Size of the font in Adobe points, converted from the slightly
smaller TeX points.</p>
</dd>
<dt><strong>widths</strong><span class="classifier">list</span></dt><dd><p>Widths of glyphs in glyph-space units, typically 1/1000ths of
the point size.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.dviread.DviFont.size">
<code class="descname">size</code><a class="headerlink" href="#matplotlib.dviread.DviFont.size" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.DviFont.texname">
<code class="descname">texname</code><a class="headerlink" href="#matplotlib.dviread.DviFont.texname" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.DviFont.widths">
<code class="descname">widths</code><a class="headerlink" href="#matplotlib.dviread.DviFont.widths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dviread.Encoding">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">Encoding</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dviread.html#Encoding"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.Encoding" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>[<em>Deprecated</em>] Parse a *.enc file referenced from a psfonts.map style file.</p>
<p>The format this class understands is a very limited subset of PostScript.</p>
<p>Usage (subject to change):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">Encoding</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
<span class="n">whatever</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>filename</strong><span class="classifier">str or path-like</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3.</span></p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>encoding</strong><span class="classifier">list</span></dt><dd><p>List of character names</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.dviread.Encoding.encoding">
<code class="descname">encoding</code><a class="headerlink" href="#matplotlib.dviread.Encoding.encoding" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dviread.PsFont">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">PsFont</code><span class="sig-paren">(</span><em>texname</em>, <em>psname</em>, <em>effects</em>, <em>encoding</em>, <em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dviread.PsFont" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
<p>Create new instance of PsFont(texname, psname, effects, encoding, filename)</p>
<dl class="attribute">
<dt id="matplotlib.dviread.PsFont.effects">
<code class="descname">effects</code><a class="headerlink" href="#matplotlib.dviread.PsFont.effects" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 2</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.PsFont.encoding">
<code class="descname">encoding</code><a class="headerlink" href="#matplotlib.dviread.PsFont.encoding" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 3</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.PsFont.filename">
<code class="descname">filename</code><a class="headerlink" href="#matplotlib.dviread.PsFont.filename" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 4</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.PsFont.psname">
<code class="descname">psname</code><a class="headerlink" href="#matplotlib.dviread.PsFont.psname" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.PsFont.texname">
<code class="descname">texname</code><a class="headerlink" href="#matplotlib.dviread.PsFont.texname" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 0</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dviread.PsfontsMap">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">PsfontsMap</code><a class="reference internal" href="../_modules/matplotlib/dviread.html#PsfontsMap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.PsfontsMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A psfonts.map formatted file, mapping TeX fonts to PS fonts.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>filename</strong><span class="classifier">str or path-like</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>For historical reasons, TeX knows many Type-1 fonts by different
names than the outside world. (For one thing, the names have to
fit in eight characters.) Also, TeX's native fonts are not Type-1
but Metafont, which is nontrivial to convert to PostScript except
as a bitmap. While high-quality conversions to Type-1 format exist
and are shipped with modern TeX distributions, we need to know
which Type-1 fonts are the counterparts of which native fonts. For
these reasons a mapping is needed from internal font names to font
file names.</p>
<p>A texmf tree typically includes mapping files called e.g.
<code class="file docutils literal notranslate"><span class="pre">psfonts.map</span></code>, <code class="file docutils literal notranslate"><span class="pre">pdftex.map</span></code>, or <code class="file docutils literal notranslate"><span class="pre">dvipdfm.map</span></code>.
The file <code class="file docutils literal notranslate"><span class="pre">psfonts.map</span></code> is used by <strong class="program">dvips</strong>,
<code class="file docutils literal notranslate"><span class="pre">pdftex.map</span></code> by <strong class="program">pdfTeX</strong>, and <code class="file docutils literal notranslate"><span class="pre">dvipdfm.map</span></code>
by <strong class="program">dvipdfm</strong>. <code class="file docutils literal notranslate"><span class="pre">psfonts.map</span></code> might avoid embedding
the 35 PostScript fonts (i.e., have no filename for them, as in
the Times-Bold example above), while the pdf-related files perhaps
only avoid the "Base 14" pdf fonts. But the user may have
configured these files differently.</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">map</span> <span class="o">=</span> <span class="n">PsfontsMap</span><span class="p">(</span><span class="n">find_tex_file</span><span class="p">(</span><span class="s1">'pdftex.map'</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">entry</span> <span class="o">=</span> <span class="nb">map</span><span class="p">[</span><span class="sa">b</span><span class="s1">'ptmbo8r'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">entry</span><span class="o">.</span><span class="n">texname</span>
<span class="go">b'ptmbo8r'</span>
<span class="gp">>>> </span><span class="n">entry</span><span class="o">.</span><span class="n">psname</span>
<span class="go">b'Times-Bold'</span>
<span class="gp">>>> </span><span class="n">entry</span><span class="o">.</span><span class="n">encoding</span>
<span class="go">'/usr/local/texlive/2008/texmf-dist/fonts/enc/dvips/base/8r.enc'</span>
<span class="gp">>>> </span><span class="n">entry</span><span class="o">.</span><span class="n">effects</span>
<span class="go">{'slant': 0.16700000000000001}</span>
<span class="gp">>>> </span><span class="n">entry</span><span class="o">.</span><span class="n">filename</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dviread.Tfm">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">Tfm</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dviread.html#Tfm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.Tfm" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A TeX Font Metric file.</p>
<p>This implementation covers only the bare minimum needed by the Dvi class.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>filename</strong><span class="classifier">str or path-like</span></dt><dd></dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>checksum</strong><span class="classifier">int</span></dt><dd><p>Used for verifying against the dvi file.</p>
</dd>
<dt><strong>design_size</strong><span class="classifier">int</span></dt><dd><p>Design size of the font (unknown units)</p>
</dd>
<dt><strong>width, height, depth</strong><span class="classifier">dict</span></dt><dd><p>Dimensions of each character, need to be scaled by the factor
specified in the dvi file. These are dicts because indexing may
not start from 0.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.dviread.Tfm.checksum">
<code class="descname">checksum</code><a class="headerlink" href="#matplotlib.dviread.Tfm.checksum" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.Tfm.depth">
<code class="descname">depth</code><a class="headerlink" href="#matplotlib.dviread.Tfm.depth" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.Tfm.design_size">
<code class="descname">design_size</code><a class="headerlink" href="#matplotlib.dviread.Tfm.design_size" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.Tfm.height">
<code class="descname">height</code><a class="headerlink" href="#matplotlib.dviread.Tfm.height" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.Tfm.width">
<code class="descname">width</code><a class="headerlink" href="#matplotlib.dviread.Tfm.width" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dviread.Vf">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">Vf</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dviread.html#Vf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.Vf" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dviread.Dvi" title="matplotlib.dviread.Dvi"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.dviread.Dvi</span></code></a></p>
<p>A virtual font (*.vf file) containing subroutines for dvi files.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>filename</strong><span class="classifier">str or path-like</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>The virtual font format is a derivative of dvi:
<a class="reference external" href="http://mirrors.ctan.org/info/knuth/virtual-fonts">http://mirrors.ctan.org/info/knuth/virtual-fonts</a>
This class reuses some of the machinery of <a class="reference internal" href="#matplotlib.dviread.Dvi" title="matplotlib.dviread.Dvi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dvi</span></code></a>
but replaces the <code class="xref py py-obj docutils literal notranslate"><span class="pre">_read</span></code> loop and dispatch mechanism.</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">vf</span> <span class="o">=</span> <span class="n">Vf</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="n">glyph</span> <span class="o">=</span> <span class="n">vf</span><span class="p">[</span><span class="n">code</span><span class="p">]</span>
<span class="n">glyph</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">glyph</span><span class="o">.</span><span class="n">boxes</span><span class="p">,</span> <span class="n">glyph</span><span class="o">.</span><span class="n">width</span>
</pre></div>
</div>
<p>Read the data from the file named <em>filename</em> and convert
TeX's internal units to units of <em>dpi</em> per inch.
<em>dpi</em> only sets the units and does not limit the resolution.
Use None to return TeX's internal units.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.dviread.find_tex_file">
<code class="descclassname">matplotlib.dviread.</code><code class="descname">find_tex_file</code><span class="sig-paren">(</span><em>filename</em>, <em>format=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dviread.html#find_tex_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dviread.find_tex_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a file in the texmf tree.</p>
<p>Calls <strong class="program">kpsewhich</strong> which is an interface to the kpathsea
library <a class="reference internal" href="#ra043a4f19cd5-1" id="id1">[1]</a>. Most existing TeX distributions on Unix-like systems use
kpathsea. It is also available as part of MikTeX, a popular
distribution on Windows.</p>
<p><em>If the file is not found, an empty string is returned</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>filename</strong><span class="classifier">str or path-like</span></dt><dd></dd>
<dt><strong>format</strong><span class="classifier">str or bytes</span></dt><dd><p>Used as the value of the <code class="docutils literal notranslate"><span class="pre">--format</span></code> option to <strong class="program">kpsewhich</strong>.
Could be e.g. 'tfm' or 'vf' to limit the search to that type of files.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">References</p>
<table class="docutils citation" frame="void" id="ra043a4f19cd5-1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://www.tug.org/kpathsea/">Kpathsea documentation</a>
The library that <strong class="program">kpsewhich</strong> is part of.</td></tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Jul 17, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
Doc version v3.3.0-3-g8994f1b60.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.