matplotlib.mathtext

Модуль для разбора подмножества синтаксиса TeX математических выражений и его отображения в Matplotlib backend.

Для ознакомления с его использованием см. Написание математических выражений. Данный документ в основном посвящен деталям реализации.

В модуле используется pyparsing для разбора выражения TeX.

Поддерживаются шрифты Bakoma распределения TeX Computer Modern и шрифты STIX. Есть экспериментальная поддержка использования произвольных шрифтов, но результаты могут отличаться без надлежащей настройки и метрик для этих шрифтов.

classmatplotlib.mathtext.MathTextParser(output)[source]

Bases: object

Создать MathTextParser для заданного бэкэнда output.

get_depth(texstr, dpi=120, fontsize=14)[source]

[Устарело] Получить глубину строки mathtext.

Параметры

texstrstr

Действительная строка mathtext, например, r'IQ: $sigma_i=15$'.

dpifloat

Настройка точек на дюйм, используемая для рендеринга текста.

Возвращает

int

Смещение базовой линии от нижней части изображения в пикселях.

Примечания

Устарело начиная с версии 3.4.

parse(s, dpi=72, prop=None, *, _force_standard_ps_fonts=False)[source]

Разбор данного математического выражения s при заданном dpi. Если prop предоставлен, это объект FontProperties, определяющий "стандартный" шрифт для использования в математическом выражении, используемый для всего текста, не являющегося математическим.

Результаты кэшируются, поэтому несколько вызовов parse с тем же выражением должны быть быстрыми.

to_mask(texstr, dpi=120, fontsize=14)[source]

[Устарело] Преобразование строки mathtext в массив градаций серого и глубины.

Параметры

texstrstr

Действительная строка mathtext, например, r'IQ: $sigma_i=15$'.

dpifloat

Настройка точек на дюйм, используемая для рендеринга текста.

fontsizeint

Размер шрифта в пунктах

Возвращает

array2D uint8 alpha

Массив масок растризованного tex.

depthint

Смещение базовой линии от нижней части изображения в пикселях.

Примечания

Устарело начиная с версии 3.4.

to_png(filename, texstr, color='black', dpi=120, fontsize=14)[source]

[Устарело] Рендеринг выражения tex в файл PNG.

Параметры

filename

Запись или файл-объект.

texstrstr

Действительная строка mathtext, например, r'IQ: $sigma_i=15$'.

colorcolor

Цвет текста.

dpifloat

Настройка точек на дюйм, используемая для рендеринга текста.

fontsizeint

Размер шрифта в пунктах.

Возвращает

int

Смещение базовой линии от нижней части изображения в пикселях.

Примечания

Устарело начиная с версии 3.4.

to_rgba(texstr, color='black', dpi=120, fontsize=14)[source]

[Устарело] Преобразование строки mathtext в массив RGBA и глубину.

Параметры

texstrstr

Действительная строка mathtext, например, r'IQ: $sigma_i=15$'.

colorcolor

Цвет текста.

dpifloat

Настройка точек на дюйм, используемая для рендеринга текста.

fontsizeint

Размер шрифта в пунктах.

Возвращает

array(M, N, 4) array

Значения цвета RGBA растризованного tex, окрашенные color.

depthint

Смещение базовой линии от нижней части изображения в пикселях.

Примечания

Устарело начиная с версии 3.4.

exceptionmatplotlib.mathtext.MathTextWarning[source]

Bases: Warning

classmatplotlib.mathtext.MathtextBackend[source]

Bases: object

Базовый класс для кода, специфичного для бэкенда mathtext. MathtextBackend подклассы обеспечивают интерфейс между mathtext и конкретными графическими бэкендами Matplotlib.

Подклассы должны переопределять следующие:

• render_glyph()
• render_rect_filled()
• get_results()

И необязательно, если вам нужно использовать стиль наводки FreeType:

• get_hinting_type()

get_hinting_type()[source]

Получить тип наводки FreeType для использования с этим конкретным бэкендом.

get_results(box)[source]

Возвращает специфичную для бэкенда кортеж, который будет возвращен бэкенду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отобразить глиф, описанный параметром info, в точке отсчета (ox, oy).

render_rect_filled(x1, y1, x2, y2)[source]

Отобразить заполненный черным прямоугольник от (x1, y1) до (x2, y2).

set_canvas_size(w, h, d)[source]

Установить размер холста для отрисовки.

classmatplotlib.mathtext.MathtextBackendAgg[source]

Bases: matplotlib.mathtext.MathtextBackend

Отображение глифов и прямоугольников в буфере FTImage, который затем передается в изображение Agg бэкендом Agg.

get_hinting_type()[source]

Получить тип наводки FreeType для использования с этим конкретным бэкендом.

get_results(box, used_characters)[source]

Возвращает специфичную для бэкенда кортеж, который будет возвращен бэкенду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отобразить глиф, описанный параметром info, в точке отсчета (ox, oy).

render_rect_filled(x1, y1, x2, y2)[source]

Отобразить заполненный черным прямоугольник от (x1, y1) до (x2, y2).

set_canvas_size(w, h, d)[source]

Установить размер холста для отрисовки.

classmatplotlib.mathtext.MathtextBackendBitmap[source]

Bases: matplotlib.mathtext.MathtextBackendAgg

[Устарело]

Примечания

Устарело начиная с версии 3.4:

get_results(box, used_characters)[source]

Возвращает специфичную для бэкенда кортеж, который будет возвращен бэкенду после завершения всех операций.

classmatplotlib.mathtext.MathtextBackendCairo[source]

Bases: matplotlib.mathtext.MathtextBackend

[Устаревшее] Сохраняет информацию для рендеринга математического текста в бэкенде Cairo.

Примечания

Устарело начиная с версии 3.4.

get_results(box, used_characters)[source]

Возвращает кортеж, специфичный для бэкенда, который должен быть возвращён бэкенду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отрисовывает глиф, описанный в info, в точке отсчёта (ox, oy).

render_rect_filled(x1, y1, x2, y2)[source]

Отрисовывает заполненный чёрный прямоугольник от (x1, y1) до (x2, y2).

classmatplotlib.mathtext.MathtextBackendPath[source]

Bases: matplotlib.mathtext.MathtextBackend

Сохраняет информацию для рендеринга математического текста с помощью механизма путей текста.

get_results(box, used_characters)[source]

Возвращает кортеж, специфичный для бэкенда, который должен быть возвращён бэкенду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отрисовывает глиф, описанный в info, в точке отсчёта (ox, oy).

render_rect_filled(x1, y1, x2, y2)[source]

Отрисовывает заполненный чёрный прямоугольник от (x1, y1) до (x2, y2).

classmatplotlib.mathtext.MathtextBackendPdf[source]

Bases: matplotlib.mathtext.MathtextBackend

[Устаревшее] Сохраняет информацию для рендеринга математического текста в бэкенде PDF.

Примечания

Устарело начиная с версии 3.4.

get_results(box, used_characters)[source]

Возвращает кортеж, специфичный для бэкенда, который должен быть возвращён бэкенду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отрисовывает глиф, описанный в info, в точке отсчёта (ox, oy).

render_rect_filled(x1, y1, x2, y2)[source]

Отрисовывает заполненный чёрный прямоугольник от (x1, y1) до (x2, y2).

classmatplotlib.mathtext.MathtextBackendPs[source]

Bases: matplotlib.mathtext.MathtextBackend

[Устаревшее] Сохраняет информацию для рендеринга математического текста в бэкенде PostScript.

Примечания

Устарело начиная с версии 3.4.

get_results(box, used_characters)[source]

Возвращает кортеж, специфичный для бэкенда, который должен быть возвращён бэкенду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отрисовывает глиф, описанный в info, в точке отсчёта (ox, oy).

render_rect_filled(x1, y1, x2, y2)[source]

Отрисовывает заполненный чёрный прямоугольник от (x1, y1) до (x2, y2).

classmatplotlib.mathtext.MathtextBackendSvg[source]

Bases: matplotlib.mathtext.MathtextBackend

[Устаревшее] Сохраняет информацию для отрисовки математического текста в SVG-бекенде.

Примечания

Устарело начиная с версии 3.4.

get_results(box, used_characters)[source]

Возвращает кортеж, специфичный для бэкенда, для передачи в бэкенд после завершения всех процессов.

render_glyph(ox, oy, info)[source]

Отрисовывает глиф, описанный параметром info, в точку с координатами (ox, oy).

render_rect_filled(x1, y1, x2, y2)[source]

Отрисовывает заполненный черным прямоугольник от точки (x1, y1) до точки (x2, y2).

matplotlib.mathtext.get_unicode_index(symbol, math=True)[source]

Возвращает целочисленный индекс (из таблицы Unicode) символа symbol.

Parameters

symbolstr

Один символ Unicode, команда TeX (например, r'pi') или имя символа Type1 (например, 'phi').

mathbool, по умолчанию: True

Если False, всегда обрабатывает как один символ Unicode.

matplotlib.mathtext.math_to_image(s, filename_or_obj, prop=None, dpi=None, format=None)[source]

Преобразует математическое выражение в изображение с точно заданными границами.

Parameters

sstr

Математическое выражение. Математическая часть должна быть заключена в знаки доллара.

filename_or_objstr или объект пути или файла

Куда записать данные изображения.

propFontProperties, необязательно

Размер и стиль текста.

dpifloat, необязательно

Значение DPI для вывода. Если не задано, DPI определяется как для Figure.savefig.

formatstr, необязательно

Формат вывода, например, 'svg', 'pdf', 'ps' или 'png'. Если не задано, формат определяется как для Figure.savefig.

matplotlib.mathtext.ship(ox, oy, box)[source]

[Устаревшее]

Примечания

Устарело начиная с версии 3.4: