matplotlib.animation.Animation

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

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

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

Примечание

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

Параметры:

figFigure

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

event_sourceобъект, необязательно

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

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

blitbool, по умолчанию: False

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

См. также

FuncAnimation, ArtistAnimation

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

Методы

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

new_frame_seq()[source]

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

new_saved_frame_seq()[source]

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

pause()[source]

Приостановить анимацию.

resume()[source]

Возобновить анимацию.

save(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 или str, по умолчанию: rcParams["animation.writer"] (по умолчанию: 'ffmpeg')

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

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

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

dpifloat, по умолчанию: rcParams["savefig.dpi"] (по умолчанию: 'figure')

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

codecstr, по умолчанию: rcParams["animation.codec"] (по умолчанию: 'h264').

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

bitrateint, по умолчанию: rcParams["animation.bitrate"] (по умолчанию: -1)

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

extra_argsсписок строк или None, необязательно

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

metadataсловарь[str, str], по умолчанию: {}

Словарь с ключами и значениями для метаданных, которые нужно включить в выходной файл. Некоторые полезные ключи включают: название, автор, жанр, предмет, авторское право, srcform, комментарий.

extra_animсписок, по умолчанию: []

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

savefig_kwargsсловарь, по умолчанию: {}

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

progress_callbackфункция, необязательно

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

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}/{n}')

Примечания

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

to_html5_video(embed_limit=None)[source]

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

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

Параметры:

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

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

Возвращаемые значения:

str

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

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

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

Параметры:

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

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

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

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

Действие при окончании анимации. Должно быть одно из {'loop', 'once', 'reflect'}. По умолчанию 'loop' если параметр repeat равен True, в противном случае 'once'.