A plugin to make animations with napari
Project description
napari-animation (WIP under active development)
napari-animation is a plugin for making animations in napari.
This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.
It is built off of great work from @guiwitz in naparimovie which was initially submitted to napari in PR#851.
Overview
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.
Installation
You can clone this repository with install locally with
pip install -e .
Examples
Examples can be found in our examples folder. Simple examples for both interactive and headless use of the plugin follow.
Interactive
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')
Headless
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 Animation
class
Viewer.camera
Viewer.dims
Layer.scale
Layer.translate
Layer.rotate
Layer.shear
layer.opacity
Layer.blending
Layer.visible
Support for more layer attributes will be added in future releases.
Contributing
Contributions are very welcome. Tests and additional infrastructure are being setup.
License
Distributed under the terms of the BSD-3 license, "napari-animation" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for napari_animation-0.0.1rc3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8c2f6a033f9bd918e5d9e1ed1f74484c930ffcf5482996ff7094b6664766745 |
|
MD5 | 0dd67762d861e08c8e43b4484b397a1e |
|
BLAKE2b-256 | 60043708b4eff112945a44147a0e02993a2453a7d00c6d51b6dd6dedcbc4b95f |
Hashes for napari_animation-0.0.1rc3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a6fc5d93d81f21256d4a550464522b60d0b0ac5e9520c3a70faa2e372835a02 |
|
MD5 | e890e2db3fd132929605d6d12483f5fc |
|
BLAKE2b-256 | 00e5fad9b2324ed11acdb9e90144289fd0e652207398bb43ceb8b34b077b995d |