Spec-Zone.ru › Matplotlib 3.1

matplotlib.animation.Animation

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

Этот класс оборачивает создание анимации с использованием matplotlib.

Это только базовый класс, который необходимо наследовать, чтобы обеспечить необходимое поведение.

Этот класс обычно не используется напрямую.

Параметры:
fig : matplotlib.figure.Figure

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

event_source : object, optional

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

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

blit : bool, optional

управляет тем, используется ли блиттинг для оптимизации отрисовки. По умолчанию False.

См. также

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

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

Методы

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

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

Параметры:
filename : str

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

writer : MovieWriter or str, optional

Экземпляр MovieWriter для использования или ключ, определяющий класс для использования, например, 'ffmpeg'. Если None, по умолчанию rcParams["animation.writer"] = 'ffmpeg'.

fps : number, optional

Кадры в секунду в фильме. По умолчанию None, что будет использовать указанный в анимации интервал для установки кадров в секунду.

dpi : number, optional

Управляет точками на дюйм для кадров фильма. В сочетании с размером фигуры в дюймах управляет размером фильма. Если None, по умолчанию rcParams["savefig.dpi"].

codec : str, optional

Видеокодек, который будет использоваться. Не все кодеки поддерживаются заданным MovieWriter. Если None, по умолчанию rcParams["animation.codec"] = 'h264'.

bitrate : number, optional

Указывает количество бит, используемых в секунду в сжатом фильме, в килобитах в секунду. Более высокое значение означает более качественный фильм, но с увеличением размера файла. Если None, по умолчанию rcParams["animation.bitrate"] = -1.

extra_args : list, optional

Список дополнительных строковых аргументов, которые должны быть переданы базовой утилите для обработки видео. Если None, по умолчанию rcParams["animation.extra_args"].

metadata : Dict[str, str], optional

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

extra_anim : list, optional

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

savefig_kwargs : dict, optional

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

progress_callback : function, 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. Это учитывает rc параметры для writer, а также битрейт. Также используется interval, чтобы управлять скоростью, а параметр repeat используется для определения того, нужно ли циклировать.

Параметры:
embed_limit : float, optional

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

Возвращает:
video_tag : 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.1.1/api/_as_gen/matplotlib.animation.Animation.html

Spec-Zone.ru

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