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

History

361 lines (312 loc) · 19.1 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

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

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

<head>

<title>matplotlib.dviread — Matplotlib 1.4.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.4.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.4.0 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v1.4.0). For the latest version see <a href="https://matplotlib.org/stable/api/dviread.html">https://matplotlib.org/stable/api/dviread.html</a></div>

</map>

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

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

</ul>

</div>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</div>

</div>

<h1><a class="reference internal" href="#module-matplotlib.dviread" title="matplotlib.dviread"><tt class="xref py py-mod docutils literal">matplotlib.dviread</tt></a><a class="headerlink" href="#module-matplotlib.dviread" title="Permalink to this headline">¶</a></h1>

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.

Interface:

<div class="highlight-python"><div class="highlight"><pre>dvi = Dvi(filename, 72)

# iterate over pages (but only one page is supported for now):

for page in dvi:

w, h, d = page.width, page.height, page.descent

for x,y,font,glyph,width in page.text:

fontname = font.texname

pointsize = font.size

...

for x,y,height,width in page.boxes:

...

</pre></div>

</div>

class <tt class="descclassname">matplotlib.dviread.</tt><tt class="descname">Dvi</tt>(filename, dpi)<a class="headerlink" href="#matplotlib.dviread.Dvi" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

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.

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.

<tt class="descname">close</tt>()<a class="headerlink" href="#matplotlib.dviread.Dvi.close" title="Permalink to this definition">¶</a></dt>

<dd>Close the underlying file if it is open.

</dd></dl>

class <tt class="descclassname">matplotlib.dviread.</tt><tt class="descname">DviFont</tt>(scale, tfm, texname, vf)<a class="headerlink" href="#matplotlib.dviread.DviFont" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

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 not used for comparison.

The size is in Adobe points (converted from TeX points).

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

<dd>Name of the font as used internally by TeX and friends. This

is usually very different from any external font names, and

<tt class="xref py py-class docutils literal">dviread.PsfontsMap</tt> can be used to find the external

name of the font.

</dd></dl>

<dd>Size of the font in Adobe points, converted from the slightly

smaller TeX points.

</dd></dl>

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

<dd>Widths of glyphs in glyph-space units, typically 1/1000ths of

the point size.

</dd></dl>

<dt>

<dt>

<tt class="descname">texname</tt></dt>

<dt>

<tt class="descname">widths</tt></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.dviread.</tt><tt class="descname">Encoding</tt>(filename)<a class="headerlink" href="#matplotlib.dviread.Encoding" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

Parses a *.enc file referenced from a psfonts.map style file.

The format this class understands is a very limited subset of

PostScript.

Usage (subject to change):

<div class="highlight-python"><div class="highlight"><pre>for name in Encoding(filename):

whatever(name)

</pre></div>

</div>

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

</dd></dl>

class <tt class="descclassname">matplotlib.dviread.</tt><tt class="descname">PsfontsMap</tt>(filename)<a class="headerlink" href="#matplotlib.dviread.PsfontsMap" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

A psfonts.map formatted file, mapping TeX fonts to PS fonts.

Usage:

<div class="highlight-python"><div class="highlight"><pre>>>> map = PsfontsMap(find_tex_file('pdftex.map'))

>>> entry = map['ptmbo8r']

>>> entry.texname

'ptmbo8r'

>>> entry.psname

'Times-Bold'

>>> entry.encoding

'/usr/local/texlive/2008/texmf-dist/fonts/enc/dvips/base/8r.enc'

>>> entry.effects

{'slant': 0.16700000000000001}

>>> entry.filename

</pre></div>

</div>

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.

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.

</dd></dl>

class <tt class="descclassname">matplotlib.dviread.</tt><tt class="descname">Tfm</tt>(filename)<a class="headerlink" href="#matplotlib.dviread.Tfm" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

A TeX Font Metric file. This implementation covers only the bare

minimum needed by the Dvi class.

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

<dd>Used for verifying against the dvi file.

</dd></dl>

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

<dd>Design size of the font (in what units?)

</dd></dl>

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

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

</dd></dl>

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

<dd>Height of each character.

</dd></dl>

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

<dd>Depth of each character.

</dd></dl>

<dt>

<tt class="descname">checksum</tt></dt>

<dt>

<tt class="descname">depth</tt></dt>

<dt>

<tt class="descname">design_size</tt></dt>

<dt>

<tt class="descname">height</tt></dt>

<dt>

<tt class="descname">width</tt></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.dviread.</tt><tt class="descname">Vf</tt>(filename)<a class="headerlink" href="#matplotlib.dviread.Vf" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.dviread.Dvi" title="matplotlib.dviread.Dvi"><tt class="xref py py-class docutils literal">matplotlib.dviread.Dvi</tt></a>

A virtual font (*.vf file) containing subroutines for dvi files.

Usage:

<div class="highlight-python"><div class="highlight"><pre>vf = Vf(filename)

glyph = vf[code]

glyph.text, glyph.boxes, glyph.width

</pre></div>

</div>

</dd></dl>

<tt class="descclassname">matplotlib.dviread.</tt><tt class="descname">find_tex_file</tt>(filename, format=None)<a class="headerlink" href="#matplotlib.dviread.find_tex_file" title="Permalink to this definition">¶</a></dt>

<dd>Call kpsewhich to find a file in the texmf tree. If

format is not None, it is used as the value for the

--format option.

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)

See also

<dt><a class="reference external" href="http://www.tug.org/kpathsea/">Kpathsea documentation</a></dt>

<dd>The library that kpsewhich is part of.</dd>

</dl>

</div>

</dd></dl>

</div>

</div>

Last updated on Sep 02, 2014.

Created using <a

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

</div>

</body>

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