window

Actor2D

alias of vtkmodules.vtkRenderingCore.vtkActor2D

Command

alias of vtkmodules.vtkCommonCore.vtkCommand

CustomInteractorStyle()

Manipulate the camera and interact with objects in the scene.

InTemporaryDirectory

alias of tempfile.TemporaryDirectory

InteractorEventRecorder

alias of vtkmodules.vtkRenderingCore.vtkInteractorEventRecorder

InteractorStyleImage

alias of vtkmodules.vtkInteractionStyle.vtkInteractorStyleImage

InteractorStyleTrackballCamera

alias of vtkmodules.vtkInteractionStyle.vtkInteractorStyleTrackballCamera

OpenGLRenderer

alias of vtkmodules.vtkRenderingOpenGL2.vtkOpenGLRenderer

RenderLargeImage

alias of vtkmodules.vtkFiltersHybrid.vtkRenderLargeImage

RenderWindow

alias of vtkmodules.vtkRenderingCore.vtkRenderWindow

RenderWindowInteractor

alias of vtkmodules.vtkRenderingCore.vtkRenderWindowInteractor

Scene([background, skybox])

Your scene class.

ShowManager([scene, title, size, ...])

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

Skybox

alias of vtkmodules.vtkRenderingCore.vtkSkybox

Volume

alias of vtkmodules.vtkRenderingCore.vtkVolume

WindowToImageFilter

alias of vtkmodules.vtkRenderingCore.vtkWindowToImageFilter

basestring

alias of str

analyze_scene(scene)

analyze_snapshot(im[, bg_color, colors, ...])

Analyze snapshot from memory or file.

antialiasing(scene, win[, multi_samples, ...])

Enable anti-aliasing and ordered transparency.

asbytes(s)

enable_stereo(renwin, stereo_type)

Enable the given stereo type on the RenderWindow.

gl_disable_blend(gl_state)

This it will disable any gl behavior which has no function for opaque objects.

gl_disable_depth(gl_state)

Disable OpenGl depth test

gl_enable_blend(gl_state)

Enable OpenGl blending

gl_enable_depth(gl_state)

Enable OpenGl depth test

gl_get_current_state(gl_state)

Returns a dict which describes the current state of the opengl context

gl_reset_blend(gl_state)

Redefines the state of the OpenGL context related with how the RGBA channels will be combined.

gl_set_additive_blending(gl_state)

Enable additive blending

gl_set_additive_blending_white_background(...)

Enable additive blending for a white background

gl_set_multiplicative_blending(gl_state)

Enable multiplicative blending

gl_set_normal_blending(gl_state)

Enable normal blending

gl_set_subtractive_blending(gl_state)

Enable subtractive blending

load_image(filename[, as_vtktype, use_pillow])

Load an image.

record([scene, cam_pos, cam_focal, ...])

Record a video of your scene.

save_image(arr, filename[, ...])

Save a 2d or 3d image.

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(message[, category, stacklevel, source])

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

Actor2D

fury.window.Actor2D

alias of vtkmodules.vtkRenderingCore.vtkActor2D

Command

fury.window.Command

alias of vtkmodules.vtkCommonCore.vtkCommand

CustomInteractorStyle

class fury.window.CustomInteractorStyle[source]

Bases: vtkmodules.vtkInteractionStyle.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

InteractorEventRecorder

fury.window.InteractorEventRecorder

alias of vtkmodules.vtkRenderingCore.vtkInteractorEventRecorder

InteractorStyleImage

fury.window.InteractorStyleImage

alias of vtkmodules.vtkInteractionStyle.vtkInteractorStyleImage

InteractorStyleTrackballCamera

fury.window.InteractorStyleTrackballCamera

alias of vtkmodules.vtkInteractionStyle.vtkInteractorStyleTrackballCamera

OpenGLRenderer

fury.window.OpenGLRenderer

alias of vtkmodules.vtkRenderingOpenGL2.vtkOpenGLRenderer

RenderLargeImage

fury.window.RenderLargeImage

alias of vtkmodules.vtkFiltersHybrid.vtkRenderLargeImage

RenderWindow

fury.window.RenderWindow

alias of vtkmodules.vtkRenderingCore.vtkRenderWindow

RenderWindowInteractor

fury.window.RenderWindowInteractor

alias of vtkmodules.vtkRenderingCore.vtkRenderWindowInteractor

Scene

class fury.window.Scene(background=(0, 0, 0), skybox=None)[source]

Bases: vtkmodules.vtkRenderingOpenGL2.vtkOpenGLRenderer

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 providing simple methods for adding and removing actors but also it provides access to all the functionality available in vtkRenderer if necessary.

__init__(background=(0, 0, 0), skybox=None)[source]
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.

property frame_rate
fxaa_off()[source]
fxaa_on()[source]
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]

Decide 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(*actors)[source]

Remove more than once actors at once.

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.

skybox(visible=True, gamma_correct=True)[source]

Show or hide the skybox.

Parameters
  • visible (bool) – Whether to show the skybox or not.

  • gamma_correct (bool) – Whether to apply gamma correction to the skybox or not.

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', stereo='off', multi_samples=8, max_peels=4, occlusion_ratio=0.0)[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', stereo='off', multi_samples=8, max_peels=4, occlusion_ratio=0.0)[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.

  • stereo (string) –

    Set the stereo type. Default is ‘off’. Other types include:

    • ’opengl’: OpenGL frame-sequential stereo. Referred to as ‘CrystalEyes’ by VTK.

    • ’anaglyph’: For use with red/blue glasses. See VTK docs to use different colors.

    • ’interlaced’: Line interlaced.

    • ’checkerboard’: Checkerboard interlaced.

    • ’left’: Left eye only.

    • ’right’: Right eye only.

    • ’horizontal’: Side-by-side.

  • multi_samples (int) – Number of samples for anti-aliazing (Default 8). For no anti-aliasing use 0.

  • max_peels (int) – Maximum number of peels for depth peeling (Default 4).

  • occlusion_ratio (float) – Occlusion ration for depth peeling (Default 0 - exact image).

scene
Type

Scene() or vtkRenderer()

iren
Type

vtkRenderWindowInteractor()

style
Type

vtkInteractorStyle()

window
Type

vtkRenderWindow()

initialize()[source]
render()[source]
start()[source]
add_window_callback()[source]

Examples

>>> from fury import actor, window
>>> scene = window.Scene()
>>> scene.add(actor.axes())
>>> showm = window.ShowManager(scene)
>>> # showm.initialize()
>>> # showm.render()
>>> # showm.start()
add_iren_callback(iren_callback, event='MouseMoveEvent')[source]
add_timer_callback(repeat, duration, timer_callback)[source]
add_window_callback(win_callback, event=33)[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 – Recorded events (one per line).

Return type

str

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.

Skybox

fury.window.Skybox

alias of vtkmodules.vtkRenderingCore.vtkSkybox

Volume

fury.window.Volume

alias of vtkmodules.vtkRenderingCore.vtkVolume

WindowToImageFilter

fury.window.WindowToImageFilter

alias of vtkmodules.vtkRenderingCore.vtkWindowToImageFilter

basestring

fury.window.basestring

alias of str

analyze_scene

fury.window.analyze_scene(scene)[source]

analyze_snapshot

fury.window.analyze_snapshot(im, bg_color=(0.0, 0.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 – This is an object with attibutes like colors_found that give information about what was found in the current snapshot array im.

Return type

ReportSnapshot

antialiasing

fury.window.antialiasing(scene, win, multi_samples=8, max_peels=4, occlusion_ratio=0.0)[source]

Enable anti-aliasing and ordered transparency.

Parameters
  • scene (Scene) –

  • win (Window) – Provided by ShowManager.window attribute.

  • multi_samples (int) – Number of samples for anti-aliasing (Default 8). For no anti-aliasing use 0.

  • max_peels (int) – Maximum number of peels for depth peeling (Default 4).

  • occlusion_ratio (float) – Occlusion ratio for depth peeling (Default 0 - exact image).

asbytes

fury.window.asbytes(s)[source]

enable_stereo

fury.window.enable_stereo(renwin, stereo_type)[source]

Enable the given stereo type on the RenderWindow.

Parameters
  • renwin (vtkRenderWindow) –

  • stereo_type (string) –

    • ‘opengl’: OpenGL frame-sequential stereo. Referred to as ‘CrystalEyes’ by VTK.

    • ’anaglyph’: For use with red/blue glasses. See VTK docs to use different colors.

    • ’interlaced’: Line interlaced.

    • ’checkerboard’: Checkerboard interlaced.

    • ’left’: Left eye only.

    • ’right’: Right eye only.

    • ’horizontal’: Side-by-side.

gl_disable_blend

fury.window.gl_disable_blend(gl_state)[source]

This it will disable any gl behavior which has no function for opaque objects. This has the benefit of speeding up the rendering of the image.

Parameters
  • gl_state (vtkOpenGLState) –

  • more (See) –

  • --------

  • https ([1]) –

gl_disable_depth

fury.window.gl_disable_depth(gl_state)[source]

Disable OpenGl depth test

Parameters

gl_state (vtkOpenGLState) –

gl_enable_blend

fury.window.gl_enable_blend(gl_state)[source]

Enable OpenGl blending

Parameters

gl_state (vtkOpenGLState) –

gl_enable_depth

fury.window.gl_enable_depth(gl_state)[source]

Enable OpenGl depth test

Parameters

gl_state (vtkOpenGLState) –

gl_get_current_state

fury.window.gl_get_current_state(gl_state)[source]

Returns a dict which describes the current state of the opengl context

Parameters

gl_state (vtkOpenGLState) –

gl_reset_blend

fury.window.gl_reset_blend(gl_state)[source]

Redefines the state of the OpenGL context related with how the RGBA channels will be combined.

Parameters
  • gl_state (vtkOpenGLState) –

  • more (See) –

  • ---------

  • https ([3]) –

  • https

  • specification (vtk) –

  • https

gl_set_additive_blending

fury.window.gl_set_additive_blending(gl_state)[source]

Enable additive blending

Parameters

gl_state (vtkOpenGLState) –

gl_set_additive_blending_white_background

fury.window.gl_set_additive_blending_white_background(gl_state)[source]

Enable additive blending for a white background

Parameters

gl_state (vtkOpenGLState) –

gl_set_multiplicative_blending

fury.window.gl_set_multiplicative_blending(gl_state)[source]

Enable multiplicative blending

Parameters

gl_state (vtkOpenGLState) –

gl_set_normal_blending

fury.window.gl_set_normal_blending(gl_state)[source]

Enable normal blending

Parameters

gl_state (vtkOpenGLState) –

gl_set_subtractive_blending

fury.window.gl_set_subtractive_blending(gl_state)[source]

Enable subtractive blending

Parameters

gl_state (vtkOpenGLState) –

load_image

fury.window.load_image(filename, as_vtktype=False, use_pillow=True)[source]

Load an image.

Parameters
  • filename (str) – should be png, bmp, jpeg or jpg files

  • as_vtktype (bool, optional) – if True, return vtk output otherwise an ndarray. Default False.

  • use_pillow (bool, optional) – Use pillow python library to load the files. Default True

Returns

image – desired image array

Return type

ndarray or vtk output

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, screen_clip=False, stereo='off', 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. A value greater than 1 increases the quality of the image. However, the output size will be larger. For example, 200x200 image with magnification of 2 will be a 400x400 image.

  • size ((int, int)) – (width, height) of the window. Default is (300, 300).

  • screen_clip (bool) – Clip the the png based on screen resolution. Default is False.

  • reset_camera (bool) –

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

    camera before calling this function.

  • stereo (string) –

    Set the stereo type. Default is ‘off’. Other types include:

    • ’opengl’: OpenGL frame-sequential stereo. Referred to as ‘CrystalEyes’ by VTK.

    • ’anaglyph’: For use with red/blue glasses. See VTK docs to use different colors.

    • ’interlaced’: Line interlaced.

    • ’checkerboard’: Checkerboard interlaced.

    • ’left’: Left eye only.

    • ’right’: Right eye only.

    • ’horizontal’: Side-by-side.

  • 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

save_image

fury.window.save_image(arr, filename, compression_quality=75, compression_type='deflation', use_pillow=True)[source]

Save a 2d or 3d image.

Expect an image with the following shape: (H, W) or (H, W, 1) or (H, W, 3) or (H, W, 4).

Parameters
  • arr (ndarray) – array to save

  • filename (string) – should be png, bmp, jpeg or jpg files

  • compression_quality (int, optional) – compression_quality for jpeg data. 0 = Low quality, 100 = High quality

  • compression_type (str, optional) – compression type for tiff file select between: None, lzw, deflation (default)

  • use_pillow (bool, optional) – Use imageio python library to save the files.

show

fury.window.show(scene, title='FURY', size=(300, 300), png_magnify=1, reset_camera=True, order_transparent=False, stereo='off', multi_samples=8, max_peels=4, occlusion_ratio=0.0)[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().

  • stereo (string) –

    Set the stereo type. Default is ‘off’. Other types include:

    • ’opengl’: OpenGL frame-sequential stereo. Referred to as ‘CrystalEyes’ by VTK.

    • ’anaglyph’: For use with red/blue glasses. See VTK docs to use different colors.

    • ’interlaced’: Line interlaced.

    • ’checkerboard’: Checkerboard interlaced.

    • ’left’: Left eye only.

    • ’right’: Right eye only.

    • ’horizontal’: Side-by-side.

  • multi_samples (int) – Number of samples for anti-aliazing (Default 8). For no anti-aliasing use 0.

  • max_peels (int) – Maximum number of peels for depth peeling (Default 4).

  • occlusion_ratio (float) – Occlusion ration for depth peeling (Default 0 - exact image).

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, stereo='off', multi_samples=8, max_peels=4, occlusion_ratio=0.0)[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 stealth mode no window should appear.

  • order_transparent (bool) – Default False. Use depth peeling to sort transparent objects. If True also enables anti-aliasing.

  • stereo (string) –

    Set the stereo type. Default is ‘off’. Other types include:

    • ’opengl’: OpenGL frame-sequential stereo. Referred to as ‘CrystalEyes’ by VTK.

    • ’anaglyph’: For use with red/blue glasses. See VTK docs to use different colors.

    • ’interlaced’: Line interlaced.

    • ’checkerboard’: Checkerboard interlaced.

    • ’left’: Left eye only.

    • ’right’: Right eye only.

    • ’horizontal’: Side-by-side.

  • multi_samples (int) – Number of samples for anti-aliazing (Default 8). For no anti-aliasing use 0.

  • max_peels (int) – Maximum number of peels for depth peeling (Default 4).

  • occlusion_ratio (float) – Occlusion ration for depth peeling (Default 0 - exact image).

Returns

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

Return type

ndarray

warn

fury.window.warn(message, category=None, stacklevel=1, source=None)

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