Spec-Zone.ru › Matplotlib 3.4

matplotlib.animation.Animation

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

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

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

Примечание

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

Параметры:
figFigure

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

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

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

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

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

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

См. также

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

Инициализировать self. См. справку по типу(self) для точного сигнатура.

Методы

__init__(fig[, event_source, blit]) Инициализировать self.
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]

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

END_OF_DOCUMENT_MARKER
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"] для встроенных записывателей.

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

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

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

Дополнительные объекты Animation, которые должны быть включены в сохранённое видео. Они должны принадлежать тому же экземпляру matplotlib.figure.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} of {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 video. Это учитывает rcParams["animation.writer"] (по умолчанию: 'ffmpeg') и rcParams["animation.bitrate"] (по умолчанию: -1). Это также использует interval для управления скоростью и параметр repeat для определения, нужно ли циклировать.

Параметры:
embed_limitfloat, необязательно

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

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

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

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

Сгенерировать HTML-представление анимации

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

Spec-Zone.ru

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