matplotlib.animation.AbstractMovieWriter#

classmatplotlib.animation.AbstractMovieWriter(fps=5,metadata=None,codec=None,bitrate=None)[source]#

Abstract base class for writing movies, providing a way to grab frames bycallinggrab_frame.

setup is called to start the process andfinish is called afterwards.saving is provided as a context manager to facilitate this process as

withmoviewriter.saving(fig,outfile='myfile.mp4',dpi=100):# Iterate over framesmoviewriter.grab_frame(**savefig_kwargs)

The use of the context manager ensures thatsetup andfinish areperformed as necessary.

An instance of a concrete subclass of this class can be given as thewriter argument ofAnimation.save().

__init__(fps=5,metadata=None,codec=None,bitrate=None)[source]#

Methods

__init__([fps, metadata, codec, bitrate])
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.
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

frame_size

A tuple(width,height) in pixels of a movie frame.

abstractmethodfinish()[source]#

Finish any processing for writing the movie.

propertyframe_size#

A tuple(width,height) in pixels of a movie frame.

abstractmethodgrab_frame(**savefig_kwargs)[source]#

Grab the image information from the figure and save as a movie frame.

All keyword arguments insavefig_kwargs are passed on to thesavefig call that saves the figure. However, severalkeyword arguments that are supported bysavefig may not bepassed as they are controlled by the MovieWriter:

• dpi,bbox_inches: These may not be passed because each frame of the

  animation much be exactly the same size in pixels.

• format: This is controlled by the MovieWriter.

saving(fig,outfile,dpi,*args,**kwargs)[source]#

Context manager to facilitate writing the movie file.

*args,**kw are any parameters that should be passed tosetup.

abstractmethodsetup(fig,outfile,dpi=None)[source]#

Setup for writing the movie file.

Parameters:

figFigure

The figure object that contains the information for frames.

outfilestr

The filename of the resulting movie file.

dpifloat, default:fig.dpi

The DPI (or resolution) for the file. This controls the sizein pixels of the resulting movie file.