matplotlib.animation.FuncAnimation #
- クラス matplotlib.animation. FuncAnimation ( fig , func , frames = None , init_func = None , fargs = None , save_count = None , * , cache_frame_data = True , ** kwargs ) [source] #
関数funcを繰り返し呼び出してアニメーションを作成します。
ノート
作成されたアニメーションは、アニメーションが実行される限り存続する変数に格納する必要があります。そうしないと、Animation オブジェクトがガベージ コレクションされ、アニメーションが停止します。
- パラメータ:
- 図
Figure
描画やサイズ変更などの必要なイベントを取得するために使用される Figure オブジェクト。
- 関数呼び出し可能
各フレームで呼び出す関数。最初の引数は、 framesの次の値になります。追加の位置引数は、fargsパラメーターを介して指定できます。
必要な署名は次のとおりです。
def func(frame, *fargs) -> iterable_of_artists
の場合、funcは変更または作成されたすべてのアーティストの iterable を返さなければなりません。この情報は、図のどの部分を更新する必要があるかを判断するために、ブリッティング アルゴリズムによって使用されます。戻り値は未使用であり、その場合は省略できます。
blit == True
blit == False
- フレームiterable、int、ジェネレーター関数、または None、オプション
funcとアニメーションの各フレームを渡すデータのソース
iterable の場合は、単に提供された値を使用します。iterable に長さがある場合、save_count kwarg をオーバーライドします。
整数の場合、渡すことと同等
range(frames)
ジェネレーター関数の場合、署名が必要です。
def gen_function() -> obj
Noneの場合、 を渡すのと同じ
itertools.count
です。
これらすべての場合において、フレーム内の値は単純にユーザー提供の関数に渡されるため、任意の型にすることができます。
- init_func呼び出し可能、オプション
クリア枠を描画する関数です。指定しない場合、フレーム シーケンスの最初のアイテムから描画した結果が使用されます。この関数は、最初のフレームの前に 1 回呼び出されます。
必要な署名は次のとおりです。
def init_func() -> iterable_of_artists
の場合、init_funcは、再描画するアーティストの iterable を返さなければなりません。この情報は、図のどの部分を更新する必要があるかを判断するために、ブリッティング アルゴリズムによって使用されます。戻り値は未使用であり、その場合は省略できます。
blit == True
blit == False
- fargsタプルまたはなし、オプション
funcへの各呼び出しに渡す追加の引数。
- save_count int、デフォルト: 100
フレームからキャッシュへの値の数のフォールバック。これは、フレーム数がframesから推測できない場合、つまり長さのないイテレータまたはジェネレータである場合にのみ使用されます。
- 間隔int、デフォルト: 200
フレーム間の遅延 (ミリ秒)。
- repeat_delay int、デフォルト: 0
repeatが Trueの場合、連続するアニメーション実行間のミリ秒単位の遅延 。
- リピートブール、デフォルト: True
フレームのシーケンスが完了したときにアニメーションを繰り返すかどうか。
- blit bool、デフォルト: False
描画を最適化するためにブリッティングを使用するかどうか。注: ブリッティングを使用する場合、アニメートされたアーティストは zorder に従って描画されます。ただし、zorder に関係なく、以前のアーティストの上に描画されます。
- cache_frame_data bool、デフォルト: True
フレーム データをキャッシュするかどうか。フレームに大きなオブジェクトが含まれている場合は、キャッシュを無効にすると役立つ場合があります。
- 図
- __init__ ( fig , func , frames = None , init_func = None , fargs = None , save_count = None , * , cache_frame_data = True , ** kwargs ) [source] #
メソッド
__init__
(fig, func[, frames, init_func, ...])フレーム情報の新しいシーケンスを返します。
保存/キャッシュされたフレーム情報の新しいシーケンスを返します。
pause
()アニメーションを一時停止します。
resume
()アニメーションを再開します。
save
(ファイル名[、ライター、fps、dpi、コーデック、...])すべてのフレームを描画して、アニメーションをムービー ファイルとして保存します。
to_html5_video
([embed_limit])アニメーションを HTML5
<video>
タグに変換します。to_jshtml
([fps、embed_frames、default_mode])アニメーションの HTML 表現を生成します。