expyriment.control.defaults

Default settings for the control package.

audiosystem_autostart : bool
    start the audiosystem when Expyriment is initialized
    
audiosystem_bit_depth : int
    the audio bit depth; negative values mean signed sample values
    
audiosystem_buffer_size: int
    the audio buffer size in samples
    
audiosystem_channels : int
    the number of audio channels
    
audiosystem_sample_rate : int
    the audio sample rate
    
auto_create_subject_id : bool
    create a subject id automatically when starting an experiment
    
event_logging : int or bool
    O/False = no event logging
    1       = normal event logging (logging of all input & output events)
    2       = intensive logging; logs much more; use only for debugging
              purposes
    
    NOTES
    =====
    In most cases, it should be avoided to switch of logging (loglevel=0).
    If log files become to big due to certain repetitive events, it is
    suggested to switch of the logging of individual stimuli or IO event
    (see the method .set_logging() of this object).
    The logging of all events can also be changed via
    expyriment.design.Experiment().set_logging.
    
fast_quit : bool
    quit immediately without showing a goodbye message
    
goodbye_delay : int
    duration (in milliseconds) to show the goodbye text
    
goodbye_text : str
    the text to be shown when ending an experiment
    
initialize_delay : int
    a delay (in seconds) to wait before running an experiment to give
    Python time to start properly
    
    NOTES
    =====
    Python needs about 10 seconds to start up properly. Before that,
    timing accuracy can be worse.
    
open_gl : int or bool
    0/False = no OpenGL (no vsync / no blocking)
    1       = OpenGL (vsync / no blocking)
    2       = OpenGL (vsync / blocking)
    3       = OpenGL (vsync / alternative blocking)
    
    NOTES
    =====
    no OpenGL (no vsync / no blocking)
    ----------------------------------
    * Short preloading times
        Pygame is used to write directly to the display
    * Unsynchronized display updating
        Pixels are starting to change at wherever the vertical retrace is
        at the moment of presentation
    
    This mode can be useful for dynamic displays, where an accurate
    stimulus timing is not required, but rather very fast display changes
    have high priority and stimuli have to be created and on the fly (e.g.
    questionnairs, video game-like scenarios).
    
    OpenGL (vsync / no blocking)
    ----------------------------
    * Longer preloading times
        OpenGL is used to write to the display and a conversion to an
        OpenGL texture is needed
    * Synchronized display updating
        Pixels are starting to change always when the vertical retrace is
        at the left top corner
    * Innaccurate presentation time reporting
        Exact time of pixels changing on screen is not known
        
    This mode can be useful for dynamic displays, where an accurate
    stimulus timing is not required, but rather fast and fluid (e.g.
    non-tearing) display changes have high priority and preloaded stimuli
    can be used (e.g. well-controlled motion stimuli).

    OpenGL (vsync / blocking)
    -------------------------
    * Longer preloading times
        OpenGL is used to write to the display and a conversion to an
        OpenGL texture is needed
    * Synchronized display updating
        Pixels are starting to change always when the vertical retrace is
        at the left top corner
    * Accurate presentation time reporting
        present() method will only return when all drawing has been
        finished

    This can be useful for static stimulus presentation, where getting an
    accurate  presentation time report is of highest priority. Since this
    will be the case for most psychological and neuroscientific settings,
    it is the default mode used by Expyriment.

    OpenGL (vsync / alternative blocking)
    -------------------------------------
    * Longer preloading times
        OpenGL is used to write to the display and a conversion to an
        OpenGL texture is needed
    * Synchronized display updating
        Pixels are starting to change always when the vertical retrace is
        at the left top corner
    * Accurate presentation time reporting (alternative method)
        present() method will only return when all drawing has been
        finished and the then empty back buffer is available for drawing
        on it again

    This can be useful for static stimulus presentation, where getting an
    accurate presentation time report is of highest priority and the
    former mode does not work correctly (due to different video card
    driver implementations).
    
pause_key : int
    the key to be used for pausing an experiment
    
quit_key : int
    the key to be used for ending an experiment
    
refresh_key : int
    the key to be used for refreshing the screen
    
stdout_logging: bool
    log errors and warnings which go to the standard output (terminal
    window)
    
window_mode : bool
    run experiment in window instead of fullscreen
    
window_size : (int, int)
    the size of the window when running in window mode

Attributes

expyriment.control.defaults.audiosystem_autostart

default value: True

expyriment.control.defaults.audiosystem_bit_depth

default value: -16

expyriment.control.defaults.audiosystem_buffer_size

default value: 2048

expyriment.control.defaults.audiosystem_channels

default value: 2

expyriment.control.defaults.audiosystem_sample_rate

default value: 44100

expyriment.control.defaults.auto_create_subject_id

default value: False

expyriment.control.defaults.event_logging

default value: 1

expyriment.control.defaults.fast_quit

default value: False

expyriment.control.defaults.goodbye_delay

default value: 3000

expyriment.control.defaults.goodbye_text

default value: ‘Ending experiment...’

expyriment.control.defaults.initialize_delay

default value: 10

expyriment.control.defaults.open_gl

default value: 2

expyriment.control.defaults.pause_key

default value: None

expyriment.control.defaults.quit_key

default value: 27

expyriment.control.defaults.refresh_key

default value: None

expyriment.control.defaults.stdout_logging

default value: True

expyriment.control.defaults.window_mode

default value: False

expyriment.control.defaults.window_size

default value: (800, 600)

Modules

Classes

Functions