Spec-Zone.ru › Matplotlib 3.3

matplotlib.animation.Animation

class matplotlib.animation.Animation(fig, event_source=None, blit=False) [source]

Базовый класс для анимаций.

Этот класс не может использоваться напрямую и должен быть наследоваться для предоставления необходимого поведения.

Параметры:
figFigure

Объект фигуры, используемый для получения необходимых событий, таких как отрисовка или изменение размера.

event_sourceobject, optional

Класс, который может запускать обратный вызов при возникновении необходимых событий, а также может останавливаться и запускаться.

Примеры включают таймеры (см. TimedAnimation) и уведомления файловой системы.

blitbool, default: False

Используется ли кеширование для оптимизации отрисовки.

См. также

FuncAnimation, ArtistAnimation
__init__(self, fig, event_source=None, blit=False) [source]

Инициализирует себя. См. help(type(self)) для точного синтаксиса.

Методы

__init__(self, fig[, event_source, blit]) Инициализирует себя.
new_frame_seq(self) Возвращает новую последовательность информации о кадре.
new_saved_frame_seq(self) Возвращает новую последовательность сохранённой/кэшированной информации о кадре.
save(self, filename[, writer, fps, dpi, ...]) Сохраняет анимацию в виде видеофайла, рисуя каждый кадр.
to_html5_video(self[, embed_limit]) Преобразует анимацию в тег HTML5 <video>.
to_jshtml(self[, fps, embed_frames, ...]) Генерирует HTML-представление анимации
new_frame_seq(self) [source]

Возвращает новую последовательность информации о кадре.

new_saved_frame_seq(self) [source]

Возвращает новую последовательность сохранённой/кэшированной информации о кадре.

save(self, filename, writer=None, fps=None, dpi=None, codec=None, bitrate=None, extra_args=None, metadata=None, extra_anim=None, savefig_kwargs=None, *, progress_callback=None) [source]

Сохраняет анимацию в виде видеофайла, рисуя каждый кадр.

Параметры:
filenamestr

Имя выходного файла, например, mymovie.mp4.

writerMovieWriter or str, default: rcParams["animation.writer"] (default: 'ffmpeg')

Экземпляр MovieWriter для использования или ключ, идентифицирующий используемый класс, такой как 'ffmpeg'.

fpsint, optional

Частота кадров видео (в секунду). Если не задано, используется частота кадров из интервала кадров анимации.

dpifloat, default: rcParams["savefig.dpi"] (default: 'figure')

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

codecstr, default: rcParams["animation.codec"] (default: 'h264').

Код видеокодека для использования. Не все кодеки поддерживаются данным MovieWriter.

bitrateint, default: rcParams["animation.bitrate"] (default: -1)

Битрейт видео в килобитах в секунду. Более высокие значения означают более качественное видео, но увеличивают размер файла. Значение -1 позволяет кодеку видео выбрать битрейт.

extra_argslist of str or None, optional

Дополнительные параметры командной строки, передаваемые кодеку видео. По умолчанию, None, означает использование rcParams["animation.[name-of-encoder]_args"] для встроенных писателей.

metadataDict[str, str], default {}

Словарь ключей и значений для метаданных, которые необходимо включить в выходной файл. Некоторые полезные ключи включают: title, artist, genre, subject, copyright, srcform, comment.

extra_animlist, default: []

Дополнительные объекты Animation, которые должны быть включены в сохранённый видеофайл. Они должны быть из того же экземпляра matplotlib.figure.Figure. Также кадры анимации будут просто объединены, поэтому должна быть 1:1 корреляция между кадрами из различных анимаций.

savefig_kwargsdict, default: {}

Ключевые аргументы, передаваемые каждому вызову savefig для сохранения отдельных кадров.

progress_callbackfunction, optional

Функция обратного вызова, которая будет вызываться для каждого кадра, чтобы уведомить о прогрессе сохранения. Она должна иметь синтаксис

def func(current_frame: int, total_frames: int) -> Any

где current_frame - номер текущего кадра, а total_frames - общее количество кадров для сохранения. total_frames устанавливается в None, если общее количество кадров невозможно определить. Значения возврата могут существовать, но игнорируются.

Пример кода для записи прогресса в стандартный вывод:

progress_callback =                    lambda i, n: print(f'Saving frame {i} of {n}')

Примечания

fps, codec, bitrate, extra_args и metadata используются для создания экземпляра MovieWriter и могут быть переданы только если writer является строкой. Если они передаются как не None и writer является MovieWriter, будет поднята ошибка RuntimeError.

to_html5_video(self, embed_limit=None) [source]

Преобразует анимацию в тег HTML5 <video>.

Это сохраняет анимацию как видео h264, закодированное в base64 непосредственно в теге HTML5 video. Это учитывает rcParams["animation.writer"] (по умолчанию: 'ffmpeg') и rcParams["animation.bitrate"] (по умолчанию: -1). Это также использует параметр interval для управления скоростью и использует параметр repeat для определения того, нужно ли повторять.

Параметры:
embed_limitfloat, optional

Предел в МБ возвращаемой анимации. Анимация не создаётся, если предел превышен. По умолчанию rcParams["animation.embed_limit"] (по умолчанию: 20.0) = 20.0.

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

Тег HTML5 video с анимацией, вставленной в виде закодированного в base64 видео h264. Если предел embed_limit превышен, возвращается строка "Видео слишком большое для вставки."

to_jshtml(self, fps=None, embed_frames=True, default_mode=None) [source]

Генерирует HTML-представление анимации

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/_as_gen/matplotlib.animation.Animation.html

Spec-Zone.ru

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