Menu

[r6517]: / trunk / matplotlib / doc / users / mathtext.rst  Maximize  Restore  History

Download this file

304 lines (203 with data), 9.5 kB

Writing mathematical expressions

You can use TeX markup in any matplotlib text string. Note that you do not need to have TeX installed, since matplotlib ships its own TeX expression parser, layout engine and fonts. The layout engine is a fairly direct adaptation of the layout algorithms in Donald Knuth's TeX, so the quality is quite good (matplotlib also provides a usetex option for those who do want to call out to TeX to generate their text (see :ref:`usetex-tutorial`).

Any text element can use math text. You need to use raw strings (preceed the quotes with an 'r'), and surround the string text with dollar signs, as in TeX. Regular text and mathtext can be interleaved within the same string. Mathtext can use the Computer Modern fonts (from (La)TeX), STIX fonts (with are designed to blend well with Times) or a Unicode font that you provide. The mathtext font can be selected with the customization variable mathtext.fontset (see :ref:`customizing-matplotlib`)

Here is a simple example:

# plain text
plt.title('alpha > beta')

produces "alpha > beta".

Whereas this:

# math text
plt.title(r'$\alpha > \beta$')

produces "α > β".

Subscripts and superscripts

To make subscripts and superscripts, use the '_' and '^' symbols:

r'$\alpha_i > \beta_i$'
αi > βi

Some symbols automatically put their sub/superscripts under and over the operator. For example, to write the sum of xi from 0 to , you could do:

r'$\sum_{i=0}^\infty x_i$'
i = 0xi

Fractions

Fractions can be created with the \frac{}{} command:

r'$\frac{3}{4}$'

produces

(3)/(4)

Fractions can be arbitrarily nested:

r'$\frac{5 - \frac{1}{x}}{4}$'

produces

(5 − (1)/(x))/(4)

Note that special care needs to be taken to place parentheses and brackets around fractions. Doing things the obvious way produces brackets that are too small:

r'$(\frac{5 - \frac{1}{x}}{4})$'
((5 − (1)/(x))/(4))

The solution is to precede the bracket with \left and \right to inform the parser that those brackets encompass the entire object:

r'$\left(\frac{5 - \frac{1}{x}}{4}\right)$'
(5 − (1)/(x))/(4)

Radicals

Radicals can be produced with the \sqrt[]{} command. For example:

r'$\sqrt{2}$'
(2)

Any base can (optionally) be provided inside square brackets. Note that the base must be a simple expression, and can not contain layout commands such as fractions or sub/superscripts:

r'$\sqrt[3]{x}$'
3(x)

Fonts

The default font is italics for mathematical symbols. To change fonts, eg, to write "sin" in a Roman font, enclose the text in a font command:

r'$s(t) = \mathcal{A}\mathrm{sin}(2 \omega t)$'
s(t) = Asin(2ωt)

More conveniently, many commonly used function names that are typeset in a Roman font have shortcuts. So the expression above could be written as follows:

r'$s(t) = \mathcal{A}\sin(2 \omega t)$'
s(t) = Asin(2ωt)

Here "s" and "t" are variable in italics font (default), "sin" is in Roman font, and the amplitude "A" is in calligraphy font. Note in the example above the caligraphy A is squished into the sin. You can use a spacing command to add a little whitespace between them:

s(t) = \mathcal{A}\/\sin(2 \omega t)
s(t) = A\/sin(2ωt)

The choices available with all fonts are:

Command Result
\mathrm{Roman} Roman
\mathit{Italic} Italic
\mathtt{Typewriter} Typewriter
\mathcal{CALLIGRAPHY} CALLIGRAPHY

When using the STIX fonts, you also have the choice of:

Command Result
\mathbb{blackboard} :math-stix:`\mathbb{blackboard}`
\mathrm{\mathbb{blackboard}} :math-stix:`\mathrm{\mathbb{blackboard}}`
\mathfrak{Fraktur} :math-stix:`\mathfrak{Fraktur}`
\mathsf{sansserif} :math-stix:`\mathsf{sansserif}`
\mathrm{\mathsf{sansserif}} :math-stix:`\mathrm{\mathsf{sansserif}}`

There are also three global "font sets" to choose from, which are selected using the mathtext.fontset parameter in :ref:`matplotlibrc <matplotlibrc-sample>`.

cm: Computer Modern (TeX)

../_static/cm_fontset.png

stix: STIX (designed to blend well with Times)

../_static/stix_fontset.png

stixsans: STIX sans-serif

../_static/stixsans_fontset.png

Custom fonts

mathtext also provides a way to use custom fonts for math. This method is fairly tricky to use, and should be considered an experimental feature for patient users only. By setting the rcParam mathtext.fontset to custom, you can then set the following parameters, which control which font file to use for a particular set of math characters.

Parameter Corresponds to
mathtext.it \mathit{} or default italic
mathtext.rm \mathrm{} Roman (upright)
mathtext.tt \mathtt{} Typewriter (monospace)
mathtext.bf \mathbf{} bold italic
mathtext.cal \mathcal{} calligraphic
mathtext.sf \mathsf{} sans-serif

Each parameter should be set to a fontconfig font descriptor (as defined in the yet-to-be-written font chapter).

The fonts used should have a Unicode mapping in order to find any non-Latin characters, such as Greek. If you want to use a math symbol that is not contained in your custom fonts, you can set the rcParam mathtext.fallback_to_cm to True which will cause the mathtext system to use characters from the default Computer Modern fonts whenever a particular character can not be found in the custom font.

Note that the math glyphs specified in Unicode have evolved over time, and many fonts may not have glyphs in the correct place for mathtext.

Accents

An accent command may precede any symbol to add an accent above it. There are long and short forms for some of them.

Command Result
\acute a or \'a á
\bar a a
\breve a ă
\ddot a or \"a ä
\dot a or \.a ȧ
\grave a or \`a à
\hat a or \^a â
\tilde a or \~a ã
\vec a a

In addition, there are two special accents that automatically adjust to the width of the symbols below:

Command Result
\widehat{xyz} ^xyz
\widetilde{xyz} xyz

Care should be taken when putting accents on lower-case i's and j's. Note that in the following \imath is used to avoid the extra dot over the i:

r"$\hat i\ \ \hat \imath$"
î ı̂

Symbols

You can also use a large number of the TeX symbols, as in \infty, \leftarrow, \sum, \int.

If a particular symbol does not have a name (as is true of many of the more obscure symbols in the STIX fonts), Unicode characters can also be used:

ur'$\u23ce$'

Example

Here is an example illustrating many of these features in context.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.