Spec-Zone.ru › Matplotlib 3.1

matplotlib.animation.FuncAnimation

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

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

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

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

func : callable

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

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

def func(frame, *fargs) -> iterable_of_artists

Если blit == True, функция func должна возвращать итерируемый объект со всеми изменёнными или созданными элементами. Эта информация используется алгоритмом кеширования для определения, какие части фигуры необходимо обновить. Значение возврата игнорируется, если blit == False, и может быть опущено в этом случае.

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

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

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

def init_func() -> iterable_of_artists

Если blit == True, функция init_func должна возвращать итерируемый объект с элементами, которые необходимо перерисовать. Эта информация используется алгоритмом кеширования для определения, какие части фигуры необходимо обновить. Значение возврата игнорируется, если blit == False и может быть опущено в этом случае.

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.

cache_frame_data : bool, optional

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

__init__(self, fig, func, frames=None, init_func=None, fargs=None, save_count=None, *, cache_frame_data=True, **kwargs) [source]

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

Методы

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

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

© 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.FuncAnimation.html

Spec-Zone.ru

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