Animated plots#

Animations are generated from a list (or other iterable) of graphics objects. Images are produced by calling the save_image method on each input object, creating a sequence of PNG files. These are then assembled to various target formats using different tools. In particular, the convert program from ImageMagick can be used to generate an animated GIF file. FFmpeg (with the command line program ffmpeg) provides support for various video formats, but also an alternative method of generating animated GIFs. For browsers which support it, APNG can be used as another alternative which works without any extra dependencies.

Warning

Note that ImageMagick and FFmpeg are not included with Sage, and must be installed by the user. On unix systems, type which convert at a command prompt to see if convert (part of the ImageMagick suite) is installed. If it is, you will be given its location. Similarly, you can check for ffmpeg with which ffmpeg. See the websites of ImageMagick or FFmpeg for installation instructions.

EXAMPLES:

The sine function:

sage: x = SR.var("x")
sage: sines = [plot(c*sin(x), (-2*pi,2*pi), color=Color(c,0,0), ymin=-1, ymax=1)
....:          for c in sxrange(0,1,.2)]
sage: a = animate(sines)
sage: print(a)
Animation with 5 frames
sage: a.show()                  # long time  # optional -- ImageMagick

Animate using FFmpeg instead of ImageMagick:

sage: a.show(use_ffmpeg=True)   # long time  # optional -- FFmpeg

Animate as an APNG:

sage: a.apng(show_path=True)    # long time
Animation saved to ....png.

An animated sage.plot.multigraphics.GraphicsArray of rotating ellipses:

sage: E = animate((graphics_array([[ellipse((0,0), a, b, angle=t, xmin=-3, xmax=3)
....:                                + circle((0,0), 3, color='blue')
....:                               for a in range(1,3)]
....:                              for b in range(2,4)])
....:              for t in sxrange(0, pi/4, .15)))
sage: str(E)    # animations produced from a generator do not have a known length
'Animation with unknown number of frames'
sage: E.show()                  # long time  # optional -- ImageMagick

A simple animation of a circle shooting up to the right:

sage: c = animate([circle((i,i), 1 - 1/(i+1), hue=i/10)
....:              for i in srange(0, 2, 0.2)],
....:             xmin=0, ymin=0, xmax=2, ymax=2, figsize=[2,2])
sage: c.show()                  # long time  # optional -- ImageMagick

Animations of 3d objects:

sage: s,t = SR.var("s,t")
sage: def sphere_and_plane(x):
....:     return (sphere((0,0,0), 1, color='red', opacity=.5)
....:              + parametric_plot3d([t,x,s], (s,-1,1), (t,-1,1),
....:                                  color='green', opacity=.7))
sage: sp = animate([sphere_and_plane(x)
....:               for x in sxrange(-1, 1, .3)])
sage: sp[0]      # first frame
Graphics3d Object
sage: sp[-1]     # last frame
Graphics3d Object
sage: sp.show()                 # long time  # optional -- ImageMagick

sage: (x,y,z) = SR.var("x,y,z")
sage: def frame(t):
....:     return implicit_plot3d((x^2 + y^2 + z^2),
....:                            (x, -2, 2), (y, -2, 2), (z, -2, 2),
....:                            plot_points=60, contour=[1,3,5],
....:                            region=lambda x,y,z: x<=t or y>=t or z<=t)
sage: a = animate([frame(t) for t in srange(.01, 1.5, .2)])
sage: a[0]                      # long time
Graphics3d Object
sage: a.show()                  # long time  # optional -- ImageMagick

If the input objects do not have a save_image method, then the animation object attempts to make an image by calling its internal method sage.plot.animate.Animation.make_image(). This is illustrated by the following example:

sage: t = SR.var("t")
sage: a = animate((sin(c*pi*t) for c in sxrange(1, 2, .2)))
sage: a.show()                  # long time  # optional -- ImageMagick

AUTHORS:

William Stein
John Palmieri
Niles Johnson (2013-12): Expand to animate more graphics objects
Martin von Gagern (2014-12): Added APNG support
Joshua Campbell (2020): interactive animation via Three.js viewer

REFERENCES:

class sage.plot.animate.APngAssembler(out, num_frames, num_plays=0, delay=200, delay_denominator=100)#

Bases: object

Builds an APNG (Animated PNG) from a sequence of PNG files. This is used by the sage.plot.animate.Animation.apng() method.

This code is quite simple; it does little more than copying chunks from input PNG files to the output file. There is no optimization involved. This does not depend on external programs or libraries.

INPUT:

out – a file opened for binary writing to which the data will be written
num_frames – the number of frames in the animation
num_plays – how often to iterate, 0 means infinitely
delay – numerator of the delay fraction in seconds
delay_denominator – denominator of the delay in seconds

EXAMPLES:

sage: from sage.plot.animate import APngAssembler
sage: x = SR.var("x")
sage: def assembleAPNG():
....:     a = animate([sin(x + float(k)) for k in srange(0,2*pi,0.7)],
....:                 xmin=0, xmax=2*pi, figsize=[2,1])
....:     pngdir = a.png()
....:     outfile = sage.misc.temporary_file.tmp_filename(ext='.png')
....:     with open(outfile, "wb") as f:
....:         apng = APngAssembler(f, len(a))
....:         for i in range(len(a)):
....:             png = os.path.join(pngdir, "{:08d}.png".format(i))
....:             apng.add_frame(png, delay=10*i + 10)
....:     return outfile
sage: assembleAPNG()  # long time
'...png'

add_frame(pngfile, delay=None, delay_denominator=None)#

Adds a single frame to the APNG file.

INPUT:

pngfile – file name of the PNG file with data for this frame
delay – numerator of the delay fraction in seconds
delay_denominator – denominator of the delay in seconds

If the delay is not specified, the default from the constructor applies.

magic = b'\x89PNG\r\n\x1a\n'#

mustmatch = frozenset({b'IHDR', b'PLTE', b'bKGD', b'cHRM', b'gAMA', b'pHYs', b'sBIT', b'tRNS'})#

set_default(pngfile)#

Adds a default image for the APNG file.

This image is used as a fallback in case some application does not understand the APNG format. This method must be called prior to any calls to the add_frame method, if it is called at all. If it is not called, then the first frame of the animation will be the default.

INPUT:

pngfile – file name of the PNG file with data for the default image

class sage.plot.animate.Animation(v=None, **kwds)#

Bases: WithEqualityById, SageObject

Return an animation of a sequence of plots of objects.

INPUT:

v – iterable of Sage objects. These should preferably be graphics objects, but if they aren’t, then make_image() is called on them.
xmin, xmax, ymin, ymax – the ranges of the x and y axes.
**kwds – all additional inputs are passed onto the rendering command. E.g., use figsize to adjust the resolution and aspect ratio.

EXAMPLES:

sage: x = SR.var("x")
sage: a = animate([sin(x + float(k)) for k in srange(0, 2*pi, 0.3)],
....:             xmin=0, xmax=2*pi, figsize=[2,1])
sage: print(a)
Animation with 21 frames
sage: print(a[:5])
Animation with 5 frames
sage: a.show()              # long time  # optional -- ImageMagick
sage: a[:5].show()          # long time  # optional -- ImageMagick

The show() method takes arguments to specify the delay between frames (measured in hundredths of a second, default value 20) and the number of iterations (default value 0, which means to iterate forever). To iterate 4 times with half a second between each frame:

sage: a.show(delay=50, iterations=4)  # long time  # optional -- ImageMagick

An animation of drawing a parabola:

sage: step = 0.1
sage: L = Graphics()
sage: v = []
sage: for i in srange(0, 1, step):
....:     L += line([(i,i^2),(i+step,(i+step)^2)], rgbcolor=(1,0,0), thickness=2)
....:     v.append(L)
sage: a = animate(v, xmin=0, ymin=0)
sage: a.show()              # long time  # optional -- ImageMagick
sage: show(L)

apng(savefile=None, show_path=False, delay=20, iterations=0)#

Creates an animated PNG composed from rendering the graphics objects in self. Return the absolute path to that file.

Notice that not all web browsers are capable of displaying APNG files, though they should still present the first frame of the animation as a fallback.

The generated file is not optimized, so it may be quite large.

Input:

delay - (default: 20) delay in hundredths of a second between frames
savefile - file that the animated gif gets saved to
iterations - integer (default: 0); number of iterations of animation. If 0, loop forever.
show_path - boolean (default: False); if True, print the path to the saved file

EXAMPLES:

sage: x = SR.var("x")
sage: a = animate([sin(x + float(k))
....:              for k in srange(0,2*pi,0.7)],
....:             xmin=0, xmax=2*pi, figsize=[2,1])
sage: dir = tmp_dir()
sage: a.apng(show_path=True)  # long time
Animation saved to ....png.
sage: a.apng(savefile=dir + 'my_animation.png', delay=35, iterations=3)  # long time
sage: a.apng(savefile=dir + 'my_animation.png', show_path=True)  # long time
Animation saved to .../my_animation.png.

If the individual frames have different sizes, an error will be raised:

sage: a = animate([plot(sin(x), (x, 0, k))
....:              for k in range(1,4)],
....:             ymin=-1, ymax=1, aspect_ratio=1, figsize=[2,1])
sage: a.apng()  # long time
Traceback (most recent call last):
...
ValueError: Chunk IHDR mismatch

ffmpeg(savefile=None, show_path=False, output_format=None, ffmpeg_options='', delay=None, iterations=0, pix_fmt='rgb24')#

Return a movie showing an animation composed from rendering the frames in self.

This method will only work if ffmpeg is installed. See https://www.ffmpeg.org for information about ffmpeg.

INPUT:

savefile – file that the mpeg gets saved to.

Warning

This will overwrite savefile if it already exists.

show_path – boolean (default: False); if True, print the path to the saved file
output_format - string (default: None); format and suffix to use for the video. This may be 'mpg', 'mpeg', 'avi', 'gif', or any other format that ffmpeg can handle. If this is None and the user specifies savefile with a suffix, say savefile='animation.avi', try to determine the format ('avi' in this case) from that file name. If no file is specified or if the suffix cannot be determined, 'mpg' is used.
ffmpeg_options - string (default: ''); this string is passed directly to ffmpeg.
delay - integer (default: None); delay in hundredths of a second between frames. The framerate is 100/delay. This is not supported for mpeg files: for mpegs, the frame rate is always 25 fps.
iterations - integer (default: 0); number of iterations of animation. If 0, loop forever. This is only supported for animated gif output and requires ffmpeg version 0.9 or later. For older versions, set iterations=None.
pix_fmt - string (default: ‘rgb24’); used only for gif output. Different values such as ‘rgb8’ or ‘pal8’ may be necessary depending on how ffmpeg was installed. Set pix_fmt=None to disable this option.

If savefile is not specified: in notebook mode, display the animation; otherwise, save it to a default file name. Use sage.misc.verbose.set_verbose() with level=1 to see additional output.

EXAMPLES:

sage: x = SR.var("x")
sage: a = animate([sin(x + float(k))
....:              for k in srange(0, 2*pi, 0.7)],
....:             xmin=0, xmax=2*pi, ymin=-1, ymax=1, figsize=[2,1])
sage: td = tmp_dir()
sage: a.ffmpeg(savefile=td + 'new.mpg')                  # long time  # optional -- FFmpeg
sage: a.ffmpeg(savefile=td + 'new.avi')                  # long time  # optional -- FFmpeg
sage: a.ffmpeg(savefile=td + 'new.gif')                  # long time  # optional -- FFmpeg
sage: a.ffmpeg(savefile=td + 'new.mpg', show_path=True)  # long time  # optional -- FFmpeg
Animation saved to .../new.mpg.

Note

If ffmpeg is not installed, you will get an error message like this:

FeatureNotPresentError: ffmpeg is not available.
Executable 'ffmpeg' not found on PATH.
Further installation instructions might be available at https://www.ffmpeg.org/.

gif(delay=20, savefile=None, iterations=0, show_path=False, use_ffmpeg=False)#

Returns an animated gif composed from rendering the graphics objects in self.

This method will only work if either (a) the ImageMagick software suite is installed, i.e., you have the convert command or (b) ffmpeg is installed. See the web sites of ImageMagick and FFmpeg for more details. By default, this produces the gif using convert if it is present. If this can’t find convert or if use_ffmpeg is True, then it uses ffmpeg instead.

INPUT:

delay - (default: 20) delay in hundredths of a second between frames
savefile - file that the animated gif gets saved to
iterations - integer (default: 0); number of iterations of animation. If 0, loop forever.
show_path - boolean (default: False); if True, print the path to the saved file
use_ffmpeg - boolean (default: False); if True, use ‘ffmpeg’ by default instead of ‘convert’.

If savefile is not specified: in notebook mode, display the animation; otherwise, save it to a default file name.

EXAMPLES:

sage: x = SR.var("x")
sage: a = animate([sin(x + float(k))
....:              for k in srange(0,2*pi,0.7)],
....:             xmin=0, xmax=2*pi, ymin=-1, ymax=1, figsize=[2,1])
sage: td = tmp_dir()
sage: a.gif()              # not tested
sage: a.gif(savefile=td + 'my_animation.gif',               # long time  # optional -- ImageMagick
....:       delay=35, iterations=3)
sage: with open(td + 'my_animation.gif', 'rb') as f:        # long time  # optional -- ImageMagick
....:     print(b'GIF8' in f.read())
True
sage: a.gif(savefile=td + 'my_animation.gif',               # long time  # optional -- ImageMagick
....:       show_path=True)
Animation saved to .../my_animation.gif.
sage: a.gif(savefile=td + 'my_animation_2.gif',             # long time  # optional -- FFmpeg
....:       show_path=True, use_ffmpeg=True)
Animation saved to .../my_animation_2.gif.

Note

If neither ffmpeg nor ImageMagick is installed, you will get an error message like this:

Error: Neither ImageMagick nor ffmpeg appears to be installed. Saving an
animation to a GIF file or displaying an animation requires one of these
packages, so please install one of them and try again.

See www.imagemagick.org and www.ffmpeg.org for more information.

graphics_array(ncols=3)#

Return a sage.plot.multigraphics.GraphicsArray with plots of the frames of this animation, using the given number of columns. The frames must be acceptable inputs for sage.plot.multigraphics.GraphicsArray.

EXAMPLES:

sage: # needs sage.schemes
sage: E = EllipticCurve('37a')
sage: v = [E.change_ring(GF(p)).plot(pointsize=30)
....:      for p in [97, 101, 103]]
sage: a = animate(v, xmin=0, ymin=0, axes=False)
sage: print(a)
Animation with 3 frames
sage: a.show()                      # optional -- ImageMagick

Modify the default arrangement of array:

sage: g = a.graphics_array(); print(g)                                      # needs sage.schemes
Graphics Array of size 1 x 3
sage: g.show(figsize=[6,3])                                                 # needs sage.schemes

Specify different arrangement of array and save it with a given file name:

sage: g = a.graphics_array(ncols=2); print(g)                               # needs sage.schemes
Graphics Array of size 2 x 2
sage: f = tmp_filename(ext='.png'); print(f)                                # needs sage.schemes
...png
sage: g.save(f)                                                             # needs sage.schemes

Frames can be specified as a generator too; it is internally converted to a list:

sage: t = SR.var("t")
sage: b = animate((plot(sin(c*pi*t)) for c in sxrange(1,2,.2)))
sage: g = b.graphics_array()
sage: print(g)
Graphics Array of size 2 x 3

interactive(**kwds)#

Create an interactive depiction of the animation.

INPUT:

**kwds – any of the viewing options accepted by show() are valid as keyword arguments to this function and they will behave in the same way. Those that are animation-related and recognized by the Three.js viewer are: animate, animation_controls, auto_play, delay, and loop.

OUTPUT:

A 3D graphics object which, by default, will use the Three.js viewer.

EXAMPLES:

sage: x = SR.var("x")
sage: frames = [point3d((sin(x), cos(x), x))
....:           for x in (0, pi/16, .., 2*pi)]
sage: animate(frames).interactive(online=True)
Graphics3d Object

Works with frames that are 2D or 3D graphics objects or convertible to 2D or 3D graphics objects via a plot or plot3d method:

sage: frames = [dodecahedron(), circle(center=(0, 0), radius=1), x^2]
sage: animate(frames).interactive(online=True, delay=100)
Graphics3d Object

See also

Three.js JavaScript WebGL Renderer

make_image(frame, filename, **kwds)#

Given a frame which has no save_image() method, make a graphics object and save it as an image with the given filename. By default, this is sage.plot.plot.plot(). To make animations of other objects, override this method in a subclass.

EXAMPLES:

sage: from sage.plot.animate import Animation
sage: class MyAnimation(Animation):
....:    def make_image(self, frame, filename, **kwds):
....:        P = parametric_plot(frame[0], frame[1], **frame[2])
....:        P.save_image(filename,**kwds)

sage: t = SR.var("t")
sage: x = lambda t: cos(t)
sage: y = lambda n,t: sin(t)/n
sage: B = MyAnimation([([x(t), y(i+1,t)], (t,0,1),
....:                   {'color':Color((1,0,i/4)), 'aspect_ratio':1, 'ymax':1})
....:                  for i in range(4)])

sage: d = B.png(); v = os.listdir(d); v.sort(); v  # long time
['00000000.png', '00000001.png', '00000002.png', '00000003.png']
sage: B.show()  # not tested

sage: class MyAnimation(Animation):
....:    def make_image(self, frame, filename, **kwds):
....:        G = frame.plot()
....:        G.set_axes_range(floor(G.xmin()), ceil(G.xmax()),
....:                         floor(G.ymin()), ceil(G.ymax()))
....:        G.save_image(filename, **kwds)

sage: B = MyAnimation([graphs.CompleteGraph(n)
....:                  for n in range(7,11)], figsize=5)
sage: d = B.png()
sage: v = os.listdir(d); v.sort(); v
['00000000.png', '00000001.png', '00000002.png', '00000003.png']
sage: B.show()  # not tested

png(dir=None)#

Render PNG images of the frames in this animation, saving them in dir. Return the absolute path to that directory. If the frames have been previously rendered and dir is None, just return the directory in which they are stored.

When dir is other than None, force re-rendering of frames.

INPUT:

dir – Directory in which to store frames. Default None; in this case, a temporary directory will be created for storing the frames.

OUTPUT:

Absolute path to the directory containing the PNG images

EXAMPLES:

sage: x = SR.var("x")
sage: a = animate([plot(x^2 + n) for n in range(4)], ymin=0, ymax=4)
sage: d = a.png(); v = os.listdir(d); v.sort(); v  # long time
['00000000.png', '00000001.png', '00000002.png', '00000003.png']

save(filename=None, show_path=False, use_ffmpeg=False, **kwds)#

Save this animation.

INPUT:

filename - (default: None) name of save file
show_path - boolean (default: False); if True, print the path to the saved file
use_ffmpeg - boolean (default: False); if True, use ‘ffmpeg’ by default instead of ‘convert’ when creating GIF files.

If filename is None, then in notebook mode, display the animation; otherwise, save the animation to a GIF file. If filename ends in ‘.html’, save an interactive() version of the animation to an HTML file that uses the Three.js viewer. If filename ends in ‘.sobj’, save to an sobj file. Otherwise, try to determine the format from the filename extension (‘.mpg’, ‘.gif’, ‘.avi’, etc.). If the format cannot be determined, default to GIF.

For GIF files, either ffmpeg or the ImageMagick suite must be installed. For other movie formats, ffmpeg must be installed. sobj and HTML files can be saved with no extra software installed.

EXAMPLES:

sage: x = SR.var("x")
sage: a = animate([sin(x + float(k))
....:              for k in srange(0, 2*pi, 0.7)],
....:             xmin=0, xmax=2*pi, ymin=-1, ymax=1, figsize=[2,1])
sage: td = tmp_dir()
sage: a.save()         # not tested
sage: a.save(td + 'wave.gif')                   # long time  # optional -- ImageMagick
sage: a.save(td + 'wave.gif', show_path=True)   # long time  # optional -- ImageMagick
Animation saved to file .../wave.gif.
sage: a.save(td + 'wave.avi', show_path=True)   # long time  # optional -- FFmpeg
Animation saved to file .../wave.avi.
sage: a.save(td + 'wave0.sobj')
sage: a.save(td + 'wave1.sobj', show_path=True)
Animation saved to file .../wave1.sobj.
sage: a.save(td + 'wave0.html', online=True)
sage: a.save(td + 'wave1.html', show_path=True, online=True)
Animation saved to file .../wave1.html.

show(delay=None, iterations=None, **kwds)#

Show this animation immediately.

This method attempts to display the graphics immediately, without waiting for the currently running code (if any) to return to the command line. Be careful, calling it from within a loop will potentially launch a large number of external viewer programs.

INPUT:

delay – (default: 20) delay in hundredths of a second between frames.
iterations – integer (default: 0); number of iterations of animation. If 0, loop forever.
format - (default: gif) format to use for output. Currently supported formats are: gif, ogg, webm, mp4, flash, matroska, avi, wmv, quicktime.

OUTPUT:

This method does not return anything. Use save() if you want to save the figure as an image.

Note

Currently this is done using an animated gif, though this could change in the future. This requires that either ffmpeg or the ImageMagick suite (in particular, the convert command) is installed.