Spec-Zone.ru › Matplotlib 3.4

matplotlib.mathtext

Inheritance diagram of matplotlib.mathtext

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

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

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

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

класс matplotlib.mathtext.GlueSpec(width=0.0, stretch=0.0, stretch_order=0, shrink=0.0, shrink_order=0)[исходный код]

Базируется на object

[Устаревшее] См. Glue.

Примечания

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

copy()[исходный код]
класс-метод factory(glue_type)[исходный код]
класс matplotlib.mathtext.MathTextParser(output)[исходный код]

Базы: object

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

get_depth(texstr, dpi=120, fontsize=14)[исходный код]

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

Параметры:
texstrstr

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

dpifloat

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

Возвращает:
int

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

Примечания

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

parse(s, dpi=72, prop=None, *, _force_standard_ps_fonts=False)[исходный код]

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

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

to_mask(texstr, dpi=120, fontsize=14)[исходный код]

[Устарело] Преобразование строки 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)[исходный код]

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

Параметры:
filename

Записываемое имя файла или объект файла.

texstrstr

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

colorцвет

Цвет текста.

dpifloat

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

fontsizeint

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

Возвращает:
int

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

Примечания

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

to_rgba(texstr, color='black', dpi=120, fontsize=14)[исходный код]

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

Параметры:
texstrstr

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

colorцвет

Цвет текста.

dpifloat

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

fontsizeint

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

Возвращает:
array(M, N, 4) array

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

depthint

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

Примечания

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

исключение matplotlib.mathtext.MathTextWarning[исходный код]

Базы: Warning

END_OF_DOCUMENT_MARKER
класс matplotlib.mathtext.MathtextBackend[исходный код]

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

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

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

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

  • get_hinting_type()
get_hinting_type()[исходный код]

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

get_results(box)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

set_canvas_size(w, h, d)[исходный код]

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

класс matplotlib.mathtext.MathtextBackendAgg[исходный код]

Базы: matplotlib.mathtext.MathtextBackend

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

get_hinting_type()[исходный код]

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

get_results(box, used_characters)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

set_canvas_size(w, h, d)[исходный код]

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

класс matplotlib.mathtext.MathtextBackendBitmap[исходный код]

Базы: matplotlib.mathtext.MathtextBackendAgg

[Устарело]

Примечания

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

get_results(box, used_characters)[исходный код]

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

класс matplotlib.mathtext.MathtextBackendCairo[исходный код]

Базы: matplotlib.mathtext.MathtextBackend

[Устарело] Хранит информацию для записи рендеринга mathtext в бэкэнде Cairo.

Примечания

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

get_results(box, used_characters)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

END_OF_DOCUMENT_MARKER
класс matplotlib.mathtext.MathtextBackendPath[исходный код]

Базы: matplotlib.mathtext.MathtextBackend

Хранит информацию для рендеринга математического текста в механизм обработки текстовых путей.

get_results(box, used_characters)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

класс matplotlib.mathtext.MathtextBackendPdf[исходный код]

Базы: matplotlib.mathtext.MathtextBackend

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

Примечания

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

get_results(box, used_characters)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

класс matplotlib.mathtext.MathtextBackendPs[исходный код]

Базы: matplotlib.mathtext.MathtextBackend

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

Примечания

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

get_results(box, used_characters)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

класс matplotlib.mathtext.MathtextBackendSvg[исходный код]

Базы: matplotlib.mathtext.MathtextBackend

[Устарело] Хранит информацию для рендеринга математического текста для бэкенда SVG.

Примечания

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

get_results(box, used_characters)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

matplotlib.mathtext.get_unicode_index(symbol, math=True)

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

Параметры:
symbolstr

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

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

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

matplotlib.mathtext.math_to_image(s, filename_or_obj, prop=None, dpi=None, format=None)[исходный код]

Учитывая математическое выражение, отрисовывает его в близко прилегающей рамке в файле изображения.

Параметры:
sstr

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

filename_or_objstr или путь или файл-подобный объект

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

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

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

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

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

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

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

matplotlib.mathtext.ship(ox, oy, box)[исходный код]

[Устарело]

Примечания

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

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/mathtext_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API