mask

 element objects

A rectangular, elliptical, or Gaussian aperture in a solid surround. By default the surround has the trial background color and fills the experiment window. The aperture is centered at element position which you can set in property position (default window center). By default the mask automatically displays in front of all other elements. You can change this using property depth.

▸ Object ends on its own?

"Ends on its own" means ends automatically at that point. If an element can end on its own, you don't need to set end conditions for it in property end (unless you want it to maybe end earlier).

No—runs until any condition you set in property end.

Input properties
Record properties
mask
elements (see below)

shape
size
sigma
backSize
color

All visual elements
position
depth

nn_eyes
rotation
flipHorz
flipVert

colorMask
alpha
intensity
contrastMult
convolution
shader
filterOrder
filterGrayscale
filterResolutionMult
filterGamma

channelResolution
backColor
addDisplay

All visual elements
position

All adjuster elements have
adjust

All elements
start
end

startBuffer
endBuffer

vary
staircase

All objects
info
report

shape

Default: rectangle

A string <cds>"rectangle"<cds>, <cds>"circle"<cds>, or <cds>"gaussian"<cds> setting shape of the aperture.

size

Default: 5 deg

Size of the transparent aperture for a rectangular or circular mask (deg). This is a number that is square side length or circle diameter. Or a vector [width height] for a rectangle or ellipse. Ignored for Gaussian.

sigma

Default: 0.75 deg

Standard deviation of the transparent aperture for a Gaussian mask (deg). Or a vector <cd>[s_x s_y]<cd> for an asymmetric Gaussian.

backSize

Default: fill experiment window

Size of the solid surround part of the mask (deg). Generally this just needs to be big enough that the element(s) to occlude are fully occluded. Typically you can just leave it at default <cd>inf<cd> = fill screen (at any position or rotation, not necessarily centered on screen). If you set it, it can be a number that is side length for a square, or a vector [width height] for a rectangle (deg).

color

Default: same as trial background color

A 1×3 RGB vector with numbers between 0–1 that is surround color. Default is same as trial background color, which you can set in trial object backColor (default black).

depth

Default: in front of all other elements

An input property all visual elements have. Special case for a mask element: If you leave depth at default, the mask will automatically display in front of all other elements. You can change this by setting depth as usual.

Adjustable properties

You can vary or allow the subject to adjust the following properties of an object of this type when it's running. If you need to make other properties adjustable, you can edit the element type code—see Element Type Programming Manual.

Adjustable properties

Adjustable properties

nn_eyes
rotation
colorMask
alpha
intensity
contrastMult

position
nn_eyes
rotation
colorMask
alpha
intensity
contrastMult
drawCodeVars

(None)

(None)

Input properties
Record properties

PsychBench uses record properties to record information during experiments. You can't set record properties but you can see them in experiment results using input property report.

mask
elements (see below)

All elements
startTime
endTime
duration
n_startFrame
n_endFrame
startLatencyBufferable
endLatencyBufferable