matplotlib.github.com/2.2.0/api/dviread.html at main · matplotlib/matplotlib.github.com

History

490 lines (448 loc) · 28.2 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>dviread — Matplotlib 2.2.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.2.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.0 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.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 style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.0</span></div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="figure_api.html" title="figure"

accesskey="N">next</a> |</li>

<a href="dates_api.html" title="dates"

accesskey="P">previous</a> |</li>

<li><a href="../gallery/index.html">examples</a>| </li>

<li><a href="../tutorials/index.html">tutorials</a>| </li>

<li><a href="pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<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 notranslate"><span class="pre">matplotlib.dviread</span></code></a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">The Matplotlib API</a><ul>

<li>Previous: <a href="dates_api.html" title="previous chapter">dates</a></li>

<li>Next: <a href="figure_api.html" title="next chapter">figure</a></li>

</ul></li>

</ul>

</div>

<li><a href="../_sources/api/dviread.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1>dviread<a class="headerlink" href="#dviread" title="Permalink to this headline">¶</a></h1>

<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 notranslate"><span class="pre">matplotlib.dviread</span></code></a><a class="headerlink" href="#module-matplotlib.dviread" title="Permalink to this headline">¶</a></h2>

<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="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="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>

</pre></div>

</div>

<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: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.6)"><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="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="n">unichr</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>

<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>

<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>

<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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>scale</strong> : float</p>

<div><p>Factor by which the font is scaled from its natural size.</p>

</div></blockquote>

<div><p>TeX font metrics for this font</p>

</div></blockquote>

<p><strong>texname</strong> : bytes</p>

<div><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>

</div></blockquote>

<div><p>A TeX “virtual font” file, or None if this font is not virtual.</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

<p class="rubric">Attributes</p>

</colgroup>

<tr class="row-odd"><td><strong>texname</strong></td>

<td>(bytes)</td>

</tr>

<td>(float) Size of the font in Adobe points, converted from the slightly smaller TeX points.</td>

</tr>

<tr class="row-odd"><td><strong>widths</strong></td>

<td>(list) Widths of glyphs in glyph-space units, typically 1/1000ths of the point size.</td>

</tr>

</tbody>

</table>

<code class="descname">texname</code><a class="headerlink" href="#matplotlib.dviread.DviFont.texname" title="Permalink to this definition">¶</a></dt>

<code class="descname">widths</code><a class="headerlink" href="#matplotlib.dviread.DviFont.widths" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<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>

<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-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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> : string or bytestring</td>

</tr>

</tbody>

</table>

<p class="rubric">Attributes</p>

</colgroup>

<tr class="row-odd"><td><strong>encoding</strong></td>

<td>(list) List of character names</td>

</tr>

</tbody>

</table>

<code class="descname">encoding</code><a class="headerlink" href="#matplotlib.dviread.Encoding.encoding" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<code class="descclassname">matplotlib.dviread.</code><code class="descname">PsFont</code><a class="headerlink" href="#matplotlib.dviread.PsFont" title="Permalink to this definition">¶</a></dt>

<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.dviread.Font</span></code></p>

</dd></dl>

<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>

<p>A psfonts.map formatted file, mapping TeX fonts to PS fonts.</p>

<p>Usage:</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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> : string or bytestring</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>

</dd></dl>

<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>

<p>A TeX Font Metric file.</p>

<p>This implementation covers only the bare minimum needed by the Dvi class.</p>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> : string or bytestring</td>

</tr>

</tbody>

</table>

<p class="rubric">Attributes</p>

</colgroup>

<tr class="row-odd"><td><strong>checksum</strong></td>

<td>(int) Used for verifying against the dvi file.</td>

</tr>

<tr class="row-even"><td><strong>design_size</strong></td>

<td>(int) Design size of the font (unknown units)</td>

</tr>

<tr class="row-odd"><td><strong>width, height, depth</strong></td>

<td>(dict) 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.</td>

</tr>

</tbody>

</table>

<code class="descname">checksum</code><a class="headerlink" href="#matplotlib.dviread.Tfm.checksum" title="Permalink to this definition">¶</a></dt>

<code class="descname">depth</code><a class="headerlink" href="#matplotlib.dviread.Tfm.depth" title="Permalink to this definition">¶</a></dt>

<code class="descname">design_size</code><a class="headerlink" href="#matplotlib.dviread.Tfm.design_size" title="Permalink to this definition">¶</a></dt>

<code class="descname">height</code><a class="headerlink" href="#matplotlib.dviread.Tfm.height" title="Permalink to this definition">¶</a></dt>

<code class="descname">width</code><a class="headerlink" href="#matplotlib.dviread.Tfm.width" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<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 notranslate"><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-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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> : string or bytestring</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>

</dd></dl>

<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>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="#r2" id="id1">[R2]</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>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>filename</strong> : string or bytestring</p>

<p><strong>format</strong> : string or bytestring</p>

<div><p>Used as the value of the <code class="xref py py-obj 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>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

<p class="rubric">References</p>

<tr><td class="label">[R2]</td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>)</em> <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>

<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>

</div>

</div>

Last updated on Mar 06, 2018.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.7.1.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

dviread.html

Latest commit

History

dviread.html

File metadata and controls