Create position from script and send them to the GUI - feature request

[romainGuiet]

Dear @team ,

Thank you for this great tool !

It would be nice if after creating the position from a script it would be possible to send them to the GUI (something like animation.send_keyframe() ? ), so one can eventually correct the order manually.

NOTE : when double-clicking on a key_frame in the GUI we can change the name, is it possible to do so using code ?

Thank you again ,

Romain

[alisterburt]

Hi @romainGuiet - thanks for the kind words!

It would be nice if after creating the position from a script it would be possible to send them to the GUI (something like animation.send_keyframe() ? ), so one can eventually correct the order manually.

Interesting! There is probably a hacky way to get this working already which might be enough for you... let me know what you think

import napari
from napari_animation._qt.animation_widget import AnimationWidget

viewer = napari.Viewer()
animation_widget = AnimationWidget(viewer)
animation = animation_widget.animation

# capture keyframes

Let me know if this does the sort of thing you're looking for

[alisterburt]

when double-clicking on a key_frame in the GUI we can change the name, is it possible to do so using code ?
Key frames have a name attribute

napari-animation/napari_animation/key_frame.py

Lines 19 to 42 in 78eef3e

	class KeyFrame:
	"""A single keyframe in the animation.
	Parameters
	----------
	viewer_state : napari_animation.ViewerState
	The state of the viewer at this keyframe.
	thumbnail : np.ndarray
	A thumbnail representing this keyframe.
	steps : int
	Number of interpolation steps between last keyframe and captured one.
	ease : callable, optional
	If provided this method should make from `[0, 1]` to `[0, 1]` and will
	be used as an easing function for the transition between the last state
	and captured one.
	name : str
	A name for the keyframe.
	"""
	viewer_state: ViewerState
	thumbnail: np.ndarray
	steps: int = 15
	ease: Easing = Easing.LINEAR
	name: str = "KeyFrame"

and are created here...

napari-animation/napari_animation/animation.py

Lines 79 to 80 in 78eef3e

	new_frame = KeyFrame.from_viewer(self.viewer, steps=steps, ease=ease)
	new_frame.name = f"Key Frame {next(self._keyframe_counter)}"

The list of key frames is available at Animation.key_frames

napari-animation/napari_animation/animation.py

Lines 17 to 29 in 78eef3e

	class Animation:
	"""Make animations using the napari viewer.
	Parameters
	----------
	viewer : napari.Viewer
	napari viewer.
	Attributes
	----------
	key_frames : list of KeyFrame
	List of key-frames in the animation.
	"""

So you could jump in there to modify them programmatically - whether or not those changes will be updated in the GUI I'm not sure without testing

[romainGuiet]

Thank you for your swift answer @alisterburt !

I'm probably doing something wrong because nothing different happened 😅

I tried with (or without) the napari-animation widget opened before running the lines below but no key_frame appeared in the widget ...

import napari
from napari_animation._qt.animation_widget import AnimationWidget

viewer = napari.Viewer()
animation_widget = AnimationWidget(viewer)
animation = animation_widget.animation

# capture keyframes
viewer.add_image( image_nd )

viewer3D.camera.angles = (0.0, 0.0, 0.0)
animation.capture_keyframe()

viewer3D.camera.angles = (0.0, 60.0, 90.0)
animation.capture_keyframe()

[alisterburt]

Strange... I was expecting that to work and I'm not sure why it doesn't, the 'view' you see should change whenever the model (the key frame list) changes

I could delve into this but I don't really need the feature myself and it would take more time than I have right now... maybe someone interested can try to take a look :)