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:The format used in writing frame data, defaults to 'rgba'.
Figure
The figure to capture data from. This must be provided by the sub-classes.
Movie frame rate (per second).
rcParams["animation.codec"] (default: 'h264')
The codec to use.
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 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.
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]¶
Movie frame rate (per second).
rcParams["animation.codec"] (default: 'h264')
The codec to use.
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 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.
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() Return whether a MovieWriter subclass is actually available. saving(self, fig, outfile, dpi, *args, **kwargs) Context manager to facilitate writing the movie file. setup(self, fig, outfile[, dpi]) Setup for writing the movie file.
Attributes
args_key exec_key frame_size A tuple (width, height) in pixels of a movie frame.
args_key¶
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.
cleanup(self)[source]¶
Clean-up and collect the process used to write the movie file.
exec_key¶
finish(self)[source]¶
Finish any processing for writing the movie.
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 call that saves the figure.
isAvailable()[source]¶
Return whether a MovieWriter subclass is actually available.
setup(self, fig, outfile, dpi=None)[source]¶
Setup for writing the movie file.
Parameters:Figure
The figure object that contains the information for frames.
The filename of the resulting movie file.
fig.dpi
The DPI (or resolution) for the file. This controls the size in pixels of the resulting movie file.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4