Spec-Zone.ru › Matplotlib 3.3

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.

Параметры:
figFigure

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

funccallable

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

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

def func(frame, *fargs) -> iterable_of_artists

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

framesiterable, int, generator function, or None, optional

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

  • Если итерируемый объект, просто используйте предоставленные значения. Если итерируемый объект имеет длину, он переопределит параметр save_count.
  • Если целое число, эквивалентно передаче range(frames)
  • Если функция-генератор, должна иметь сигнатуру:

    def gen_function() -> obj
    
  • Если None, эквивалентно передаче itertools.count.

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

init_funccallable, optional

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

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

def init_func() -> iterable_of_artists

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

fargstuple or None, optional

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

save_countint, default: 100

Запасное значение для количества значений из frames для кэширования. Используется только в том случае, если количество кадров нельзя определить по frames, то есть, когда это итератор без длины или генератор.

intervalint, default: 200

Задержка между кадрами в миллисекундах.

repeat_delayint, default: 0

Задержка в миллисекундах между последовательными запусками анимации, если repeat равно True.

repeatbool, default: True

Определяет, повторяется ли анимация при завершении последовательности кадров.

blitbool, default: False

Определяет, используется ли быстрое отрисовка (blitting) для оптимизации рисования. При использовании быстрого отрисовки (blitting) анимированные элементы управления будут отрисовываться в соответствии с их порядком z; однако они будут отрисовываться поверх предыдущих элементов управления, независимо от их порядка z.

cache_frame_databool, default: 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.3.3/api/_as_gen/matplotlib.animation.FuncAnimation.html

Spec-Zone.ru

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