matplotlib.animation.MovieWriter¶
-
class
matplotlib.animation.
MovieWriter
(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)[source]¶ Base class for writing movies.
This is a base class for MovieWriter subclasses that write a movie frame data to a pipe. You cannot instantiate this class directly. See examples for how to use its subclasses.
Attributes: - frame_formatstr
The format used in writing frame data, defaults to 'rgba'.
- fig
Figure
The figure to capture data from. This must be provided by the sub-classes.
Parameters: - fpsint
Framerate for movie.
- codecstr or None, optional
The codec to use. If
None
(the default)rcParams["animation.codec"]
(default: 'h264') is used.- bitrateint or None, optional
The bitrate for the saved movie file, which is one way to control the output file size and quality. The default value is
None
, which usesrcParams["animation.bitrate"]
(default: -1). A value of -1 implies that the bitrate should be determined automatically by the underlying utility.- extra_argslist of str or None, optional
A list of extra string arguments to be passed to the underlying movie utility. The default is
None
, which passes the additional arguments inrcParams["animation.extra_args"]
.- metadataDict[str, str] or None
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__
(self, fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)[source]¶ Parameters: - fpsint
Framerate for movie.
- codecstr or None, optional
The codec to use. If
None
(the default)rcParams["animation.codec"]
(default: 'h264') is used.- bitrateint or None, optional
The bitrate for the saved movie file, which is one way to control the output file size and quality. The default value is
None
, which usesrcParams["animation.bitrate"]
(default: -1). A value of -1 implies that the bitrate should be determined automatically by the underlying utility.- extra_argslist of str or None, optional
A list of extra string arguments to be passed to the underlying movie utility. The default is
None
, which passes the additional arguments inrcParams["animation.extra_args"]
.- metadataDict[str, str] or None
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__
(self[, fps, codec, bitrate, ...])Parameters: bin_path
()Return the binary path to the commandline tool used by a specific subclass. cleanup
(self)Clean-up and collect the process used to write the movie file. finish
(self)Finish any processing for writing the movie. grab_frame
(self, \*\*savefig_kwargs)Grab the image information from the figure and save as a movie frame. isAvailable
()Check to see if a MovieWriter subclass is actually available. saving
(self, fig, outfile, dpi, \*args, ...)Context manager to facilitate writing the movie file. setup
(self, fig, outfile[, dpi])Perform setup for writing the movie file. Attributes
frame_size
A tuple (width, height)
in pixels of a movie frame.-
classmethod
bin_path
()[source]¶ Return the binary path to the commandline tool used by a specific subclass. This is a class method so that the tool can be looked for before making a particular MovieWriter subclass available.
-
property
frame_size
¶ A tuple
(width, height)
in pixels of a movie frame.
-
grab_frame
(self, **savefig_kwargs)[source]¶ Grab the image information from the figure and save as a movie frame.
All keyword arguments in savefig_kwargs are passed on to the
savefig
command that saves the figure.
-
setup
(self, fig, outfile, dpi=None)[source]¶ Perform setup for writing the movie file.
Parameters: - fig
Figure
The figure object that contains the information for frames
- outfilestr
The filename of the resulting movie file
- dpiint, optional
The DPI (or resolution) for the file. This controls the size in pixels of the resulting movie file. Default is fig.dpi.
- fig