matplotlib.animation.HTMLWriter#

class matplotlib.animation.HTMLWriter(fps=30, codec=None, bitrate=None, extra_args=None, metadata=None, embed_frames=False, default_mode='loop', embed_limit=None)[源代码][源代码]#

用于基于JavaScript的HTML电影的编写器。

参数:
帧率int, 默认值: 5

电影帧率(每秒)。

codec : str 或 None, 默认值: rcParams["animation.codec"] (default: 'h264')str 或 None, 默认:

要使用的编解码器。

比特率 : int, 默认值: rcParams["animation.bitrate"] (default: -1)int, 默认值:

电影的比特率,以每秒千比特为单位。较高的值意味着更高的电影质量,但会增加文件大小。值为 -1 时,让底层的电影编码器选择比特率。

extra_argslist of str or None, optional

传递给底层视频编码器的额外命令行参数。这些参数在文件名之前最后传递给编码器。默认值 None 表示使用 rcParams["animation.[编码器名称]_args"] 用于内置写入器。

元数据dict[str, str], 默认: {}

一个包含键和值的字典,用于在输出文件中包含元数据。一些可能有用的键包括:title, artist, genre, subject, copyright, srcform, comment。

__init__(fps=30, codec=None, bitrate=None, extra_args=None, metadata=None, embed_frames=False, default_mode='loop', embed_limit=None)[源代码][源代码]#
参数:
帧率int, 默认值: 5

电影帧率(每秒)。

codec : str 或 None, 默认值: rcParams["animation.codec"] (default: 'h264')str 或 None, 默认:

要使用的编解码器。

比特率 : int, 默认值: rcParams["animation.bitrate"] (default: -1)int, 默认值:

电影的比特率,以每秒千比特为单位。较高的值意味着更高的电影质量,但会增加文件大小。值为 -1 时,让底层的电影编码器选择比特率。

extra_argslist of str or None, optional

传递给底层视频编码器的额外命令行参数。这些参数在文件名之前最后传递给编码器。默认值 None 表示使用 rcParams["animation.[编码器名称]_args"] 用于内置写入器。

元数据dict[str, str], 默认: {}

一个包含键和值的字典,用于在输出文件中包含元数据。一些可能有用的键包括:title, artist, genre, subject, copyright, srcform, comment。

方法

__init__([fps, codec, bitrate, extra_args, ...])

bin_path()

返回特定子类使用的命令行工具的二进制路径。

finish()

完成电影的任何处理工作。

grab_frame(**savefig_kwargs)

从图形中获取图像信息并保存为电影帧。

isAvailable()

返回一个 MovieWriter 子类是否实际可用。

saving(fig, outfile, dpi, *args, **kwargs)

用于简化编写电影文件的上下文管理器。

setup(fig, outfile[, dpi, frame_dir])

设置以编写电影文件。

属性

frame_format

用于保存帧的格式(png、jpeg 等),可由各个子类决定。

frame_size

电影帧的像素 (宽度, 高度) 元组。

supported_formats

finish()[源代码][源代码]#

完成电影的任何处理工作。

grab_frame(**savefig_kwargs)[源代码][源代码]#

从图形中获取图像信息并保存为电影帧。

savefig_kwargs 中的所有关键字参数都会传递给保存图像的 savefig 调用。然而,savefig 支持的几个关键字参数可能不会被传递,因为它们由 MovieWriter 控制:

  • dpi, bbox_inches: 这些可能不会被传递,因为每一帧的

    动画必须完全相同大小的像素。

  • format: 这由 MovieWriter 控制。

classmethod isAvailable()[源代码][源代码]#

返回一个 MovieWriter 子类是否实际可用。

setup(fig, outfile, dpi=None, frame_dir=None)[源代码][源代码]#

设置以编写电影文件。

参数:
fig

要从中抓取渲染帧的图形。

输出文件str

生成的电影文件的文件名。

dpi : float, 默认值: fig.dpi浮点数,默认值:

输出文件的 dpi。这个参数与图形尺寸一起,控制最终视频文件的像素大小。

frame_prefixstr, 可选

用于临时文件的文件名前缀。如果为 None (默认),文件将写入一个临时目录,该目录由 finish 删除;如果不为 None,则不会删除临时文件。

supported_formats = ['png', 'jpeg', 'tiff', 'svg']#