window

CustomInteractorStyle() Manipulate the camera and interact with objects in the scene.
InTemporaryDirectory alias of tempfile.TemporaryDirectory
Renderer([parent]) Your scene class.
Scene Your scene class.
ShowManager([scene, title, size, …]) Class interface between the scene, the window and the interactor.
basestring alias of builtins.str
add(scene, a) Add a specific actor to the scene.
analyze_renderer(scene) Report number of actors on the scene.
analyze_scene(scene)
analyze_snapshot(im[, bg_color, colors, …]) Analyze snapshot from memory or file.
asbytes(s)
clear(scene) Remove all actors from the scene.
record([scene, cam_pos, cam_focal, …]) Record a video of your scene.
ren([background]) Create a Scene.
renderer([background]) Create a Scene.
rm(scene, a) Remove a specific actor from the scene.
rm_all(scene) Remove all actors from the scene.
show(scene[, title, size, png_magnify, …]) Show window with current scene.
snapshot(scene[, fname, size, offscreen, …]) Save a snapshot of the scene in a file or in memory.
warn Issue a warning, or maybe ignore it or raise an exception.

CustomInteractorStyle

class fury.window.CustomInteractorStyle[source]

Bases: vtkInteractionStylePython.vtkInteractorStyleUser

Manipulate the camera and interact with objects in the scene.

This interactor style allows the user to interactively manipulate (pan, rotate and zoom) the camera. It also allows the user to interact (click, scroll, etc.) with objects in the scene.

Several events handling methods from vtkInteractorStyleUser have been overloaded to allow the propagation of the events to the objects the user is interacting with.

In summary, while interacting with the scene, the mouse events are as follows:

- Left mouse button: rotates the camera
- Right mouse button: dollys the camera
- Mouse wheel: dollys the camera
- Middle mouse button: pans the camera
__init__()[source]

Init.

SetInteractor(interactor)[source]

Define new interactor.

add_active_prop(prop)[source]
add_callback(prop, event_type, callback, priority=0, args=[])[source]

Add a callback associated to a specific event for a VTK prop.

Parameters:
prop : vtkProp
event_type : event code
callback : function
priority : int
force_render()[source]

Causes the scene to refresh.

get_prop_at_event_position()[source]

Return the prop that lays at the event position.

on_char(obj, evt)[source]
on_key_press(obj, evt)[source]
on_key_release(obj, evt)[source]
on_left_button_down(obj, evt)[source]
on_left_button_up(obj, evt)[source]
on_middle_button_down(obj, evt)[source]
on_middle_button_up(obj, evt)[source]
on_mouse_move(obj, evt)[source]

On mouse move.

on_mouse_wheel_backward(obj, evt)[source]

On mouse wheel backward.

on_mouse_wheel_forward(obj, evt)[source]

On mouse wheel forward.

on_right_button_down(obj, evt)[source]
on_right_button_up(obj, evt)[source]
propagate_event(evt, *props)[source]
remove_active_prop(prop)[source]

InTemporaryDirectory

fury.window.InTemporaryDirectory

alias of tempfile.TemporaryDirectory

Renderer

class fury.window.Renderer(parent=None)[source]

Bases: fury.window.Scene

Your scene class.

This is an important object that is responsible for preparing objects e.g. actors and volumes for rendering. This is a more pythonic version of vtkRenderer proving simple methods for adding and removing actors but also it provides access to all the functionality available in vtkRenderer if necessary.

Deprecated since version 0.2.0: Renderer() will be removed in Fury 0.3.0, it is replaced by the class Scene()

__init__(parent=None)[source]

Init old class with a warning.

Scene

class fury.window.Scene[source]

Bases: vtkRenderingCorePython.vtkRenderer

Your scene class.

This is an important object that is responsible for preparing objects e.g. actors and volumes for rendering. This is a more pythonic version of vtkRenderer proving simple methods for adding and removing actors but also it provides access to all the functionality available in vtkRenderer if necessary.

__init__($self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

add(*actors)[source]

Add an actor to the scene.

azimuth(angle)[source]

Rotate scene’s camera.

Rotate the camera about the view up vector centered at the focal point. Note that the view up vector is whatever was set via SetViewUp, and is not necessarily perpendicular to the direction of projection. The result is a horizontal rotation of the camera.

background(color)[source]

Set a background color.

camera()[source]

Return the camera object.

camera_direction()[source]

Get camera direction.

Get the vector in the direction from the camera position to the focal point. This is usually the opposite of the ViewPlaneNormal, the vector perpendicular to the screen, unless the view is oblique.

camera_info()[source]

Return Camera information.

clear()[source]

Remove all actors from the scene.

dolly(value)[source]

Dolly In/Out scene’s camera.

Divide the camera’s distance from the focal point by the given dolly value. Use a value greater than one to dolly-in toward the focal point, and use a value less than one to dolly-out away from the focal point.

elevation(angle)[source]

Elevate scene’s camera.

Rotate the camera about the cross product of the negative of the direction of projection and the view up vector, using the focal point as the center of rotation. The result is a vertical rotation of the scene.

get_camera()[source]

Return Camera information: Position, Focal Point, View Up.

pitch(angle)[source]

Pitch scene’s camera.

Rotate the focal point about the cross product of the view up vector and the direction of projection, using the camera’s position as the center of rotation. The result is a vertical rotation of the camera.

projection(proj_type='perspective')[source]

Deside between parallel or perspective projection.

Parameters:
proj_type : str

Can be ‘parallel’ or ‘perspective’ (default).

reset_camera()[source]

Reset the camera to an automatic position given by the engine.

reset_camera_tight(margin_factor=1.02)[source]

Resets camera so the content fit tightly within the window.

Parameters:
margin_factor : float (optional)

Margin added around the content. Default: 1.02.

reset_clipping_range()[source]

Reset the camera to an automatic position given by the engine.

rm(actor)[source]

Remove a specific actor.

rm_all()[source]

Remove all actors from the scene.

roll(angle)[source]

Roll scene’s camera.

Rotate the camera about the direction of projection. This will spin the camera about its axis.

set_camera(position=None, focal_point=None, view_up=None)[source]

Set up camera position / Focal Point / View Up.

size()[source]

Scene size.

yaw(angle)[source]

Yaw scene’s camera.

Rotate the focal point about the view up vector, using the camera’s position as the center of rotation. Note that the view up vector is whatever was set via SetViewUp, and is not necessarily perpendicular to the direction of projection. The result is a horizontal rotation of the scene.

zoom(value)[source]

Rescale scene’s camera.

In perspective mode, decrease the view angle by the specified factor. In parallel mode, decrease the parallel scale by the specified factor. A value greater than 1 is a zoom-in, a value less than 1 is a zoom-out.

ShowManager

class fury.window.ShowManager(scene=None, title='FURY', size=(300, 300), png_magnify=1, reset_camera=True, order_transparent=False, interactor_style='custom')[source]

Bases: object

Class interface between the scene, the window and the interactor.

__init__(scene=None, title='FURY', size=(300, 300), png_magnify=1, reset_camera=True, order_transparent=False, interactor_style='custom')[source]

Manage the visualization pipeline.

Parameters:
scene : Scene() or vtkRenderer()

The scene that holds all the actors.

title : string

A string for the window title bar.

size : (int, int)

(width, height) of the window. Default is (300, 300).

png_magnify : int

Number of times to magnify the screenshot. This can be used to save high resolution screenshots when pressing ‘s’ inside the window.

reset_camera : bool

Default is True. You can change this option to False if you want to keep the camera as set before calling this function.

order_transparent : bool

True is useful when you want to order transparent actors according to their relative position to the camera. The default option which is False will order the actors according to the order of their addition to the Scene().

interactor_style : str or vtkInteractorStyle

If str then if ‘trackball’ then vtkInteractorStyleTrackballCamera() is used, if ‘image’ then vtkInteractorStyleImage() is used (no rotation) or if ‘custom’ then CustomInteractorStyle is used. Otherwise you can input your own interactor style.

Notes

Default interaction keys for

  • 3d navigation are with left, middle and right mouse dragging
  • resetting the camera press ‘r’
  • saving a screenshot press ‘s’
  • for quiting press ‘q’

Examples

>>> from fury import actor, window
>>> scene = window.Scene()
>>> scene.add(actor.axes())
>>> showm = window.ShowManager(scene)
>>> # showm.initialize()
>>> # showm.render()
>>> # showm.start()
Attributes:
scene : Scene() or vtkRenderer()
iren : vtkRenderWindowInteractor()
style : vtkInteractorStyle()
window : vtkRenderWindow()

Methods

initialize()  
render()  
start()  
add_window_callback()  
add_timer_callback(repeat, duration, timer_callback)[source]
add_window_callback(win_callback)[source]

Add window callbacks.

destroy_timer(timer_id)[source]
destroy_timers()[source]
exit()[source]

Close window and terminate interactor.

initialize()[source]

Initialize interaction.

play_events(events)[source]

Play recorded events of a past interaction.

The VTK events that happened during the recorded interaction will be played back.

Parameters:
events : str

Recorded events (one per line).

play_events_from_file(filename)[source]

Play recorded events of a past interaction.

The VTK events that happened during the recorded interaction will be played back from filename.

Parameters:
filename : str

Name of the file containing the recorded events (.log|.log.gz).

record_events()[source]

Record events during the interaction.

The recording is represented as a list of VTK events that happened during the interaction. The recorded events are then returned.

Returns:
events : str

Recorded events (one per line).

Notes

Since VTK only allows recording events to a file, we use a temporary file from which we then read the events.

record_events_to_file(filename='record.log')[source]

Record events during the interaction.

The recording is represented as a list of VTK events that happened during the interaction. The recording is going to be saved into filename.

Parameters:
filename : str

Name of the file that will contain the recording (.log|.log.gz).

render()[source]

Render only once.

start()[source]

Start interaction.

basestring

fury.window.basestring

alias of builtins.str

add

fury.window.add(scene, a)[source]

Add a specific actor to the scene.

Deprecated since version 0.2.0: ren will be removed in Fury 0.3.0, it is replaced by Scene().add

analyze_renderer

fury.window.analyze_renderer(scene)[source]

Report number of actors on the scene.

Deprecated since version 0.2.0: analyze_renderer will be removed in Fury 0.3.0, it is replaced by analyze_scene()

analyze_scene

fury.window.analyze_scene(scene)[source]

analyze_snapshot

fury.window.analyze_snapshot(im, bg_color=(0, 0, 0), colors=None, find_objects=True, strel=None)[source]

Analyze snapshot from memory or file.

Parameters:
im: str or array

If string then the image is read from a file otherwise the image is read from a numpy array. The array is expected to be of shape (X, Y, 3) or (X, Y, 4) where the last dimensions are the RGB or RGBA values.

colors: tuple (3,) or list of tuples (3,)

List of colors to search in the image

find_objects: bool

If True it will calculate the number of objects that are different from the background and return their position in a new image.

strel: 2d array

Structure element to use for finding the objects.

Returns:
report : ReportSnapshot

This is an object with attibutes like colors_found that give information about what was found in the current snapshot array im.

asbytes

fury.window.asbytes(s)[source]

clear

fury.window.clear(scene)[source]

Remove all actors from the scene.

Deprecated since version 0.2.0: ren will be removed in Fury 0.3.0, it is replaced by Scene().clear

record

fury.window.record(scene=None, cam_pos=None, cam_focal=None, cam_view=None, out_path=None, path_numbering=False, n_frames=1, az_ang=10, magnification=1, size=(300, 300), reset_camera=True, verbose=False)[source]

Record a video of your scene.

Records a video as a series of .png files of your scene by rotating the azimuth angle az_angle in every frame.

Parameters:
scene : Scene() or vtkRenderer() object

Scene instance

cam_pos : None or sequence (3,), optional

Camera’s position. If None then default camera’s position is used.

cam_focal : None or sequence (3,), optional

Camera’s focal point. If None then default camera’s focal point is used.

cam_view : None or sequence (3,), optional

Camera’s view up direction. If None then default camera’s view up vector is used.

out_path : str, optional

Output path for the frames. If None a default fury.png is created.

path_numbering : bool

When recording it changes out_path to out_path + str(frame number)

n_frames : int, optional

Number of frames to save, default 1

az_ang : float, optional

Azimuthal angle of camera rotation.

magnification : int, optional

How much to magnify the saved frame. Default is 1.

size : (int, int)

(width, height) of the window. Default is (300, 300).

reset_camera : bool
If True Call scene.reset_camera(). Otherwise you need to set the

camera before calling this function.

verbose : bool

print information about the camera. Default is False.

Examples

>>> from fury import window, actor
>>> scene = window.Scene()
>>> a = actor.axes()
>>> scene.add(a)
>>> # uncomment below to record
>>> # window.record(scene)
>>> #check for new images in current directory

ren

fury.window.ren(background=None)[source]

Create a Scene.

Deprecated since version 0.2.0: ren will be removed in Fury 0.3.0, it is replaced by Scene()

renderer

fury.window.renderer(background=None)[source]

Create a Scene.

Deprecated since version 0.2.0: renderer will be removed in Fury 0.3.0, it is replaced by the class Scene()

Parameters:
background : tuple

Initial background color of scene

Returns:
v : Scene instance

scene object

Examples

>>> from fury import window, actor
>>> import numpy as np
>>> r = window.renderer()
>>> lines=[np.random.rand(10,3)]
>>> c=actor.line(lines, window.colors.red)
>>> r.add(c)
>>> #window.show(r)

rm

fury.window.rm(scene, a)[source]

Remove a specific actor from the scene.

Deprecated since version 0.2.0: ren will be removed in Fury 0.3.0, it is replaced by Scene().rm

rm_all

fury.window.rm_all(scene)[source]

Remove all actors from the scene.

Deprecated since version 0.2.0: ren will be removed in Fury 0.3.0, it is replaced by Scene().rm_all

show

fury.window.show(scene, title='FURY', size=(300, 300), png_magnify=1, reset_camera=True, order_transparent=False)[source]

Show window with current scene.

Parameters:
scene : Scene() or vtkRenderer()

The scene that holds all the actors.

title : string

A string for the window title bar. Default is FURY and current version.

size : (int, int)

(width, height) of the window. Default is (300, 300).

png_magnify : int

Number of times to magnify the screenshot. Default is 1. This can be used to save high resolution screenshots when pressing ‘s’ inside the window.

reset_camera : bool

Default is True. You can change this option to False if you want to keep the camera as set before calling this function.

order_transparent : bool

True is useful when you want to order transparent actors according to their relative position to the camera. The default option which is False will order the actors according to the order of their addition to the Scene().

Notes

Default interaction keys for

  • 3d navigation are with left, middle and right mouse dragging
  • resetting the camera press ‘r’
  • saving a screenshot press ‘s’
  • for quiting press ‘q’

Examples

>>> import numpy as np
>>> from fury import window, actor
>>> r = window.Scene()
>>> lines=[np.random.rand(10,3),np.random.rand(20,3)]
>>> colors=np.array([[0.2,0.2,0.2],[0.8,0.8,0.8]])
>>> c=actor.line(lines,colors)
>>> r.add(c)
>>> l=actor.label(text="Hello")
>>> r.add(l)
>>> #window.show(r)

snapshot

fury.window.snapshot(scene, fname=None, size=(300, 300), offscreen=True, order_transparent=False)[source]

Save a snapshot of the scene in a file or in memory.

Parameters:
scene : Scene() or vtkRenderer

Scene instance

fname : str or None

Save PNG file. If None return only an array without saving PNG.

size : (int, int)

(width, height) of the window. Default is (300, 300).

offscreen : bool

Default True. Go stealthmode no window should appear.

order_transparent : bool

Default False. Use depth peeling to sort transparent objects.

Returns:
arr : ndarray

Color array of size (width, height, 3) where the last dimension holds the RGB values.

warn

fury.window.warn()

Issue a warning, or maybe ignore it or raise an exception.