On this page
matplotlib.animation.ImageMagickWriter
- classmatplotlib.animation.ImageMagickWriter(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)[source]
-
Pipe-based animated gif.
Frames are streamed directly to ImageMagick via a pipe and written in a single pass.
- Parameters
-
- fpsint, default: 5
-
Movie frame rate (per second).
- codecstr or None, default:
rcParams["animation.codec"]
(default:'h264'
) -
The codec to use.
- bitrateint, default:
rcParams["animation.bitrate"]
(default:-1
) -
The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate.
- extra_argslist of str or None, optional
-
Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use
rcParams["animation.[name-of-encoder]_args"]
for the builtin writers. - metadatadict[str, str], default: {}
-
A dictionary of keys and values for metadata to include in the output file. Some keys that may be of use include: title, artist, genre, subject, copyright, srcform, comment.
- __init__(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)[source]
-
- Parameters
-
- fpsint, default: 5
-
Movie frame rate (per second).
- codecstr or None, default:
rcParams["animation.codec"]
(default:'h264'
) -
The codec to use.
- bitrateint, default:
rcParams["animation.bitrate"]
(default:-1
) -
The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate.
- extra_argslist of str or None, optional
-
Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use
rcParams["animation.[name-of-encoder]_args"]
for the builtin writers. - metadatadict[str, str], default: {}
-
A dictionary of keys and values for metadata to include in the output file. Some keys that may be of use include: title, artist, genre, subject, copyright, srcform, comment.
Methods
__init__
([fps, codec, bitrate, extra_args, ...])- Parameters
bin_path
()Return the binary path to the commandline tool used by a specific subclass.
cleanup
()[Deprecated]
finish
()Finish any processing for writing the movie.
grab_frame
(**savefig_kwargs)Grab the image information from the figure and save as a movie frame.
isAvailable
()Return whether a MovieWriter subclass is actually available.
saving
(fig, outfile, dpi, *args, **kwargs)Context manager to facilitate writing the movie file.
setup
(fig, outfile[, dpi])Setup for writing the movie file.
Attributes
delay
frame_size
A tuple
(width, height)
in pixels of a movie frame.output_args
supported_formats
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/_as_gen/matplotlib.animation.ImageMagickWriter.html