matplotlib.github.com/_modules/matplotlib/textpath.html at master · pjastr/matplotlib.github.com

History

681 lines (543 loc) · 74.9 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

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

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

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

<head>

<title>matplotlib.textpath — Matplotlib 3.1.0 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.0 documentation"

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

</head>

<body>

The 2019 SciPy John Hunter Excellence in Plotting Contest is accepting submissions!

<a href="https://docs.google.com/forms/d/e/1FAIpQLSe-_AnKvYSzeQWfNDRoXgW0vl7_8q6jj3QbLIac8eUcb9lSAA/viewform?usp=sf_link" style="font-weight: bold;">Apply by June 8th</a>

</div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.1.0</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>

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

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

<li><a href="../../contents.html">contents</a> »</li>

<li><a href="../index.html" >Module code</a> »</li>

<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3>Related Topics</h3>

<ul>

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

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.textpath</h1><div class="highlight"><pre>

from collections import OrderedDict

import functools

import logging

import urllib.parse

import numpy as np

from matplotlib import cbook, dviread, font_manager, rcParams

from matplotlib.font_manager import FontProperties, get_font

from matplotlib.ft2font import (

KERNING_DEFAULT, LOAD_NO_HINTING, LOAD_TARGET_LIGHT)

from matplotlib.mathtext import MathTextParser

from matplotlib.path import Path

from matplotlib.transforms import Affine2D

_log = logging.getLogger(__name__)

<div class="viewcode-block" id="TextToPath"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath">[docs]</a>class TextToPath(object):

"""A class that converts strings to paths."""

FONT_SCALE = 100.

DPI = 72

def __init__(self):

self.mathtext_parser = MathTextParser('path')

self._texmanager = None

@property

@cbook.deprecated("3.0")

def tex_font_map(self):

return dviread.PsfontsMap(dviread.find_tex_file('pdftex.map'))

def _get_font(self, prop):

"""

Find the `FT2Font` matching font properties *prop*, with its size set.

"""

fname = font_manager.findfont(prop)

font = get_font(fname)

font.set_size(self.FONT_SCALE, self.DPI)

return font

def _get_hinting_flag(self):

return LOAD_NO_HINTING

def _get_char_id(self, font, ccode):

"""

Return a unique id for the given font and character-code set.

"""

return urllib.parse.quote('{}-{}'.format(font.postscript_name, ccode))

def _get_char_id_ps(self, font, ccode):

"""

Return a unique id for the given font and character-code set (for tex).

"""

ps_name = font.get_ps_font_info()[2]

char_id = urllib.parse.quote('%s-%d' % (ps_name, ccode))

return char_id

<div class="viewcode-block" id="TextToPath.glyph_to_path"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath.glyph_to_path">[docs]</a> @cbook.deprecated(

"3.1",

alternative="font.get_path() and manual translation of the vertices")

def glyph_to_path(self, font, currx=0.):

"""Convert the *font*'s current glyph to a (vertices, codes) pair."""

verts, codes = font.get_path()

if currx != 0.0:

verts[:, 0] += currx

return verts, codes</div>

<div class="viewcode-block" id="TextToPath.get_text_width_height_descent"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath.get_text_width_height_descent">[docs]</a> def get_text_width_height_descent(self, s, prop, ismath):

if rcParams['text.usetex']:

texmanager = self.get_texmanager()

fontsize = prop.get_size_in_points()

w, h, d = texmanager.get_text_width_height_descent(s, fontsize,

renderer=None)

return w, h, d

fontsize = prop.get_size_in_points()

scale = fontsize / self.FONT_SCALE

if ismath:

prop = prop.copy()

prop.set_size(self.FONT_SCALE)

self.mathtext_parser.parse(s, 72, prop)

return width * scale, height * scale, descent * scale

font = self._get_font(prop)

font.set_text(s, 0.0, flags=LOAD_NO_HINTING)

w, h = font.get_width_height()

w /= 64.0 # convert from subpixels

h /= 64.0

d = font.get_descent()

d /= 64.0

return w * scale, h * scale, d * scale</div>

<div class="viewcode-block" id="TextToPath.get_text_path"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath.get_text_path">[docs]</a> @cbook._delete_parameter("3.1", "usetex")

def get_text_path(self, prop, s, ismath=False, usetex=False):

"""

Convert text *s* to path (a tuple of vertices and codes for

matplotlib.path.Path).

Parameters

----------

prop : `matplotlib.font_manager.FontProperties` instance

The font properties for the text.

s : str

The text to be converted.

ismath : {False, True, "TeX"}

If True, use mathtext parser. If "TeX", use tex for renderering.

usetex : bool, optional

If set, forces *ismath* to True. This parameter is deprecated.

Returns

-------

verts, codes : tuple of lists

*verts* is a list of numpy arrays containing the x and y

coordinates of the vertices. *codes* is a list of path codes.

Examples

--------

Create a list of vertices and codes from a text, and create a `Path`

from those::

from matplotlib.path import Path

from matplotlib.textpath import TextToPath

from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Humor Sans", style="italic")

verts, codes = TextToPath().get_text_path(fp, "ABC")

path = Path(verts, codes, closed=False)

Also see `TextPath` for a more direct way to create a path from a text.

"""

if usetex:

ismath = "TeX"

if ismath == "TeX":

glyph_info, glyph_map, rects = self.get_glyphs_tex(prop, s)

elif not ismath:

glyph_info, glyph_map, rects = self.get_glyphs_with_font(font, s)

else:

glyph_info, glyph_map, rects = self.get_glyphs_mathtext(prop, s)

verts, codes = [], []

for glyph_id, xposition, yposition, scale in glyph_info:

verts1, codes1 = glyph_map[glyph_id]

if len(verts1):

verts1 = np.array(verts1) * scale + [xposition, yposition]

verts.extend(verts1)

codes.extend(codes1)

for verts1, codes1 in rects:

verts.extend(verts1)

codes.extend(codes1)

return verts, codes</div>

<div class="viewcode-block" id="TextToPath.get_glyphs_with_font"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath.get_glyphs_with_font">[docs]</a> def get_glyphs_with_font(self, font, s, glyph_map=None,

return_new_glyphs_only=False):

"""

Convert string *s* to vertices and codes using the provided ttf font.

"""

# Mostly copied from backend_svg.py.

lastgind = None

currx = 0

xpositions = []

glyph_ids = []

if glyph_map is None:

glyph_map = OrderedDict()

if return_new_glyphs_only:

glyph_map_new = OrderedDict()

else:

glyph_map_new = glyph_map

# I'm not sure if I get kernings right. Needs to be verified. -JJL

for c in s:

ccode = ord(c)

gind = font.get_char_index(ccode)

if gind is None:

ccode = ord('?')

gind = 0

if lastgind is not None:

kern = font.get_kerning(lastgind, gind, KERNING_DEFAULT)

else:

kern = 0

glyph = font.load_char(ccode, flags=LOAD_NO_HINTING)

horiz_advance = glyph.linearHoriAdvance / 65536

char_id = self._get_char_id(font, ccode)

if char_id not in glyph_map:

glyph_map_new[char_id] = font.get_path()

currx += kern / 64

xpositions.append(currx)

glyph_ids.append(char_id)

currx += horiz_advance

lastgind = gind

ypositions = [0] * len(xpositions)

sizes = [1.] * len(xpositions)

rects = []

return (list(zip(glyph_ids, xpositions, ypositions, sizes)),

glyph_map_new, rects)</div>

<div class="viewcode-block" id="TextToPath.get_glyphs_mathtext"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath.get_glyphs_mathtext">[docs]</a> def get_glyphs_mathtext(self, prop, s, glyph_map=None,

return_new_glyphs_only=False):

"""

Parse mathtext string *s* and convert it to a (vertices, codes) pair.

"""

prop = prop.copy()

width, height, descent, glyphs, rects = self.mathtext_parser.parse(

s, self.DPI, prop)

if not glyph_map:

glyph_map = OrderedDict()

if return_new_glyphs_only:

glyph_map_new = OrderedDict()

else:

glyph_map_new = glyph_map

xpositions = []

ypositions = []

glyph_ids = []

sizes = []

for font, fontsize, ccode, ox, oy in glyphs:

if char_id not in glyph_map:

font.clear()

xpositions.append(ox)

ypositions.append(oy)

glyph_ids.append(char_id)

size = fontsize / self.FONT_SCALE

sizes.append(size)

myrects = []

for ox, oy, w, h in rects:

vert1 = [(ox, oy), (ox, oy + h), (ox + w, oy + h),

(ox + w, oy), (ox, oy), (0, 0)]

code1 = [Path.MOVETO,

Path.LINETO, Path.LINETO, Path.LINETO, Path.LINETO,

Path.CLOSEPOLY]

myrects.append((vert1, code1))

glyph_map_new, myrects)</div>

<div class="viewcode-block" id="TextToPath.get_texmanager"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath.get_texmanager">[docs]</a> def get_texmanager(self):

"""Return the cached `~.texmanager.TexManager` instance."""

if self._texmanager is None:

from matplotlib.texmanager import TexManager

self._texmanager = TexManager()

return self._texmanager</div>

<div class="viewcode-block" id="TextToPath.get_glyphs_tex"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextToPath.get_glyphs_tex">[docs]</a> def get_glyphs_tex(self, prop, s, glyph_map=None,

return_new_glyphs_only=False):

"""Convert the string *s* to vertices and codes using usetex mode."""

# Mostly borrowed from pdf backend.

dvifile = self.get_texmanager().make_dvi(s, self.FONT_SCALE)

with dviread.Dvi(dvifile, self.DPI) as dvi:

page, = dvi

if glyph_map is None:

glyph_map = OrderedDict()

if return_new_glyphs_only:

glyph_map_new = OrderedDict()

else:

glyph_map_new = glyph_map

glyph_ids, xpositions, ypositions, sizes = [], [], [], []

# Gather font information and do some setup for combining

# characters into strings.

for x1, y1, dvifont, glyph, width in page.text:

font, enc = self._get_ps_font_and_encoding(dvifont.texname)

char_id = self._get_char_id_ps(font, glyph)

if char_id not in glyph_map:

font.clear()

# See comments in _get_ps_font_and_encoding.

if enc is not None:

index = font.get_name_index(enc[glyph])

font.load_glyph(index, flags=LOAD_TARGET_LIGHT)

else:

font.load_char(glyph, flags=LOAD_TARGET_LIGHT)

glyph_ids.append(char_id)

xpositions.append(x1)

ypositions.append(y1)

sizes.append(dvifont.size / self.FONT_SCALE)

myrects = []

for ox, oy, h, w in page.boxes:

vert1 = [(ox, oy), (ox + w, oy), (ox + w, oy + h),

(ox, oy + h), (ox, oy), (0, 0)]

code1 = [Path.MOVETO,

Path.CLOSEPOLY]

glyph_map_new, myrects)</div>

@staticmethod

@functools.lru_cache(50)

def _get_ps_font_and_encoding(texname):

tex_font_map = dviread.PsfontsMap(dviread.find_tex_file('pdftex.map'))

font_bunch = tex_font_map[texname]

if font_bunch.filename is None:

raise ValueError(

f"No usable font file found for {font_bunch.psname} "

f"({texname}). The font may lack a Type-1 version.")

font = get_font(font_bunch.filename)

if font_bunch.encoding:

# If psfonts.map specifies an encoding, use it: it gives us a

# mapping of glyph indices to Adobe glyph names; use it to convert

# dvi indices to glyph names and use the FreeType-synthesized

# unicode charmap to convert glyph names to glyph indices (with

# FT_Get_Name_Index/get_name_index), and load the glyph using

# FT_Load_Glyph/load_glyph. (That charmap has a coverage at least

# as good as, and possibly better than, the native charmaps.)

enc = dviread._parse_enc(font_bunch.encoding)

else:

# If psfonts.map specifies no encoding, the indices directly

# map to the font's "native" charmap; so don't use the

# FreeType-synthesized charmap but the native ones (we can't

# directly identify it but it's typically an Adobe charmap), and

# directly load the dvi glyph indices using FT_Load_Char/load_char.

for charmap_name, charmap_code in [

("ADOBE_CUSTOM", 1094992451),

("ADOBE_STANDARD", 1094995778),

]:

try:

font.select_charmap(charmap_code)

except (ValueError, RuntimeError):

pass

else:

break

else:

charmap_name = ""

_log.warning("No supported encoding in font (%s).",

font_bunch.filename)

enc = None

return font, enc</div>

text_to_path = TextToPath()

<div class="viewcode-block" id="TextPath"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextPath">[docs]</a>class TextPath(Path):

"""

Create a path from the text.

"""

def __init__(self, xy, s, size=None, prop=None,

_interpolation_steps=1, usetex=False,

*args, **kwargs):

r"""

Create a path from the text. Note that it simply is a path,

not an artist. You need to use the `~.PathPatch` (or other artists)

to draw this path onto the canvas.

Parameters

----------

xy : tuple or array of two float values

Position of the text. For no offset, use ``xy=(0, 0)``.

s : str

The text to convert to a path.

size : float, optional

Font size in points. Defaults to the size specified via the font

properties *prop*.

prop : `matplotlib.font_manager.FontProperties`, optional

Font property. If not provided, will use a default

``FontProperties`` with parameters from the

:ref:`rcParams <matplotlib-rcparams>`.

_interpolation_steps : integer, optional

(Currently ignored)

usetex : bool, optional

Whether to use tex rendering. Defaults to ``False``.

Examples

--------

The following creates a path from the string "ABC" with Helvetica

font face; and another path from the latex fraction 1/2::

from matplotlib.textpath import TextPath

from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Helvetica", style="italic")

path1 = TextPath((12,12), "ABC", size=12, prop=fp)

path2 = TextPath((0,0), r"$\frac{1}{2}$", size=12, usetex=True)

Also see :doc:`/gallery/text_labels_and_annotations/demo_text_path`.

"""

# Circular import.

from matplotlib.text import Text

if args or kwargs:

cbook.warn_deprecated(

"3.1", message="Additional arguments to TextPath used to be "

"ignored, but will trigger a TypeError %(removal)s.")

if prop is None:

prop = FontProperties()

if size is None:

size = prop.get_size_in_points()

self._xy = xy

self.set_size(size)

self._cached_vertices = None

s, ismath = Text(usetex=usetex)._preprocess_math(s)

self._vertices, self._codes = text_to_path.get_text_path(

prop, s, ismath=ismath)

self._should_simplify = False

self._simplify_threshold = rcParams['path.simplify_threshold']

self._interpolation_steps = _interpolation_steps

<div class="viewcode-block" id="TextPath.set_size"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextPath.set_size">[docs]</a> def set_size(self, size):

"""Set the text size."""

self._size = size

self._invalid = True</div>

<div class="viewcode-block" id="TextPath.get_size"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextPath.get_size">[docs]</a> def get_size(self):

"""Get the text size."""

return self._size</div>

@property

def vertices(self):

"""

Return the cached path after updating it if necessary.

"""

self._revalidate_path()

return self._cached_vertices

@property

def codes(self):

"""

Return the codes

"""

return self._codes

def _revalidate_path(self):

"""

Update the path if necessary.

The path for the text is initially create with the font size of

`~.FONT_SCALE`, and this path is rescaled to other size when necessary.

"""

if self._invalid or self._cached_vertices is None:

tr = Affine2D().scale(

self._size / text_to_path.FONT_SCALE).translate(*self._xy)

self._cached_vertices = tr.transform(self._vertices)

self._invalid = False

<div class="viewcode-block" id="TextPath.is_math_text"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextPath.is_math_text">[docs]</a> @cbook.deprecated("3.1")

def is_math_text(self, s):

"""

Returns True if the given string *s* contains any mathtext.

"""

# copied from Text.is_math_text -JJL

# Did we find an even number of non-escaped dollar signs?

# If so, treat is as math text.

dollar_count = s.count(r'$') - s.count(r'\$')

even_dollars = (dollar_count > 0 and dollar_count % 2 == 0)

if rcParams['text.usetex']:

return s, 'TeX'

if even_dollars:

return s, True

else:

return s.replace(r'\$', '$'), False</div>

<div class="viewcode-block" id="TextPath.text_get_vertices_codes"><a class="viewcode-back" href="../../api/textpath_api.html#matplotlib.textpath.TextPath.text_get_vertices_codes">[docs]</a> @cbook.deprecated("3.1", alternative="TextPath")

def text_get_vertices_codes(self, prop, s, usetex):

"""

Convert string *s* to a (vertices, codes) pair using font property

*prop*.

"""

# Mostly copied from backend_svg.py.

if usetex:

return text_to_path.get_text_path(prop, s, usetex=True)

else:

clean_line, ismath = self.is_math_text(s)

return text_to_path.get_text_path(prop, clean_line, ismath=ismath)</div></div>

</pre></div>

</div>

</div>

Last updated on May 18, 2019.

Created using

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

Doc version v3.1.0-4-g0078324e4.

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

textpath.html

Latest commit

History

textpath.html

File metadata and controls