visualize ❭ cell_to_ipython_animation ❭ display_animation

display_animation

visualize.cell_to_ipython_animation.display_animation(files, interval=10, style=False, animID=None, embedded=False)

Creates an IPython animation out of files specified in a globstring or a list of paths.

Parameters:

  • files (str | list) – globstring or list of paths

  • interval (int) – time interval between frames

  • style (bool) – whether to use the style specified in the system default html_template.

  • animID – unique integer to identify the animation in the javascript environment of IPython

  • embedde (bool) – whether to embed the images as base64 in the html file.

Attention

The paths need to be relative to the location of the ipynb / html file, since the are resolved in the browser and not by python

Returns:

the animation object

Return type:

IPython.display.HTML

Note

Copyright (c) 2013, Jake Vanderplas All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.