Giter Club home page Giter Club logo

napari-animation's Introduction

napari-animation (WIP under active development)

License PyPI Python Version tests codecov

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')

AnimationWidget image

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 and a detailed contributing guide is coming soon.

Tests are run with pytest.

We use pre-commit to sort imports with isort, format code with black, and lint with flake8 automatically prior to each commit. To minmize test errors when submitting pull requests, please install pre-commit in your environment as follows:

pre-commit install

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.

napari-animation's People

Contributors

alisterburt avatar sofroniewn avatar fifourche avatar tlambert03 avatar guiwitz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.