matplotlib.animation.Animation

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

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

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

Примечание

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

Параметры:

figFigure

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

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

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

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

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

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

См. также

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список str или None, необязательно

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

metadatadict[str, str], по умолчанию: {}

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

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

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

savefig_kwargsdict, по умолчанию: {}

Аргументы ключевых слов, передаваемые каждому вызову 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'.