matplotlib.animation.FuncAnimation

class matplotlib.animation.FuncAnimation(fig, func, frames=None, init_func=None, fargs=None, save_count=None, **kwargs) [source]

Bases: matplotlib.animation.TimedAnimation

Создаёт анимацию путём многократного вызова функции func.

Параметры:

Параметры:	`fig : matplotlib.figure.Figure` Объект фигуры, используемый для получения событий отрисовки, изменения размера и других необходимых событий. `func : callable` Функция, вызываемая на каждом кадре. Первый аргумент будет следующим значением из `frames`. Любые дополнительные позиционные аргументы можно передать через параметр `fargs`. Требуемая сигнатура: def func(frame, fargs) -> iterable_of_artists: `frames : iterable, int, generator function, or None, optional` Источник данных для передачи `func` и каждого кадра анимации. Если это итерируемый объект, просто используйте предоставленные значения. Если у итерируемого объекта есть длина, она переопределит аргумент `save_count`. Если это целое число, эквивалентно передаче `range(frames)`. Если это функция-генератор, она должна иметь сигнатуру: def gen_function() -> obj: Если `None`, то эквивалентно передаче `itertools.count`. Во всех этих случаях значения в frames* просто передаются в предоставленную пользователем функцию func, и поэтому могут быть любого типа. `init_func : callable, optional` Функция для очистки кадра. Если не указана, будут использоваться результаты отрисовки из первого элемента последовательности frames. Эта функция будет вызвана один раз перед первым кадром. Если `blit == True`, `init_func` должна возвращать итерируемый набор элементов для повторной отрисовки. Требуемая сигнатура: def init_func() -> iterable_of_artists: `fargs : tuple or None, optional` Дополнительные аргументы для передачи в каждый вызов функции func. `save_count : int, optional` Количество значений из frames, которые нужно кешировать. `interval : number, optional` Задержка между кадрами в миллисекундах. По умолчанию 200. `repeat_delay : number, optional` Если анимация повторяется, добавляет задержку в миллисекундах перед повтором анимации. По умолчанию `None`. `repeat : bool, optional` Управляет тем, должна ли анимация повторяться, когда последовательность кадров завершена. По умолчанию `True`. `blit : bool, optional` Управляет тем, используется ли блинтинг для оптимизации отрисовки. По умолчанию `False`.

fig : matplotlib.figure.Figure

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

func : callable

Функция, вызываемая на каждом кадре. Первый аргумент будет следующим значением из frames. Любые дополнительные позиционные аргументы можно передать через параметр fargs.

Требуемая сигнатура:

def func(frame, *fargs) -> iterable_of_artists:

frames : iterable, int, generator function, or None, optional

Источник данных для передачи func и каждого кадра анимации.

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

Если это целое число, эквивалентно передаче range(frames).

Если это функция-генератор, она должна иметь сигнатуру:

def gen_function() -> obj:

Если None, то эквивалентно передаче itertools.count.

Во всех этих случаях значения в frames просто передаются в предоставленную пользователем функцию func, и поэтому могут быть любого типа.

init_func : callable, optional

Функция для очистки кадра. Если не указана, будут использоваться результаты отрисовки из первого элемента последовательности frames. Эта функция будет вызвана один раз перед первым кадром.

Если blit == True, init_func должна возвращать итерируемый набор элементов для повторной отрисовки.

Требуемая сигнатура:

def init_func() -> iterable_of_artists:

fargs : tuple or None, optional

Дополнительные аргументы для передачи в каждый вызов функции func.

save_count : int, optional

Количество значений из frames, которые нужно кешировать.

interval : number, optional

Задержка между кадрами в миллисекундах. По умолчанию 200.

repeat_delay : number, optional

Если анимация повторяется, добавляет задержку в миллисекундах перед повтором анимации. По умолчанию None.

repeat : bool, optional

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

blit : bool, optional

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

new_frame_seq() [source]: Создаёт новую последовательность информации о кадрах.

new_saved_frame_seq() [source]: Создаёт новую последовательность сохранённой/кешированной информации о кадрах.

save(filename, writer=None, fps=None, dpi=None, codec=None, bitrate=None, extra_args=None, metadata=None, extra_anim=None, savefig_kwargs=None)

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

Параметры:

Параметры:	`filename : str` Имя выходного файла, например, `mymovie.mp4`. `writer : MovieWriter or str, optional` Экземпляр `MovieWriter` для использования или ключ, идентифицирующий используемый класс, например, 'ffmpeg'. Если `None`, по умолчанию `rcParams["animation.writer"]`. `fps : number, optional` Кадры в секунду в фильме. По умолчанию `None`, что будет использовать указанный в анимации интервал для установки кадров в секунду. `dpi : number, optional` Управляет точками на дюйм для кадров фильма. Это в сочетании с размером фигуры в дюймах управляет размером фильма. Если `None`, по умолчанию `rcParams["savefig.dpi"]`. `codec : str, optional` Кодек видео для использования. Не все кодеки поддерживаются заданным `MovieWriter`. Если `None`, по умолчанию `rcParams["animation.codec"]`. `bitrate : number, optional` Указывает количество битов в секунду в сжатом фильме в килобитах в секунду. Более высокое значение означает фильм более высокого качества, но за счёт увеличения размера файла. Если `None`, по умолчанию `rcParams["animation.bitrate"]`. `extra_args : list, optional` Список дополнительных строковых аргументов, которые необходимо передать в базовый инструмент для работы с фильмами. Если `None`, по умолчанию `rcParams["animation.extra_args"]`. `metadata : Dict[str, str], optional` Словарь ключей и значений для метаданных, которые нужно включить в выходной файл. Некоторые полезные ключи включают: title, artist, genre, subject, copyright, srcform, comment. `extra_anim : list, optional` Дополнительные объекты `Animation`, которые необходимо включить в сохранённый файл фильма. Они должны быть из того же экземпляра `matplotlib.figure.Figure`. Также кадры анимации будут просто комбинироваться, поэтому должна быть 1:1 корреспонденция между кадрами различных анимаций. `savefig_kwargs : dict, optional` Словарь, содержащий ключевые аргументы, которые должны быть переданы команде `savefig` , которая вызывается многократно для сохранения отдельных кадров.

filename : str: Имя выходного файла, например, mymovie.mp4.
writer : MovieWriter or str, optional: Экземпляр MovieWriter для использования или ключ, идентифицирующий используемый класс, например, 'ffmpeg'. Если None, по умолчанию rcParams["animation.writer"].
fps : number, optional: Кадры в секунду в фильме. По умолчанию None, что будет использовать указанный в анимации интервал для установки кадров в секунду.
dpi : number, optional: Управляет точками на дюйм для кадров фильма. Это в сочетании с размером фигуры в дюймах управляет размером фильма. Если None, по умолчанию rcParams["savefig.dpi"].
codec : str, optional: Кодек видео для использования. Не все кодеки поддерживаются заданным MovieWriter. Если None, по умолчанию rcParams["animation.codec"].
bitrate : number, optional: Указывает количество битов в секунду в сжатом фильме в килобитах в секунду. Более высокое значение означает фильм более высокого качества, но за счёт увеличения размера файла. Если None, по умолчанию rcParams["animation.bitrate"].
extra_args : list, optional: Список дополнительных строковых аргументов, которые необходимо передать в базовый инструмент для работы с фильмами. Если None, по умолчанию rcParams["animation.extra_args"].
metadata : Dict[str, str], optional: Словарь ключей и значений для метаданных, которые нужно включить в выходной файл. Некоторые полезные ключи включают: title, artist, genre, subject, copyright, srcform, comment.
extra_anim : list, optional: Дополнительные объекты Animation, которые необходимо включить в сохранённый файл фильма. Они должны быть из того же экземпляра matplotlib.figure.Figure. Также кадры анимации будут просто комбинироваться, поэтому должна быть 1:1 корреспонденция между кадрами различных анимаций.
savefig_kwargs : dict, optional: Словарь, содержащий ключевые аргументы, которые должны быть переданы команде savefig , которая вызывается многократно для сохранения отдельных кадров.

Примечания

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

to_html5_video(embed_limit=None)

Возвращает анимацию как тег HTML5 видео.

Сохраняет анимацию как видео h264, закодированное в base64 непосредственно в тег HTML5 видео. Это учитывает параметры rc для записи, а также битрейт. Также используется параметр interval для управления скоростью и параметр repeat для определения цикличности.