OpenSesame Plug-in: Screenshot
An OpenSesame plug-in for saving screenshots of stimuli and other screens within an experiment.
Copyright, 2024, Bob Rosbag
About
This plug-in saves screenshots of stimuli and other screens within an experiment.
The screenshots are saved in the folder of the log file, in a subfolder per capture method and subject, for example screenshots_stim_psycho/subject-1/filename.png.
This plug-in has the following options:
- Verbose mode: print the path of each saved screenshot.
- Stimulus display (PsychoPy): capture the PsychoPy window, saved in
screenshots_stim_psycho. Only available with the PsychoPy backend. - Stimulus display (PIL): capture the first monitor with PIL, saved in
screenshots_stim_pil. - Composite of all displays (PIL): capture all monitors with PIL, saved in
screenshots_full_pil. - Filename: the filename with extension; the extension determines the picture format (
.png,.jpg, etc.). Variables can be used, e.g.trial_[count_trial_sequence].png. The filename can't contain a folder.
Known issues
Which capture method works depends on the operating system and the display server. Check the screenshots of a test run before you rely on them.
| System | Stimulus display (PsychoPy) | Stimulus display and composite (PIL) |
|---|---|---|
| Linux, X11 | works (see below for the first screenshot) | works |
| Linux, Wayland | black images | works |
| Windows | works | shows the desktop behind a fullscreen experiment, not the stimulus |
- Linux, X11, PsychoPy: the first screenshot of the experiment can be corrupt (dark, with a diagonal line). The plugin prevents this by reading the screen once when the first screenshot item is prepared, before the stimulus is shown. This doesn't help when the first screenshot item is prepared after its stimulus was shown, e.g. a screenshot item in a loop that directly follows the stimulus. Workaround: put a screenshot item with its own filename (e.g.
dummy.png) at the start of the experiment, outside the trials, and ignore its screenshot. - Linux, Wayland, PsychoPy: all screenshots are black. Workaround: use the PIL options, or log in to an X11 session (e.g. "Ubuntu on Xorg").
- Windows, PIL: the screenshots show the desktop behind the fullscreen experiment window. Workaround: use the PsychoPy option.
- Without a graphics card (e.g. a virtual X server such as Xvfb, which uses Mesa's software renderer), PsychoPy screenshots are black too.
License
This software is distributed under the terms of the GNU General Public License 3. The full license should be included in the file COPYING, or can be obtained from:
This plug-in contains works of others. Icons are derivatives of the Faenza icon theme.
Documentation
Installation instructions and documentation on OpenSesame are available on the documentation website:
1 maintainer
Metadata
1 maintainer
Release files for opensesame-plugin-screenshot 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| opensesame_plugin_screenshot-0.8.0.tar.gz | 20.3 kB | Without provenance | Details for opensesame_plugin_screenshot-0.8.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| opensesame_plugin_screenshot-0.8.0-py3-none-any.whl | Python 3 | none | any | Details for opensesame_plugin_screenshot-0.8.0-py3-none-any.whl |
Total release size: 42.5 kB
Release files / opensesame_plugin_screenshot-0.8.0.tar.gz
| Download URL | opensesame_plugin_screenshot-0.8.0.tar.gz |
|---|---|
| Size | 20.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f0ff458b6095c401026d550d4931517faea0f24848b0e01cd00b1078c4f84371
|
|
BLAKE2b-256 checksum How to use checksums |
5e8abd60b5e62015032bede05ec531983763e855677d61c72204656110793af1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Release files / opensesame_plugin_screenshot-0.8.0-py3-none-any.whl
| Download URL | opensesame_plugin_screenshot-0.8.0-py3-none-any.whl |
|---|---|
| Size | 22.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
971c6a418ca63ebb4ad285edda75d1d72b609290f8e0df9f166498016e284d32
|
|
BLAKE2b-256 checksum How to use checksums |
2998a24df30bdb5c331955665333caca2421145bfb6bcde7b254fc6fe25eb3f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Security for opensesame-plugin-screenshot 0.8.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
