|
| matplotlib.mathtext | index /matplotlib/mathtext.py |
OVERVIEW
mathtext is a module for parsing TeX expressions and drawing them
into a matplotlib.ft2font image buffer. You can draw from this
buffer into your backend.
A large set of the TeX symbols are provided (see below).
Subscripting and superscripting are supported, as well as the
over/under style of subscripting with \sum, \int, etc.
The module uses pyparsing to parse the TeX expression, an so can
handle fairly complex TeX expressions Eg, the following renders
correctly
s = r'\cal{R}\prod_{i=\alpha\cal{B}}^\infty a_i\rm{sin}(2 \pi f x_i)'
The fonts \cal, \rm, \it, and \tt are allowed.
If you find TeX expressions that don't parse or render properly,
please email me, but please check KNOWN ISSUES below first.
LICENSING:
The computer modern fonts this package uses are part of the BaKoMa
fonts, which are (in my understanding) free for noncommercial use.
For commercial use, please consult the licenses in fonts/ttf and the
author Basil K. Malyshev - see also
http://www.mozilla.org/projects/mathml/fonts/encoding/license-bakoma.txt
USAGE:
Any text element (xlabel, ylabel, title, text, etc) can use TeX
markup, as in
xlabel(r'$\Delta_i$')
^
use raw strings
The $ symbols must be the first and last symbols in the string. Eg,
you cannot do
r'My label $x_i$'.
But you can change fonts, as in
r'\rm{My label} x_i'
to achieve the same effect.
A large set of the TeX symbols are provided (see below).
Subscripting and superscripting are supported, as well as the
over/under style of subscripting with \sum, \int, etc.
Allowed TeX symbols:
\Delta \Downarrow \Gamma \Im \LEFTangle \LEFTbrace \LEFTbracket
\LEFTparen \Lambda \Leftarrow \Leftbrace \Leftbracket \Leftparen
\Leftrightarrow \Omega \P \Phi \Pi \Psi \RIGHTangle \RIGHTbrace
\RIGHTbracket \RIGHTparen \Re \Rightarrow \Rightbrace \Rightbracket
\Rightparen \S \SQRT \Sigma \Sqrt \Theta \Uparrow \Updownarrow
\Upsilon \Vert \Xi \aleph \alpha \approx \ast \asymp \backslash
\beta \bigcap \bigcirc \bigcup \bigodot \bigoplus \bigotimes
\bigtriangledown \bigtriangleup \biguplus \bigvee \bigwedge \bot
\bullet \cap \cdot \chi \circ \clubsuit \coprod \cup \dag \dashv
\ddag \delta \diamond \diamondsuit \div \downarrow \ell \emptyset
\epsilon \equiv \eta \exists \flat \forall \frown \gamma \geq \gg
\heartsuit \imath \in \infty \int \iota \jmath \kappa \lambda
\langle \lbrace \lceil \leftangle \leftarrow \leftbrace \leftbracket
\leftharpoondown \leftharpoonup \leftparen \leftrightarrow \leq
\lfloor \ll \mid \mp \mu \nabla \natural \nearrow \neg \ni \nu
\nwarrow \odot \oint \omega \ominus \oplus \oslash \otimes \phi \pi
\pm \prec \preceq \prime \prod \propto \psi \rangle \rbrace \rceil
\rfloor \rho \rightangle \rightarrow \rightbrace \rightbracket
\rightharpoondown \rightharpoonup \rightparen \searrow \sharp \sigma
\sim \simeq \slash \smile \spadesuit \sqcap \sqcup \sqrt \sqsubseteq
\sqsupseteq \subset \subseteq \succ \succeq \sum \supset \supseteq
\swarrow \tau \theta \times \top \triangleleft \triangleright
\uparrow \updownarrow \uplus \upsilon \varepsilon \varphi \varphi
\varrho \varsigma \vartheta \vdash \vee \wedge \wp \wr \xi \zeta
BACKENDS
mathtext currently works with Agg, GTKAgg and TkAgg. If David
incorporates ft2font into paint, it will be easy to add to Paint. I
think I can also add it to GTK rather straightforwardly, since it's
just a matter of rendering from the ft2font pixel buffers; ditto for
wx. PS will require more substantial work, doing the metrics and
layouts with the AFM versions of the computer modern fonts.
Backends which don't support mathtext will just render the TeX
string as a literal. Stay tuned.
KNOWN ISSUES:
- some hackish ways I deal with a strange offset in cmex10
- bbox is a bit large in vertical direction and small in horizontal direction
- nested subscripts, eg, x_i_i not working
- nesting fonts changes in sub/superscript groups not parsing
- I would also like to add a fre more layout commands, like \frac.
Author : John Hunter <jdhunter@ace.bsd.uchicago.edu>
Copyright : John Hunter (2004)
License : matplotlib license (PSF compatible)
| Modules | ||||||
| ||||||
| Classes | ||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||
| Functions | ||
| ||
| Data | ||
| False = False OFFSET_EX10 = 8.0 True = True alphanums = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' alphas = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' binop = MatchFirst:([MatchFirst:([MatchFirst:(["+", "-"]), "*"]), "/"]) bslash = "\" cal = "cal" char = W:(abcd...) div = "/" division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192) equals = "=" expr = OneOrMore:(MatchFirst:([MatchFirst:([MatchFirst:...First:([...]))]), Suppress:("}")]))]))])])))])])) fontgrp = Group:(And:([Combine:(And:(["\", MatchFirst:([Ma...More:(MatchFirst:([...]))]), Suppress:("}")]))])) fontname = MatchFirst:([MatchFirst:([MatchFirst:(["rm", "cal"]), "it"]), "tt"]) fonttable = {'(': ('cmex10.ttf', 'A1'), ')': ('cmex10.ttf', 'A2'), '*': ('cmsy10.ttf', 'A4'), '+': ('cmr10.ttf', '2B'), ',': ('cmmi10.ttf', '3B'), '-': ('cmsy10.ttf', 'A1'), '.': ('cmmi10.ttf', '3A'), '/': ('cmmi10.ttf', '3D'), ':': ('cmr10.ttf', '3A'), ';': ('cmr10.ttf', '3B'), ...} group = MatchFirst:([MatchFirst:([Group:(And:([And:([Sup...tchFirst:([...]))]), Suppress:("}")]))]))])])))]) grouping = MatchFirst:([MatchFirst:([MatchFirst:(["[", "]"]), "("]), ")"]) grp = Group:(And:([And:([Suppress:("{"), OneOrMore:(MatchFirst:([...]))]), Suppress:("}")])) handler = <matplotlib.mathtext.Handler instance> italics = "it" langle = "<" lbrace = Suppress:("{") lbrack = "[" lparen = "(" minus = "-" nums = '0123456789' overunder = {r'\coprod': 1, r'\int': 1, r'\prod': 1, r'\sum': 1} plus = "+" rangle = ">" rbrace = Suppress:("}") rbrack = "]" relation = MatchFirst:([MatchFirst:(["<", ">"]), "="]) roman = "rm" rparen = ")" singlesym = MatchFirst:([MatchFirst:([MatchFirst:([MatchFirs...chFirst:([MatchFirst:(["[", "]"]), "("]), ")"])]) subsupgrp = Forward:(Group:(And:([MatchFirst:(["_", "^"]), M...MatchFirst:([...]))]), Suppress:("}")]))]))])]))) superscript = "^" symbol = MatchFirst:([MatchFirst:([MatchFirst:([MatchFirs...tchFirst:([...]))]), Suppress:("}")]))]))])])))]) texsym = Combine:(And:([And:(["\", W:(abcd...)]), NotAny:(Suppress:("{"))])) times = "*" typewriter = "tt" underscore = "_" | ||