stimpy package¶

Subpackages¶

stimpy.animate package

Submodules¶

stimpy.scene module¶

class stimpy.scene.Scene(color, units)¶

Bases: object

Class for grouping multiple stimuli.

Parameters

color (Tuple[int, int, int]) – Color of background as (r, g, b) tuple.
units (str) – Defines the default units of stimuli drawn.

add(stimulus_data, begin, dur)¶

property color¶

property units¶

stimpy.stim module¶

class stimpy.stim.StimulusData(stimulus_type, **kwargs)¶

Bases: object

Class for storing stimulus properties.

Parameters

stimulus_type (Type[BaseVisualStim]) – Type of visual stimulus.
kwargs – Keyword arguments for the constructor of stimulus_type.

property kwargs¶

property stimulus_type¶

stimpy.trial module¶

class stimpy.trial.Drawable(win, stimulus_data, begin, dur)¶

Bases: object

draw(t)¶

property end¶

reset()¶

class stimpy.trial.Trial(scene, win, dur=None, clear_buffer=True)¶

Bases: object

Trial for showing visual stimuli.

Parameters

scene (Scene) – Scene.
win (Window) – Psychopy window.
dur (Optional[float]) – Duration of the trial. Inferred from stimuli_properties if not provided.

save_movie(file_name, fps=60)¶

Save trial as movie.

Parameters

file_name (str) – File name for the movie to be saved.
fps – Frames per second.

Return type

None

start()¶

Start trial.

Return type: None

stimpy.visual module¶

class stimpy.visual.BoxStim(size=(0.5, 0.5, 0.5), flipFaces=False, pos=(0.0, 0.0, 0.0), ori=(0.0, 0.0, 0.0, 1.0), color=(0.0, 0.0, 0.0), colorSpace='rgb', contrast=1.0, opacity=1.0, useMaterial=None, useShaders=False, textureScale=None, name='', autoLog=True)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.BufferImageStim(buffer='back', rect=(- 1, 1, 1, - 1), sqPower2=False, stim=(), interpolate=True, flipHoriz=False, flipVert=False, mask='None', pos=(0, 0), name=None, autoLog=None)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.Circle(radius=0.5, edges=32, units='', lineWidth=1.5, lineColor=None, lineColorSpace=None, fillColor=None, fillColorSpace=None, pos=(0, 0), size=1.0, ori=0.0, opacity=None, contrast=1.0, depth=0, interpolate=True, lineRGB=False, fillRGB=False, name=None, autoLog=None, autoDraw=False, color=None, colorSpace='rgb')¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.GratingStim(tex='sin', mask='none', units='', pos=(0.0, 0.0), size=None, sf=None, ori=0.0, phase=(0.0, 0.0), texRes=128, rgb=None, dkl=None, lms=None, color=(1.0, 1.0, 1.0), colorSpace='rgb', contrast=1.0, opacity=None, depth=0, rgbPedestal=(0.0, 0.0, 0.0), interpolate=False, blendmode='avg', name=None, autoLog=None, autoDraw=False, maskParams=None)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.ImageStim(image=None, mask=None, units='', pos=(0.0, 0.0), size=None, ori=0.0, color=(1.0, 1.0, 1.0), colorSpace='rgb', contrast=1.0, opacity=None, depth=0, interpolate=False, flipHoriz=False, flipVert=False, texRes=128, name=None, autoLog=None, maskParams=None)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.LightSource(pos=(0.0, 0.0, 0.0), diffuseColor=(1.0, 1.0, 1.0), specularColor=(1.0, 1.0, 1.0), ambientColor=(0.0, 0.0, 0.0), colorSpace='rgb', lightType='point', attenuation=(1, 0, 0))¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.Line(begin=(- 0.5, - 0.5), end=(0.5, 0.5), units='', lineWidth=1.5, lineColor=None, fillColor=None, lineColorSpace=None, pos=(0, 0), size=1.0, ori=0.0, opacity=None, contrast=1.0, depth=0, interpolate=True, lineRGB=False, fillRGB=False, name=None, autoLog=None, autoDraw=False, color=None, colorSpace='rgb')¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.MovieStim(filename='', units='pix', size=None, pos=(0.0, 0.0), ori=0.0, flipVert=False, flipHoriz=False, color=(1.0, 1.0, 1.0), colorSpace='rgb', opacity=1.0, volume=1.0, name=None, loop=False, autoLog=None, depth=0.0)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.Pie(radius=0.5, begin=0.0, end=90.0, edges=32, units='', lineWidth=1.5, lineColor=None, lineColorSpace='rgb', fillColor=None, fillColorSpace='rgb', pos=(0, 0), size=1.0, ori=0.0, opacity=1.0, contrast=1.0, depth=0, interpolate=True, lineRGB=False, fillRGB=False, name=None, autoLog=None, autoDraw=False, color=None, colorSpace=None)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.PlaneStim(size=(0.5, 0.5), pos=(0.0, 0.0, 0.0), ori=(0.0, 0.0, 0.0, 1.0), color=(0.0, 0.0, 0.0), colorSpace='rgb', contrast=1.0, opacity=1.0, useMaterial=None, useShaders=False, textureScale=None, name='', autoLog=True)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.Polygon(edges=3, radius=0.5, units='', lineWidth=1.5, lineColor=None, lineColorSpace=None, fillColor=None, fillColorSpace=None, pos=(0, 0), size=1.0, ori=0.0, opacity=None, contrast=1.0, depth=0, interpolate=True, lineRGB=False, fillRGB=False, name=None, autoLog=None, autoDraw=False, color=None, colorSpace='rgb')¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.RadialStim(tex='sqrXsqr', mask='none', units='', pos=(0.0, 0.0), size=(1.0, 1.0), radialCycles=3, angularCycles=4, radialPhase=0, angularPhase=0, ori=0.0, texRes=64, angularRes=100, visibleWedge=(0, 360), rgb=None, color=(1.0, 1.0, 1.0), colorSpace='rgb', dkl=None, lms=None, contrast=1.0, opacity=1.0, depth=0, rgbPedestal=(0.0, 0.0, 0.0), interpolate=False, name=None, autoLog=None, maskParams=None)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.Rect(width=0.5, height=0.5, units='', lineWidth=1.5, lineColor=None, lineColorSpace=None, fillColor=None, fillColorSpace=None, pos=(0, 0), size=None, ori=0.0, opacity=None, contrast=1.0, depth=0, interpolate=True, lineRGB=False, fillRGB=False, name=None, autoLog=None, autoDraw=False, color=None, colorSpace='rgb')¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.SceneSkybox(tex=(), ori=0.0, axis=(0, 1, 0))¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.ShapeStim(units='', colorSpace='rgb', fillColor=False, lineColor=False, lineWidth=1.5, vertices=((- 0.5, 0), (0, 0.5), (0.5, 0)), windingRule=None, closeShape=True, pos=(0, 0), size=1, ori=0.0, opacity=1.0, contrast=1.0, depth=0, interpolate=True, name=None, autoLog=None, autoDraw=False, color=False, lineRGB=False, fillRGB=False, fillColorSpace=None, lineColorSpace=None)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.SphereStim(radius=0.5, subdiv=(32, 32), flipFaces=False, pos=(0.0, 0.0, 0.0), ori=(0.0, 0.0, 0.0, 1.0), color=(0.0, 0.0, 0.0), colorSpace='rgb', contrast=1.0, opacity=1.0, useMaterial=None, useShaders=False, name='', autoLog=True)¶: Bases: stimpy.stim.StimulusData

class stimpy.visual.TextStim(text='Hello World', font='', pos=(0.0, 0.0), depth=0, rgb=None, color=(1.0, 1.0, 1.0), colorSpace='rgb', opacity=1.0, contrast=1.0, units='', ori=0.0, height=None, antialias=True, bold=False, italic=False, alignHoriz=None, alignVert=None, alignText='center', anchorHoriz='center', anchorVert='center', fontFiles=(), wrapWidth=None, flipHoriz=False, flipVert=False, languageStyle='LTR', name=None, autoLog=None)¶: Bases: stimpy.stim.StimulusData

stimpy.window module¶

class stimpy.window.Window(*, monitor=None, distance=None, width=None, fullscr=True, size=None, color=(- 1, - 1, - 1), **kwargs)¶: Bases: psychopy.visual.

Module contents¶

stimpy stimpy.animate package