A plugin for making animations in napari
napari-animation is a plugin for making animations in napari.
napari-animation provides a framework for the creation of animations in napari and features:
- an easy to use GUI for interactive creation of animations
- Python tools for programmatic creation of animations
This plugin is currently pre-release and under active development. APIs are likely to change before it's first 0.0.1 release, but feedback and contributions are welcome.
You can clone this repository with install locally with
pip install -e .
Examples can be found in our examples folder. Simple examples for both interactive and headless use of the plugin follow.
napari-animation can be used interactively by creating an
AnimationWidget from a napari
Viewer and adding it to
the viewer as a dock widget.
from napari_animation import AnimationWidget animation_widget = AnimationWidget(viewer) viewer.window.add_dock_widget(animation_widget, area='right')
napari-animation can also be run headless, allowing for reproducible, scripted creation of animations.
from napari_animation import Animation animation = Animation(viewer) viewer.dims.ndisplay = 3 viewer.camera.angles = (0.0, 0.0, 90.0) animation.capture_keyframe() viewer.camera.zoom = 2.4 animation.capture_keyframe() viewer.camera.angles = (-7.0, 15.7, 62.4) animation.capture_keyframe(steps=60) viewer.camera.angles = (2.0, -24.4, -36.7) animation.capture_keyframe(steps=60) viewer.reset_view() viewer.camera.angles = (0.0, 0.0, 90.0) animation.capture_keyframe() animation.animate('demo.mov', canvas_only=False)
Is everything animate-able?
Unfortunately, not yet! Currently differences in the following objects are tracked by the
Support for more layer attributes will be added in future releases.
Contributions are very welcome. Tests and additional infrastructure are being setup.
Distributed under the terms of the BSD-3 license, "napari-animation" is free and open source software
If you encounter any problems, please file an issue along with a detailed description.
- 13 May 2021
- 23 April 2021
- 3 - Alpha
- BSD 3-Clause
- Stars: 30
- Forks: 10
- Issues + PRs: 18
Python versions supported:
- OS Independent
- napari (>=0.4.5)
- napari-plugin-engine (>=0.1.9)