matplotlib.github.com/3.2.0/_modules/matplotlib/mathtext.html at main · ACPMAD/matplotlib.github.com

History

3633 lines (3076 loc) · 544 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

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

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

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

<head>

<title>matplotlib.mathtext — Matplotlib 3.2.0 documentation</title>

title="Search within Matplotlib 3.2.0 documentation"

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

</head><body>

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

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.2.0</div>

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

</div>

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

</form>

</li>

</ul>

</nav>

<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="../../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</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.mathtext</h1><div class="highlight"><pre>

r"""

:mod:`~matplotlib.mathtext` is a module for parsing a subset of the

TeX math syntax and drawing them to a matplotlib backend.

For a tutorial of its usage see :doc:`/tutorials/text/mathtext`. This

document is primarily concerned with implementation details.

The module uses pyparsing_ to parse the TeX expression.

.. _pyparsing: http://pyparsing.wikispaces.com/

The Bakoma distribution of the TeX Computer Modern fonts, and STIX

fonts are supported. There is experimental support for using

arbitrary fonts, but results may vary without proper tweaking and

metrics for those fonts.

"""

from collections import namedtuple

import functools

from io import StringIO

import logging

import os

import types

import unicodedata

import numpy as np

from pyparsing import (

Combine, Empty, FollowedBy, Forward, Group, Literal, oneOf, OneOrMore,

Optional, ParseBaseException, ParseFatalException, ParserElement,

QuotedString, Regex, StringEnd, Suppress, ZeroOrMore)

from matplotlib import cbook, colors as mcolors, rcParams

from matplotlib.afm import AFM

from matplotlib.cbook import get_realpath_and_stat

from matplotlib.ft2font import FT2Image, KERNING_DEFAULT, LOAD_NO_HINTING

from matplotlib.font_manager import findfont, FontProperties, get_font

from matplotlib._mathtext_data import (latex_to_bakoma, latex_to_standard,

tex2uni, latex_to_cmex,

stix_virtual_fonts)

ParserElement.enablePackrat()

_log = logging.getLogger(__name__)

##############################################################################

# FONTS

<div class="viewcode-block" id="get_unicode_index"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.get_unicode_index">[docs]</a>def get_unicode_index(symbol, math=True):

r"""

Return the integer index (from the Unicode table) of *symbol*.

Parameters

----------

symbol : str

A single unicode character, a TeX command (e.g. r'\pi') or a Type1

symbol name (e.g. 'phi').

math : bool, default is True

If False, always treat as a single unicode character.

"""

# for a non-math symbol, simply return its unicode index

if not math:

return ord(symbol)

# From UTF #25: U+2212 minus sign is the preferred

# representation of the unary and binary minus sign rather than

# the ASCII-derived U+002D hyphen-minus, because minus sign is

# unambiguous and because it is rendered with a more desirable

# length, usually longer than a hyphen.

if symbol == '-':

return 0x2212

try: # This will succeed if symbol is a single unicode char

return ord(symbol)

except TypeError:

pass

try: # Is symbol a TeX symbol (i.e. \alpha)

return tex2uni[symbol.strip("\\")]

except KeyError:

raise ValueError(

"'{}' is not a valid Unicode character or TeX/Type1 symbol"

.format(symbol))</div>

<div class="viewcode-block" id="MathtextBackend"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackend">[docs]</a>class MathtextBackend:

"""

The base class for the mathtext backend-specific code. The

purpose of :class:`MathtextBackend` subclasses is to interface

between mathtext and a specific matplotlib graphics backend.

Subclasses need to override the following:

- :meth:`render_glyph`

- :meth:`render_rect_filled`

- :meth:`get_results`

And optionally, if you need to use a FreeType hinting style:

- :meth:`get_hinting_type`

"""

def __init__(self):

self.width = 0

self.height = 0

self.depth = 0

<div class="viewcode-block" id="MathtextBackend.set_canvas_size"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackend.set_canvas_size">[docs]</a> def set_canvas_size(self, w, h, d):

'Dimension the drawing canvas'

self.width = w

self.height = h

self.depth = d</div>

<div class="viewcode-block" id="MathtextBackend.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackend.render_glyph">[docs]</a> def render_glyph(self, ox, oy, info):

"""

Draw a glyph described by *info* to the reference point (*ox*,

*oy*).

"""

raise NotImplementedError()</div>

<div class="viewcode-block" id="MathtextBackend.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackend.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

"""

Draw a filled black rectangle from (*x1*, *y1*) to (*x2*, *y2*).

"""

raise NotImplementedError()</div>

<div class="viewcode-block" id="MathtextBackend.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackend.get_results">[docs]</a> def get_results(self, box):

"""

Return a backend-specific tuple to return to the backend after

all processing is done.

"""

raise NotImplementedError()</div>

<div class="viewcode-block" id="MathtextBackend.get_hinting_type"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackend.get_hinting_type">[docs]</a> def get_hinting_type(self):

"""

Get the FreeType hinting type to use with this particular

backend.

"""

return LOAD_NO_HINTING</div></div>

<div class="viewcode-block" id="MathtextBackendAgg"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendAgg">[docs]</a>class MathtextBackendAgg(MathtextBackend):

"""

Render glyphs and rectangles to an FTImage buffer, which is later

transferred to the Agg image by the Agg backend.

"""

def __init__(self):

self.ox = 0

self.oy = 0

self.image = None

self.mode = 'bbox'

self.bbox = [0, 0, 0, 0]

MathtextBackend.__init__(self)

def _update_bbox(self, x1, y1, x2, y2):

self.bbox = [min(self.bbox[0], x1),

min(self.bbox[1], y1),

max(self.bbox[2], x2),

max(self.bbox[3], y2)]

<div class="viewcode-block" id="MathtextBackendAgg.set_canvas_size"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendAgg.set_canvas_size">[docs]</a> def set_canvas_size(self, w, h, d):

MathtextBackend.set_canvas_size(self, w, h, d)

if self.mode != 'bbox':

self.image = FT2Image(np.ceil(w), np.ceil(h + max(d, 0)))</div>

<div class="viewcode-block" id="MathtextBackendAgg.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendAgg.render_glyph">[docs]</a> def render_glyph(self, ox, oy, info):

if self.mode == 'bbox':

self._update_bbox(ox + info.metrics.xmin,

oy - info.metrics.ymax,

ox + info.metrics.xmax,

else:

info.font.draw_glyph_to_bitmap(

self.image, ox, oy - info.metrics.iceberg, info.glyph,

antialiased=rcParams['text.antialiased'])</div>

<div class="viewcode-block" id="MathtextBackendAgg.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendAgg.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

if self.mode == 'bbox':

self._update_bbox(x1, y1, x2, y2)

else:

height = max(int(y2 - y1) - 1, 0)

if height == 0:

center = (y2 + y1) / 2.0

y = int(center - (height + 1) / 2.0)

else:

y = int(y1)

self.image.draw_rect_filled(int(x1), y, np.ceil(x2), y + height)</div>

<div class="viewcode-block" id="MathtextBackendAgg.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendAgg.get_results">[docs]</a> def get_results(self, box, used_characters):

self.mode = 'bbox'

orig_height = box.height

orig_depth = box.depth

ship(0, 0, box)

bbox = self.bbox

bbox = [bbox[0] - 1, bbox[1] - 1, bbox[2] + 1, bbox[3] + 1]

self.mode = 'render'

self.set_canvas_size(

bbox[2] - bbox[0],

(bbox[3] - bbox[1]) - orig_depth,

ship(-bbox[0], -bbox[1], box)

result = (self.ox,

self.oy,

self.width,

self.height + self.depth,

self.depth,

self.image,

used_characters)

self.image = None

return result</div>

<div class="viewcode-block" id="MathtextBackendAgg.get_hinting_type"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendAgg.get_hinting_type">[docs]</a> def get_hinting_type(self):

from matplotlib.backends import backend_agg

return backend_agg.get_hinting_flag()</div></div>

<div class="viewcode-block" id="MathtextBackendBitmap"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendBitmap">[docs]</a>class MathtextBackendBitmap(MathtextBackendAgg):

<div class="viewcode-block" id="MathtextBackendBitmap.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendBitmap.get_results">[docs]</a> def get_results(self, box, used_characters):

ox, oy, width, height, depth, image, characters = \

MathtextBackendAgg.get_results(self, box, used_characters)

return image, depth</div></div>

<div class="viewcode-block" id="MathtextBackendPs"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPs">[docs]</a>class MathtextBackendPs(MathtextBackend):

"""

Store information to write a mathtext rendering to the PostScript backend.

"""

_PSResult = namedtuple(

"_PSResult", "width height depth pswriter used_characters")

def __init__(self):

self.pswriter = StringIO()

self.lastfont = None

<div class="viewcode-block" id="MathtextBackendPs.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPs.render_glyph">[docs]</a> def render_glyph(self, ox, oy, info):

oy = self.height - oy + info.offset

postscript_name = info.postscript_name

fontsize = info.fontsize

symbol_name = info.symbol_name

if (postscript_name, fontsize) != self.lastfont:

self.lastfont = postscript_name, fontsize

self.pswriter.write(

f"/{postscript_name} findfont\n"

f"{fontsize} scalefont\n"

f"setfont\n")

self.pswriter.write(

f"{ox:f} {oy:f} moveto\n"

f"/{symbol_name} glyphshow\n")</div>

<div class="viewcode-block" id="MathtextBackendPs.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPs.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

ps = "%f %f %f %f rectfill\n" % (

x1, self.height - y2, x2 - x1, y2 - y1)

self.pswriter.write(ps)</div>

<div class="viewcode-block" id="MathtextBackendPs.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPs.get_results">[docs]</a> def get_results(self, box, used_characters):

return self._PSResult(self.width,

self.depth,

self.pswriter,

used_characters)</div></div>

<div class="viewcode-block" id="MathtextBackendPdf"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPdf">[docs]</a>class MathtextBackendPdf(MathtextBackend):

"""Store information to write a mathtext rendering to the PDF backend."""

_PDFResult = namedtuple(

"_PDFResult", "width height depth glyphs rects used_characters")

def __init__(self):

self.glyphs = []

self.rects = []

<div class="viewcode-block" id="MathtextBackendPdf.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPdf.render_glyph">[docs]</a> def render_glyph(self, ox, oy, info):

filename = info.font.fname

self.glyphs.append(

(ox, oy, filename, info.fontsize,

info.num, info.symbol_name))</div>

<div class="viewcode-block" id="MathtextBackendPdf.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPdf.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

self.rects.append((x1, self.height - y2, x2 - x1, y2 - y1))</div>

<div class="viewcode-block" id="MathtextBackendPdf.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPdf.get_results">[docs]</a> def get_results(self, box, used_characters):

return self._PDFResult(self.width,

self.depth,

self.glyphs,

self.rects,

used_characters)</div></div>

<div class="viewcode-block" id="MathtextBackendSvg"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendSvg">[docs]</a>class MathtextBackendSvg(MathtextBackend):

"""

Store information to write a mathtext rendering to the SVG

backend.

"""

def __init__(self):

self.svg_glyphs = []

self.svg_rects = []

<div class="viewcode-block" id="MathtextBackendSvg.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendSvg.render_glyph">[docs]</a> def render_glyph(self, ox, oy, info):

self.svg_glyphs.append(

(info.font, info.fontsize, info.num, ox, oy, info.metrics))</div>

<div class="viewcode-block" id="MathtextBackendSvg.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendSvg.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

self.svg_rects.append(

(x1, self.height - y1 + 1, x2 - x1, y2 - y1))</div>

<div class="viewcode-block" id="MathtextBackendSvg.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendSvg.get_results">[docs]</a> def get_results(self, box, used_characters):

svg_elements = types.SimpleNamespace(svg_glyphs=self.svg_glyphs,

svg_rects=self.svg_rects)

return (self.width,

self.depth,

svg_elements,

used_characters)</div></div>

<div class="viewcode-block" id="MathtextBackendPath"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPath">[docs]</a>class MathtextBackendPath(MathtextBackend):

"""

Store information to write a mathtext rendering to the text path

machinery.

"""

def __init__(self):

self.glyphs = []

self.rects = []

<div class="viewcode-block" id="MathtextBackendPath.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPath.render_glyph">[docs]</a> def render_glyph(self, ox, oy, info):

thetext = info.num

self.glyphs.append(

(info.font, info.fontsize, thetext, ox, oy))</div>

<div class="viewcode-block" id="MathtextBackendPath.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPath.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

<div class="viewcode-block" id="MathtextBackendPath.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendPath.get_results">[docs]</a> def get_results(self, box, used_characters):

return (self.width,

self.depth,

self.glyphs,

self.rects)</div></div>

<div class="viewcode-block" id="MathtextBackendCairo"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendCairo">[docs]</a>class MathtextBackendCairo(MathtextBackend):

"""

Store information to write a mathtext rendering to the Cairo

backend.

"""

def __init__(self):

self.glyphs = []

self.rects = []

<div class="viewcode-block" id="MathtextBackendCairo.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendCairo.render_glyph">[docs]</a> def render_glyph(self, ox, oy, info):

oy = oy - info.offset - self.height

thetext = chr(info.num)

self.glyphs.append(

(info.font, info.fontsize, thetext, ox, oy))</div>

<div class="viewcode-block" id="MathtextBackendCairo.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendCairo.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

self.rects.append(

(x1, y1 - self.height, x2 - x1, y2 - y1))</div>

<div class="viewcode-block" id="MathtextBackendCairo.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.MathtextBackendCairo.get_results">[docs]</a> def get_results(self, box, used_characters):

return (self.width,

self.depth,

self.glyphs,

self.rects)</div></div>

<div class="viewcode-block" id="Fonts"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts">[docs]</a>class Fonts:

"""

An abstract base class for a system of fonts to use for mathtext.

The class must be able to take symbol keys and font file names and

return the character metrics. It also delegates to a backend class

to do the actual drawing.

"""

def __init__(self, default_font_prop, mathtext_backend):

"""

*default_font_prop*: A

:class:`~matplotlib.font_manager.FontProperties` object to use

for the default non-math font, or the base font for Unicode

(generic) font rendering.

*mathtext_backend*: A subclass of :class:`MathTextBackend`

used to delegate the actual rendering.

"""

self.default_font_prop = default_font_prop

self.mathtext_backend = mathtext_backend

self.used_characters = {}

<div class="viewcode-block" id="Fonts.destroy"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.destroy">[docs]</a> def destroy(self):

"""

Fix any cyclical references before the object is about

to be destroyed.

"""

self.used_characters = None</div>

<div class="viewcode-block" id="Fonts.get_kern"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.get_kern">[docs]</a> def get_kern(self, font1, fontclass1, sym1, fontsize1,

font2, fontclass2, sym2, fontsize2, dpi):

r"""

Get the kerning distance for font between *sym1* and *sym2*.

*fontX*: one of the TeX font names::

tt, it, rm, cal, sf, bf or default/regular (non-math)

*fontclassX*: TODO

*symX*: a symbol in raw TeX form. e.g., '1', 'x' or '\sigma'

*fontsizeX*: the fontsize in points

*dpi*: the current dots-per-inch

"""

return 0.</div>

<div class="viewcode-block" id="Fonts.get_metrics"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.get_metrics">[docs]</a> def get_metrics(self, font, font_class, sym, fontsize, dpi, math=True):

r"""

*font*: one of the TeX font names::

tt, it, rm, cal, sf, bf or default/regular (non-math)

*font_class*: TODO

*sym*: a symbol in raw TeX form. e.g., '1', 'x' or '\sigma'

*fontsize*: font size in points

*dpi*: current dots-per-inch

*math*: whether sym is a math character

Returns an object with the following attributes:

- *advance*: The advance distance (in points) of the glyph.

- *height*: The height of the glyph in points.

- *width*: The width of the glyph in points.

- *xmin*, *xmax*, *ymin*, *ymax* - the ink rectangle of the glyph

- *iceberg* - the distance from the baseline to the top of

the glyph. This corresponds to TeX's definition of

"height".

"""

info = self._get_info(font, font_class, sym, fontsize, dpi, math)

return info.metrics</div>

<div class="viewcode-block" id="Fonts.set_canvas_size"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.set_canvas_size">[docs]</a> def set_canvas_size(self, w, h, d):

"""

Set the size of the buffer used to render the math expression.

Only really necessary for the bitmap backends.

"""

self.width, self.height, self.depth = np.ceil([w, h, d])

self.mathtext_backend.set_canvas_size(

<div class="viewcode-block" id="Fonts.render_glyph"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.render_glyph">[docs]</a> def render_glyph(self, ox, oy, facename, font_class, sym, fontsize, dpi):

"""

Draw a glyph at

- *ox*, *oy*: position

- *facename*: One of the TeX face names

- *font_class*:

- *sym*: TeX symbol name or single character

- *fontsize*: fontsize in points

- *dpi*: The dpi to draw at.

"""

info = self._get_info(facename, font_class, sym, fontsize, dpi)

realpath, stat_key = get_realpath_and_stat(info.font.fname)

used_characters = self.used_characters.setdefault(

stat_key, (realpath, set()))

used_characters[1].add(info.num)

self.mathtext_backend.render_glyph(ox, oy, info)</div>

<div class="viewcode-block" id="Fonts.render_rect_filled"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.render_rect_filled">[docs]</a> def render_rect_filled(self, x1, y1, x2, y2):

"""

Draw a filled rectangle from (*x1*, *y1*) to (*x2*, *y2*).

"""

self.mathtext_backend.render_rect_filled(x1, y1, x2, y2)</div>

<div class="viewcode-block" id="Fonts.get_xheight"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.get_xheight">[docs]</a> def get_xheight(self, font, fontsize, dpi):

"""

Get the xheight for the given *font* and *fontsize*.

"""

raise NotImplementedError()</div>

<div class="viewcode-block" id="Fonts.get_underline_thickness"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.get_underline_thickness">[docs]</a> def get_underline_thickness(self, font, fontsize, dpi):

"""

Get the line thickness that matches the given font. Used as a

base unit for drawing lines such as in a fraction or radical.

"""

raise NotImplementedError()</div>

<div class="viewcode-block" id="Fonts.get_used_characters"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.get_used_characters">[docs]</a> def get_used_characters(self):

"""

Get the set of characters that were used in the math

expression. Used by backends that need to subset fonts so

they know which glyphs to include.

"""

return self.used_characters</div>

<div class="viewcode-block" id="Fonts.get_results"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.get_results">[docs]</a> def get_results(self, box):

"""

Get the data needed by the backend to render the math

expression. The return value is backend-specific.

"""

result = self.mathtext_backend.get_results(

box, self.get_used_characters())

self.destroy()

return result</div>

<div class="viewcode-block" id="Fonts.get_sized_alternatives_for_symbol"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.Fonts.get_sized_alternatives_for_symbol">[docs]</a> def get_sized_alternatives_for_symbol(self, fontname, sym):

"""

Override if your font provides multiple sizes of the same

symbol. Should return a list of symbols matching *sym* in

various sizes. The expression renderer will select the most

appropriate size for a given situation from this list.

"""

return [(fontname, sym)]</div></div>

<div class="viewcode-block" id="TruetypeFonts"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.TruetypeFonts">[docs]</a>class TruetypeFonts(Fonts):

"""

A generic base class for all font setups that use Truetype fonts

(through FT2Font).

"""

Fonts.__init__(self, default_font_prop, mathtext_backend)

self.glyphd = {}

self._fonts = {}

filename = findfont(default_font_prop)

default_font = get_font(filename)

self._fonts['default'] = default_font

self._fonts['regular'] = default_font

<div class="viewcode-block" id="TruetypeFonts.destroy"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.TruetypeFonts.destroy">[docs]</a> def destroy(self):

self.glyphd = None

Fonts.destroy(self)</div>

def _get_font(self, font):

if font in self.fontmap:

basename = self.fontmap[font]

else:

basename = font

cached_font = self._fonts.get(basename)

if cached_font is None and os.path.exists(basename):

cached_font = get_font(basename)

self._fonts[basename] = cached_font

self._fonts[cached_font.postscript_name] = cached_font

self._fonts[cached_font.postscript_name.lower()] = cached_font

return cached_font

def _get_offset(self, font, glyph, fontsize, dpi):

if font.postscript_name == 'Cmex10':

return ((glyph.height/64.0/2.0) + (fontsize/3.0 * dpi/72.0))

return 0.

def _get_info(self, fontname, font_class, sym, fontsize, dpi, math=True):

key = fontname, font_class, sym, fontsize, dpi

bunch = self.glyphd.get(key)

if bunch is not None:

return bunch

font, num, symbol_name, fontsize, slanted = \

self._get_glyph(fontname, font_class, sym, fontsize, math)

font.set_size(fontsize, dpi)

glyph = font.load_char(

num,

flags=self.mathtext_backend.get_hinting_type())

xmin, ymin, xmax, ymax = [val/64.0 for val in glyph.bbox]

offset = self._get_offset(font, glyph, fontsize, dpi)

metrics = types.SimpleNamespace(

advance = glyph.linearHoriAdvance/65536.0,

height = glyph.height/64.0,

width = glyph.width/64.0,

xmin = xmin,

xmax = xmax,

ymin = ymin+offset,

ymax = ymax+offset,

# iceberg is the equivalent of TeX's "height"

iceberg = glyph.horiBearingY/64.0 + offset,

slanted = slanted

)

result = self.glyphd[key] = types.SimpleNamespace(

font = font,

fontsize = fontsize,

postscript_name = font.postscript_name,

metrics = metrics,

symbol_name = symbol_name,

num = num,

glyph = glyph,

offset = offset

)

return result

<div class="viewcode-block" id="TruetypeFonts.get_xheight"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.TruetypeFonts.get_xheight">[docs]</a> def get_xheight(self, fontname, fontsize, dpi):

font = self._get_font(fontname)

pclt = font.get_sfnt_table('pclt')

if pclt is None:

# Some fonts don't store the xHeight, so we do a poor man's xHeight

metrics = self.get_metrics(

fontname, rcParams['mathtext.default'], 'x', fontsize, dpi)

return metrics.iceberg

xHeight = (pclt['xHeight'] / 64.0) * (fontsize / 12.0) * (dpi / 100.0)

return xHeight</div>

<div class="viewcode-block" id="TruetypeFonts.get_underline_thickness"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.TruetypeFonts.get_underline_thickness">[docs]</a> def get_underline_thickness(self, font, fontsize, dpi):

# This function used to grab underline thickness from the font

# metrics, but that information is just too un-reliable, so it

# is now hardcoded.

return ((0.75 / 12.0) * fontsize * dpi) / 72.0</div>

<div class="viewcode-block" id="TruetypeFonts.get_kern"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.TruetypeFonts.get_kern">[docs]</a> def get_kern(self, font1, fontclass1, sym1, fontsize1,

if font1 == font2 and fontsize1 == fontsize2:

info1 = self._get_info(font1, fontclass1, sym1, fontsize1, dpi)

info2 = self._get_info(font2, fontclass2, sym2, fontsize2, dpi)

font = info1.font

return font.get_kerning(info1.num, info2.num, KERNING_DEFAULT) / 64

return Fonts.get_kern(self, font1, fontclass1, sym1, fontsize1,

<div class="viewcode-block" id="BakomaFonts"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.BakomaFonts">[docs]</a>class BakomaFonts(TruetypeFonts):

"""

Use the Bakoma TrueType fonts for rendering.

Symbols are strewn about a number of font files, each of which has

its own proprietary 8-bit encoding.

"""

_fontmap = {

'cal': 'cmsy10',

'rm': 'cmr10',

'tt': 'cmtt10',

'it': 'cmmi10',

'bf': 'cmb10',

'sf': 'cmss10',

'ex': 'cmex10',

}

def __init__(self, *args, **kwargs):

self._stix_fallback = StixFonts(*args, **kwargs)

TruetypeFonts.__init__(self, *args, **kwargs)

self.fontmap = {}

for key, val in self._fontmap.items():

fullpath = findfont(val)

self.fontmap[key] = fullpath

self.fontmap[val] = fullpath

_slanted_symbols = set(r"\int \oint".split())

def _get_glyph(self, fontname, font_class, sym, fontsize, math=True):

symbol_name = None

font = None

if fontname in self.fontmap and sym in latex_to_bakoma:

basename, num = latex_to_bakoma[sym]

slanted = (basename == "cmmi10") or sym in self._slanted_symbols

elif len(sym) == 1:

slanted = (fontname == "it")

if font is not None:

num = ord(sym)

if font is not None:

gid = font.get_char_index(num)

if gid != 0:

symbol_name = font.get_glyph_name(gid)

if symbol_name is None:

return self._stix_fallback._get_glyph(

fontname, font_class, sym, fontsize, math)

return font, num, symbol_name, fontsize, slanted

# The Bakoma fonts contain many pre-sized alternatives for the

# delimiters. The AutoSizedChar class will use these alternatives

# and select the best (closest sized) glyph.

_size_alternatives = {

'(': [('rm', '('), ('ex', '\xa1'), ('ex', '\xb3'),

('ex', '\xb5'), ('ex', '\xc3')],

')': [('rm', ')'), ('ex', '\xa2'), ('ex', '\xb4'),

('ex', '\xb6'), ('ex', '\x21')],

'{': [('cal', '{'), ('ex', '\xa9'), ('ex', '\x6e'),

('ex', '\xbd'), ('ex', '\x28')],

'}': [('cal', '}'), ('ex', '\xaa'), ('ex', '\x6f'),

('ex', '\xbe'), ('ex', '\x29')],

# The fourth size of '[' is mysteriously missing from the BaKoMa

# font, so I've omitted it for both '[' and ']'

'[': [('rm', '['), ('ex', '\xa3'), ('ex', '\x68'),

('ex', '\x22')],

']': [('rm', ']'), ('ex', '\xa4'), ('ex', '\x69'),

('ex', '\x23')],

r'\lfloor': [('ex', '\xa5'), ('ex', '\x6a'),

('ex', '\xb9'), ('ex', '\x24')],

r'\rfloor': [('ex', '\xa6'), ('ex', '\x6b'),

('ex', '\xba'), ('ex', '\x25')],

r'\lceil': [('ex', '\xa7'), ('ex', '\x6c'),

('ex', '\xbb'), ('ex', '\x26')],

r'\rceil': [('ex', '\xa8'), ('ex', '\x6d'),

('ex', '\xbc'), ('ex', '\x27')],

r'\langle': [('ex', '\xad'), ('ex', '\x44'),

('ex', '\xbf'), ('ex', '\x2a')],

r'\rangle': [('ex', '\xae'), ('ex', '\x45'),

('ex', '\xc0'), ('ex', '\x2b')],

r'\__sqrt__': [('ex', '\x70'), ('ex', '\x71'),

('ex', '\x72'), ('ex', '\x73')],

r'\backslash': [('ex', '\xb2'), ('ex', '\x2f'),

('ex', '\xc2'), ('ex', '\x2d')],

r'/': [('rm', '/'), ('ex', '\xb1'), ('ex', '\x2e'),

('ex', '\xcb'), ('ex', '\x2c')],

r'\widehat': [('rm', '\x5e'), ('ex', '\x62'), ('ex', '\x63'),

('ex', '\x64')],

r'\widetilde': [('rm', '\x7e'), ('ex', '\x65'), ('ex', '\x66'),

('ex', '\x67')],

r'<': [('cal', 'h'), ('ex', 'D')],

r'>': [('cal', 'i'), ('ex', 'E')]

}

for alias, target in [(r'\leftparen', '('),

(r'\rightparent', ')'),

(r'\leftbrace', '{'),

(r'\rightbrace', '}'),

(r'\leftbracket', '['),

(r'\rightbracket', ']'),

(r'\{', '{'),

(r'\}', '}'),

(r'\[', '['),

(r'\]', ']')]:

_size_alternatives[alias] = _size_alternatives[target]

<div class="viewcode-block" id="BakomaFonts.get_sized_alternatives_for_symbol"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.BakomaFonts.get_sized_alternatives_for_symbol">[docs]</a> def get_sized_alternatives_for_symbol(self, fontname, sym):

return self._size_alternatives.get(sym, [(fontname, sym)])</div></div>

<div class="viewcode-block" id="UnicodeFonts"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.UnicodeFonts">[docs]</a>class UnicodeFonts(TruetypeFonts):

"""

An abstract base class for handling Unicode fonts.

While some reasonably complete Unicode fonts (such as DejaVu) may

work in some situations, the only Unicode font I'm aware of with a

complete set of math symbols is STIX.

This class will "fallback" on the Bakoma fonts when a required

symbol can not be found in the font.

"""

use_cmex = True

# This must come first so the backend's owner is set correctly

if rcParams['mathtext.fallback_to_cm']:

self.cm_fallback = BakomaFonts(*args, **kwargs)

else:

self.cm_fallback = None

self.fontmap = {}

for texfont in "cal rm tt it bf sf".split():

prop = rcParams['mathtext.' + texfont]

font = findfont(prop)

self.fontmap[texfont] = font

prop = FontProperties('cmex10')

font = findfont(prop)

self.fontmap['ex'] = font

def _map_virtual_font(self, fontname, font_class, uniindex):

return fontname, uniindex

found_symbol = False

if self.use_cmex:

uniindex = latex_to_cmex.get(sym)

if uniindex is not None:

fontname = 'ex'

found_symbol = True

if not found_symbol:

try:

uniindex = get_unicode_index(sym, math)

found_symbol = True

except ValueError:

uniindex = ord('?')

_log.warning(

"No TeX to unicode mapping for {!a}.".format(sym))

fontname, uniindex = self._map_virtual_font(

fontname, font_class, uniindex)

new_fontname = fontname

# Only characters in the "Letter" class should be italicized in 'it'

# mode. Greek capital letters should be Roman.

if found_symbol:

if fontname == 'it' and uniindex < 0x10000:

char = chr(uniindex)

if (unicodedata.category(char)[0] != "L"

or unicodedata.name(char).startswith("GREEK CAPITAL")):

new_fontname = 'rm'

slanted = (new_fontname == 'it') or sym in self._slanted_symbols

found_symbol = False

if font is not None:

glyphindex = font.get_char_index(uniindex)

if glyphindex != 0:

found_symbol = True

if not found_symbol:

if self.cm_fallback:

if isinstance(self.cm_fallback, BakomaFonts):

_log.warning(

"Substituting with a symbol from Computer Modern.")

if (fontname in ('it', 'regular') and

isinstance(self.cm_fallback, StixFonts)):

return self.cm_fallback._get_glyph(

'rm', font_class, sym, fontsize)

else:

return self.cm_fallback._get_glyph(

else:

and isinstance(self, StixFonts)):

return self._get_glyph('rm', font_class, sym, fontsize)

_log.warning("Font {!r} does not have a glyph for {!a} "

"[U+{:x}], substituting with a dummy "

"symbol.".format(new_fontname, sym, uniindex))

fontname = 'rm'

uniindex = 0xA4 # currency char, for lack of anything better

slanted = False

return font, uniindex, symbol_name, fontsize, slanted

<div class="viewcode-block" id="UnicodeFonts.get_sized_alternatives_for_symbol"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.UnicodeFonts.get_sized_alternatives_for_symbol">[docs]</a> def get_sized_alternatives_for_symbol(self, fontname, sym):

if self.cm_fallback:

return self.cm_fallback.get_sized_alternatives_for_symbol(

fontname, sym)

return [(fontname, sym)]</div></div>

<div class="viewcode-block" id="DejaVuFonts"><a class="viewcode-back" href="../../api/mathtext_api.html#matplotlib.mathtext.DejaVuFonts">[docs]</a>class DejaVuFonts(UnicodeFonts):

use_cmex = False

# This must come first so the backend's owner is set correctly

if isinstance(self, DejaVuSerifFonts):

self.cm_fallback = StixFonts(*args, **kwargs)

else:

self.cm_fallback = StixSansFonts(*args, **kwargs)

self.bakoma = BakomaFonts(*args, **kwargs)

self.fontmap = {}

# Include Stix sized alternatives for glyphs

self._fontmap.update({

1: 'STIXSizeOneSym',

2: 'STIXSizeTwoSym',

3: 'STIXSizeThreeSym',

4: 'STIXSizeFourSym',

5: 'STIXSizeFiveSym',

})

for key, name in self._fontmap.items():

fullpath = findfont(name)

self.fontmap[name] = fullpath

# Override prime symbol to use Bakoma.

if sym == r'\prime':

return self.bakoma._get_glyph(

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

mathtext.html

Latest commit

History

mathtext.html

File metadata and controls