基于Python的OpenSesame实验心理学软件设计源码

#-*- coding:utf-8 -*- """ This file is part of OpenSesame. OpenSesame is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. OpenSesame is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenSesame. If not, see <http://www.gnu.org/licenses/>. """ from libopensesame.py3compat import * import warnings import random import pygame import math from libopensesame.exceptions import osexception from libopensesame.html import html from openexp.backend import backend, configurable from openexp.color import color class canvas(backend): """ desc: | The `canvas` class is used to present visual stimuli. __Example__: ~~~ .python # Create and show a canvas with a central fixation dot my_canvas = canvas() my_canvas.fixdot() my_canvas.show() ~~~ If drawing on a `canvas` is slow, especially if you draw many stimuli, you should disable `auto_prepare` and explicitly call `canvas.prepare()` after all drawing operations are done, but before calling `canvas.show()`. __Example__: ~~~ .python import random import string # Create and show a canvas with a grid of random letters my_canvas = canvas(auto_prepare=False) for x, y in xy_grid(n=10, spacing=20): letter = random.choice(string.ascii_uppercase) my_canvas.text(text=letter, x=x, y=y) my_canvas.prepare() my_canvas.show() ~~~ [TOC] ## Things to know ### Coordinates - When *Uniform coordinates* is set to 'yes', coordinates are relative to the center of the display. That is, (0,0) is the center. This is the default as of OpenSesame 3.0.0. - When *Uniform coordinates* is set to 'no', coordinates are relative to the top-left of the display. That is, (0,0) is the top-left. This was the default in OpenSesame 2.9.X and earlier. ### Style keywords All functions that accept `**style_args` take the following keyword arguments: - `color` specifies the foreground color. For valid color specifications, see [colors]. - `background_color` specifies the background color. For valid color specifications, see [colors]. - `fill` indicates whether rectangles, circles, polygons, and ellipses are filled (`True`), or drawn as an outline (`False`). - `penwidth` indicates a penwidth in pixels and should be `int` or `float`. - `bidi` indicates whether bidirectional-text support is enabled, and should be `True` or `False`. - `html` indicates whether HTML-tags are interpreted, and should be `True` or `False`. For supported tags, see [/usage/text/](). - `font_family` is the name of a font family, such as 'sans'. - `font_size` is a font size in pixels. - `font_italic` indicates whether text should italics, and should be `True` or `False`. - `font_bold` indicates whether text should bold, and should be `True` or `False`. - `font_underline` indicates whether text should underlined, and should be `True` or `False`. ~~~ .python # Draw a green fixation dot my_canvas = canvas() my_canvas.fixdot(color='green') my_canvas.show() ~~~ Style keywords only affect the current drawing operation (except when passed to [canvas.\_\_init\_\_][__init__]). To change the style for all subsequent drawing operations, set style properties, such as [canvas.color], directly: ~~~ .python # Draw a red cross with a 2px penwidth my_canvas = canvas() my_canvas.color = u'red' my_canvas.penwidth = 2 my_canvas.line(-10, -10, 10, 10) my_canvas.line(-10, 10, 10, -10) my_canvas.show() ~~~ Or pass the style properties to [canvas.\_\_init\_\_][__init__]: ~~~ .python # Draw a red cross with a 2px penwidth my_canvas = canvas(color=u'red', penwidth=2) my_canvas.line(-10, -10, 10, 10) my_canvas.line(-10, 10, 10, -10) my_canvas.show() ~~~ ### Colors You can specify colors in the following CSS3-compatible ways: - __Color names:__ 'red', 'black', etc. A full list of valid color names can be found [here](http://www.w3.org/TR/SVG11/types.html#ColorKeywords). - __Seven-character hexadecimal strings:__ '#FF0000', '#000000', etc. Here, values range from '00' to 'FF', so that '#FF0000' is bright red. - __Four-character hexadecimal strings:__ '#F00', '#000', etc. Here, values range from '0' to 'F' so that '#F00' is bright red. - __RGB strings:__ 'rgb(255,0,0)', 'rgb(0,0,0)', etc. Here, values range from '0' to '255' so that 'rgb(255,0,0)' is bright red. - __RGB percentage strings:__ 'rgb(100%,0%,0%)', 'rgb(0%,0%,0%)', etc. Here, values range from '0%' to '100%' so that 'rgb(100%,0%,0%)' is bright red. - __RGB tuples:__ `(255, 0, 0)`, `(0, 0 ,0)`, etc. Here, values range from `0` to `255` so that `(255,0,0)' is bright red. - __Luminance values:__ `255`, `0`, etc. Here, values range from `0` to `255` so that `255` is white. ~~~ .python # Various ways to specify green my_canvas.fixdot(color=u'green') my_canvas.fixdot(color=u'#00ff00') my_canvas.fixdot(color=u'#0f0') my_canvas.fixdot(color=u'rgb(0,255,0)') my_canvas.fixdot(color=u'rgb(0%,100%,0%)') my_canvas.fixdot(color=(0,255,0)) # Specify a luminance value (white) my_canvas.fixdot(color=255) ~~~ %-- constant: arg_max_width: | The maximum width of the text in pixels, before wrapping to a new line, or `None` to wrap at screen edge. arg_bgmode: | Specifies whether the background is the average of col1 col2 ('avg', corresponding to a typical Gabor patch), or equal to col2 ('col2'), useful for blending into the background. Note: this parameter is ignored by the psycho backend, which uses increasing transparency for the background. arg_style: | Optional [style keywords] that specify the style of the current drawing operation. This does not affect subsequent drawing operations. --% """ def __init__(self, experiment, auto_prepare=True, **style_args): """ desc: | Constructor to create a new `canvas` object. You do not generally call this constructor directly, but use the `canvas()` function, which is described here: [/python/common/](). arguments: experiment: desc: The experiment object. type: experiment keywords: auto_prepare: desc: Indicates whether the canvas should be automatically prepared after each drawing operation, so that [canvas.show] will be maximally efficient. If auto_prepare is turned off, drawing operations may be faster, but [canvas.show] will take longer, unless [canvas.prepare] is explicitly called in advance. Generally, it only makes sense to disable auto_prepare when you want to draw a large number of stimuli, as in the second example above. Currently, the auto_prepare parameter only applies to the xpyriment backend, and is ignored by the other backends. type: bool keyword-dict: style_args: Optional [style keywords], which will be used as the default for all drawing operations on this `canvas`. example: | # Example 1: Show a central fixation dot. my_canvas = canvas() my_canvas.fixdot() my_canvas.show() # Example 2: Show many randomly positioned fixation dot. Here we # disable `auto_prepare`, so that drawing goes more quickly. from random import randint my_canvas = canvas(auto_prepare=False) for i in range(1000): x = randint(0, my_canvas.width) y = randint(0, my_canvas.height) my_canvas.fixdot(x, y) my_canvas.prepare() my_canvas.show() """ self.experiment = experiment self._width = self.experiment.var.