OpenSesame videos
Python videos

Image functions

class image

The image widget is used to display a non-interactive image.

Example (OpenSesame script):

widget 0 0 1 1 image path='5.png'

Example (Python):

from libopensesame import widgets
form = widgets.form(exp)
# The full path to the image needs to be provided.
# self.experiment.pool can be used to retrieve the full path
# to an image in the file pool.
image = widgets.image(form, path=pool['5.png'])
form.set_widget(image, (0,0))

function image.__init__(form, path=None, adjust=True, frame=False)



  • form -- The parent form.
    • Type: form


  • path -- The full path to the image. To show an image from the file pool, you need to first use experiment.get_file to determine the full path to the image.
    • Type: str, unicode, NoneType
    • Default: None
  • adjust -- Indicates whether the image should be scaled according to the size of the widget.
    • Type: bool
    • Default: True
  • frame -- Indicates whether a frame should be drawn around the widget.
    • Type: bool
    • Default: False

function image.draw_frame(rect=None, style=u'normal')

Draws a simple frame around the widget.


  • rect -- A (left, top, width, height) tuple for the frame geometry or None to use the widget geometry.
    • Type: tuple, NoneType
    • Default: None
  • style -- A visual style. Should be 'normal', 'active', or 'light'.
    • Type: str, unicode
    • Default: 'normal'

function image.on_mouse_click(pos)

Is called whenever the user clicks on the widget.


  • pos -- An (x, y) coordinates tuple.
    • Type: tuple

function image.render()

Draws the widget.

function image.set_rect(rect)

Sets the widget geometry.


  • rect -- A (left, top, width, height) tuple.
    • Type: tuple

function image.set_var(val, var=None)

Sets an experimental variable.


  • val -- A value.


  • var -- A variable name, or None to use widget default.
    • Type: str, unicode, NoneType
    • Default: None
Supported by Supported by