{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathdviread.html
More file actions
401 lines (348 loc) · 21.1 KB
/
Copy pathdviread.html
File metadata and controls
401 lines (348 loc) · 21.1 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
<!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="Content-Type" content="text/html; charset=utf-8" />
<title>dviread — Matplotlib 1.5.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.5.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.5.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="figure" href="figure_api.html" />
<link rel="prev" title="dates" href="dates_api.html" />
<link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
<link rel="canonical" href="https://matplotlib.org/stable/api/dviread.html" />
<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 (v1.5.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 class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h3>We're updating the default styles for Matplotlib 2.0</h3>
<p>Learn what to expect in the <a href="/style_changes.html" style="font-weight: bold;
color: #11557C;">new updates</a></p>
</div>
<link rel="shortcut icon" href="/_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<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="figure"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dates_api.html" title="dates"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">dviread</a><ul>
<li><a class="reference internal" href="#module-matplotlib.dviread"><code class="docutils literal"><span class="pre">matplotlib.dviread</span></code></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="dates_api.html"
title="previous chapter">dates</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="figure_api.html"
title="next chapter">figure</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/dviread.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="dviread">
<h1>dviread<a class="headerlink" href="#dviread" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.dviread">
<span id="matplotlib-dviread"></span><h2><a class="reference internal" href="#module-matplotlib.dviread" title="matplotlib.dviread"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.dviread</span></code></a><a class="headerlink" href="#module-matplotlib.dviread" title="Permalink to this headline">¶</a></h2>
<p>An experimental 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-python"><div class="highlight"><pre><span class="n">dvi</span> <span class="o">=</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="c"># iterate over pages (but only one page is supported for now):</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="headerlink" href="#matplotlib.dviread.Dvi" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A dvi (“device-independent”) file, as produced by TeX.
The current implementation only reads the first page and does not
even attempt to verify the postamble.</p>
<p>Initialize the object. This takes the filename as input and
opens the file; actually reading the file happens when
iterating through the pages of the file.</p>
<dl class="method">
<dt id="matplotlib.dviread.Dvi.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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="headerlink" href="#matplotlib.dviread.DviFont" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Object that 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>
<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><p>Name of the font as used internally by TeX and friends. This
is usually very different from any external font names, and
<code class="xref py py-class docutils literal"><span class="pre">dviread.PsfontsMap</span></code> can be used to find the external
name of the font.</p>
</dd></dl>
<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><p>Size of the font in Adobe points, converted from the slightly
smaller TeX points.</p>
</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><p>Widths of glyphs in glyph-space units, typically 1/1000ths of
the point size.</p>
</dd></dl>
<dl class="attribute">
<dt>
<code class="descname">size</code></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<code class="descname">texname</code></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<code class="descname">widths</code></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="headerlink" href="#matplotlib.dviread.Encoding" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Parses a *.enc file referenced from a psfonts.map style file.
The format this class understands is a very limited subset of
PostScript.</p>
<p>Usage (subject to change):</p>
<div class="highlight-python"><div class="highlight"><pre><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>
<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.PsfontsMap">
<em class="property">class </em><code class="descclassname">matplotlib.dviread.</code><code class="descname">PsfontsMap</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dviread.PsfontsMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A psfonts.map formatted file, mapping TeX fonts to PS fonts.
Usage:</p>
<div class="highlight-python"><div class="highlight"><pre><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="s">'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="s">'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">'ptmbo8r'</span>
<span class="gp">>>> </span><span class="n">entry</span><span class="o">.</span><span class="n">psname</span>
<span class="go">'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>
<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.
psfonts.map, pdftex.map, dvipdfm.map. psfonts.map is used by
dvips, pdftex.map by pdfTeX, and dvipdfm.map by dvipdfm.
psfonts.map 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>
</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="headerlink" href="#matplotlib.dviread.Tfm" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A TeX Font Metric file. This implementation covers only the bare
minimum needed by the Dvi class.</p>
<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><p>Used for verifying against the dvi file.</p>
</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><p>Design size of the font (in what units?)</p>
</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><p>Width of each character, needs to be scaled by the factor
specified in the dvi file. This is a dict because indexing may
not start from 0.</p>
</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><p>Height of each character.</p>
</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><p>Depth of each character.</p>
</dd></dl>
<dl class="attribute">
<dt>
<code class="descname">checksum</code></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<code class="descname">depth</code></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<code class="descname">design_size</code></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<code class="descname">height</code></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<code class="descname">width</code></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="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"><span class="pre">matplotlib.dviread.Dvi</span></code></a></p>
<p>A virtual font (*.vf file) containing subroutines for dvi files.</p>
<p>Usage:</p>
<div class="highlight-python"><div class="highlight"><pre><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>
</dd></dl>
<dl class="function">
<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="headerlink" href="#matplotlib.dviread.find_tex_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Call <strong class="program">kpsewhich</strong> to find a file in the texmf tree. If
<em>format</em> is not None, it is used as the value for the
<code class="xref std std-option docutils literal"><span class="pre">--format</span></code> option.</p>
<p>Apparently most existing TeX distributions on Unix-like systems
use kpathsea. I hear MikTeX (a popular distribution on Windows)
doesn’t use kpathsea, so what do we do? (TODO)</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference external" href="http://www.tug.org/kpathsea/">Kpathsea documentation</a></dt>
<dd>The library that <strong class="program">kpsewhich</strong> is part of.</dd>
</dl>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dviread.ord">
<code class="descclassname">matplotlib.dviread.</code><code class="descname">ord</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dviread.ord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team; 2012 - 2014 The matplotlib development team.
Last updated on Oct 29, 2015.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
</html>
You can’t perform that action at this time.