Opticka 2.16.1
Opticka is an experiment manager for behavioral research.
Loading...
Searching...
No Matches
logGaborStimulus Class Reference

logGaborStimulus: orientation & SF band-pass limited filter More...

Detailed Description

logGaborStimulus: orientation & SF band-pass limited filter

If you use this in published research please cite "Horizontal information drives the behavioral signatures of face processing" Goffaux & Dakin (2010) Frontiers in Perception Science v1, 143 | May 2015, Steven Dakin, s.dak.nosp@m.in@a.nosp@m.uckla.nosp@m.nd.a.nosp@m.c.nz

Copyright ©2014-2022 Ian Max Andolina — released: LGPL3, see LICENCE.md

Inheritance diagram for logGaborStimulus:

Public Member Functions

function logGaborStimulus (in varargin)
 Class constructor.
 
function setup (in me, in sM, in in)
 Setup this object in preperation for use When displaying a stimulus object, the main properties that are to be modified are copied into cache copies of the property, both to convert from visual description (c/d, Hz, degrees) to computer metrics; and to be animated and modified as independant variables. So xPosition is copied to xPositionOut and converted from degrees to pixels. The animation and drawing functions use these modified properties, and when they are updated, for example to change to a new xPosition, internal methods ensure reconversion and update any dependent properties. This method initialises the object in preperation for display.
 
function set_xPositionOut (in me, in value)
 
function set_yPositionOut (in me, in value)
 
function set_sizeOut (in me, in value)
 
function update (in me)
 Update this stimulus object structure for screenManager.
 
function draw (in me)
 Draw this stimulus object.
 
function animate (in me)
 Animate an structure for screenManager.
 
function reset (in me)
 Reset an structure for screenManager.
 
function loadImage (in me, in in)
 Load an image.
 
function scaleRange (in me, in in)
 Load an image.
 
- Public Member Functions inherited from baseStimulus
virtual setup (in runObject)
 ALL Children must implement these 5 methods!
 
function baseStimulus (in varargin)
 Class constructor.
 
function set colour (in me, in value)
 colour set method Allow 1 (R=G=B) 3 (RGB) or 4 (RGBA) value colour
 
function set alpha (in me, in value)
 alpha set method
 
function get delta (in me)
 delta Get method delta is the normalised number of pixels per frame to move a stimulus
 
function get dX (in me)
 dX Get method X position increment for a given delta and angle
 
function get dY (in me)
 dY Get method Y position increment for a given delta and angle
 
function show (in me)
 Method to set isVisible=true.
 
function hide (in me)
 Method to set isVisible=false.
 
function setOffTime (in me, in time)
 set offTime
 
function setDelayTime (in me, in time)
 set delayTime
 
function resetTicks (in me)
 reset the various tick counters for our stimulus
 
function getMousePosition (in me)
 get mouse position we make sure this is only called once per animation tick to improve performance and ensure all stimuli that are following mouse position have consistent X and Y per frame update This sets mouseX and mouseY and mouseValid if mouse is within PTB screen (useful for mouse override positioning for stimuli)
 
function run (in me, in benchmark, in runtime, in s, in forceScreen, in showVBL)
 Run stimulus in a window to preview it.
 
function makePanel (in me, in parent)
 make a GUI properties panel for this object
 
function selectFilePanel (in me, in varargin)
 read values from a GUI properties panel for this object
 
function readPanel (in me, in varargin)
 read values from a GUI properties panel for this object
 
function showPanel (in me)
 show GUI properties panel for this object
 
function hidePanel (in me)
 hide GUI properties panel for this object
 
function closePanel (in me, in varargin)
 close GUI panel for this object
 
function cleanHandles (in me, in ignoredArg)
 clean any handles
 
function getP (in me, in name, in range)
 gets a property copy or original property
 
function setP (in me, in name, in value)
 sets a property copy or original property
 
function updateXY (in me, in x, in y, in useDegrees)
 Update only position info, faster and doesn't reset image etc.
 
- Public Member Functions inherited from optickaCore
function optickaCore (in varargin)
 Class constructor.
 
function get fullName (in me)
 
function getALF (in me, in subject, in sessionPrefix, in lab, in create)
 
function findAttributes (in me, in attrName, in attrValue)
 
function findAttributesandType (in me, in attrName, in attrValue, in type)
 find properties of object with specific attributes, for example all properties whose GetAcccess attribute is public and type is logical.
 
function findPropertyDefault (in me, in propName)
 
function clone (in me)
 Use this syntax to make a deep copy of the object, i.e. OBJ_OUT has the same field values, but will not behave as a handle-copy of me anymore.
 
function checkSuperclasses (in List)
 
function editProperties (in me, in properties)
 method to modify a set of properties
 
function setProp (in me, in property, in value)
 method to fast change a particular value. This is useful for use in anonymous functions, like in the state machine.
 
function initialiseGlobals (in me, in doReset, in doOpen)
 
function initialiseSaveFile (in me)
 Initialise Save prefix.
 
function checkPaths (in me)
 checks the paths are valid
 

Static Public Member Functions

static function doLogGabor (in im, in FreqPeak, in FreqSigma, in ThetaPeak, in ThetaSigma)
 
static function makeGrating (in size)
 
- Static Public Member Functions inherited from baseStimulus
static function d2r (in degrees)
 degrees2radians
 
static function r2d (in r)
 radians2degrees
 
static function findDistance (in x1, in y1, in x2, in y2)
 findDistance in X and Y coordinates
 
static function updatePosition (in delta, in angle)
 updatePosition returns dX and dY given an angle and delta
 
- Static Public Member Functions inherited from optickaCore
static function makeArgs (in args)
 Converts cell args to structure array.
 
static function addDefaults (in args, in defs)
 add default options to arg input
 
static function hasKey (in in, in key)
 check if a struct / object has a propery / field
 
static function getKeys (in device)
 PTB Get key presses, stops key bouncing.
 

Public Attributes

Property fileName
 filename to load, if empty use random noise
 
Property sf
 peak spatial frequency
 
Property sfSigma
 spatial frequency SD
 
Property angleSigma
 orientation SD
 
Property contrast
 contrast multiplier
 
Property direction
 
Property lockAngle
 
Property seed
 seed for random textures
 
Property mask
 use mask?
 
Property maskColour
 colour of the mask, empty sets mask colour to = screen manager background
 
Property maskSmoothing
 smooth the alpha edge of the mask by this number of pixels
 
Property type
 type
 
Property modulateColour
 
Property regenerateTexture
 
Property phaseReverseTime
 For checkerboard, allow timed phase reversal.
 
Property scale
 scale is set by size
 
Property family
 
Property matrix
 
Property width
 
Property height
 
- Public Attributes inherited from baseStimulus
Property type
 stimulus type
 
Property xPosition
 
Property yPosition
 
Property size
 
Property colour
 
Property alpha
 Alpha (opacity) [0-1], this gets combined with the RGB colour.
 
Property startPosition
 
Property speed
 
Property angle
 angle in degrees (0 - 360)
 
Property delayTime
 
Property offTime
 time to turn stimulus off, relative to stimulus onset
 
Property isVisible
 true or false, whether to draw() this object
 
Property mouseOverride
 override X and Y position with mouse input? Useful for RF mapping
 
Property showOnTracker
 show the position on the Eyetracker display?
 
Property verbose
 Do we log extra details to the command-line?
 
Property xFinal
 
Property yFinal
 
Property mvRect
 
Property szIsPx
 
Property szPx
 computed size in pixels
 
Property szD
 computed size in °
 
Property xFinalD
 X and Y position in °
 
Property yFinalD
 
Property isRect
 
Property tick
 tick updates +1 on each call of draw (even if delay or off is true and no stimulus is drawn, resets on each update
 
Property drawTick
 draw tick only updates when a draw is actually performed, resets on each update
 
Property ppd
 pixels per degree (normally inhereted from screenManager)
 
Property delta
 What our per-frame motion delta is.
 
Property dX
 X update which is computed from our speed and angle.
 
Property dY
 X update which is computed from our speed and angle.
 
- Public Attributes inherited from optickaCore
Property name
 object name
 
Property comment
 comment
 
Property verbose
 verbose logging, subclasses must assign this. This is normally logical true/false
 
Property dateStamp
 clock() dateStamp set on construction
 
Property uuid
 universal ID
 
Property paths
 storage of various paths
 
Property fullName
 The fullName is the object name combined with its uuid and class name.
 

Protected Member Functions

function makeMask (in me)
 Make circular mask.
 
function setRect (in me)
 setRect setRect makes the PsychRect based on the texture and screen values This is overridden from parent class so we can scale texture using the size value
 
function checkFileName (in me)
 
function findFiles (in me)
 findFiles
 
- Protected Member Functions inherited from baseStimulus
function addRuntimeProperties (in me)
 These are transient properties that specify actions during runtime.
 
function updateRuntimeProperties (in me)
 Update transient properties that specify actions during runtime.
 
function computePosition (in me)
 compute xFinal and yFinal (in pixels) taking startPosition, xPosition, yPosition and direction/angle into account
 
function setAnimationDelta (in me)
 
function setRect (in me)
 
function toStructure (in me, in tmp)
 Converts properties to a structure.
 
function removeTmpProperties (in me)
 Finds and removes dynamic properties.
 
function delete (in me)
 
- Protected Member Functions inherited from optickaCore
function parseArgs (in me, in args, in allowedProperties)
 Sets properties from a structure or normal arguments pairs, ignores invalid or non-allowed properties.
 
function addArgs (in me, in args)
 
function setPaths (in me)
 Sets properties from a structure or normal arguments pairs, ignores invalid or non-allowed properties.
 
function getFonts (in me)
 set paths for object
 
function toStructure (in me)
 Converts properties to a structure.
 
function getType (in me, in in)
 
function logOutput (in me, in in, in message, in override)
 Give a metaproperty return the likely property class.
 
function salutation (in me, in varargin)
 Prints messages dependent on verbosity.
 

Additional Inherited Members

- Public Types inherited from baseStimulus
enum  Events { readPanelUpdate }
 
- Protected Attributes inherited from baseStimulus
Property family
 the stimulus family (grating, dots etc.)
 
Property texture
 Our texture pointer for texture-based stimuli.
 
Property handles
 handles for the GUI
 
Property sM
 our screen manager
 
Property animator
 animation manager
 
Property screenVals
 screen settings generated by sM on setup
 
Property isSetup
 
Property isGUI
 is panel constructed?
 
Property dstRect
 initial screen rectangle position [LEFT TOP RIGHT BOTTOM]
 
Property mouseValid
 is mouse position within screen co-ordinates?
 
Property mouseX
 mouse X position
 
Property mouseY
 mouse Y position
 
Property delayTicks
 delay ticks to wait until display
 
Property offTicks
 ticks before stimulus turns off
 
Property inSetup
 are we setting up?
 
Property delta_
 delta cache
 
Property dX_
 dX cache
 
Property dY_
 dY cache
 
Property isInSetColour
 deal with interaction of colour and alpha
 
Property setLoop
 
Property ignorePropertiesBase
 Which properties to ignore cloning when making transient copies in setup.
 
Property ignorePropertiesUIBase
 Which properties to not draw in the UI panel.
 
- Protected Attributes inherited from optickaCore
Property cloning
 are we cloning this from another object
 
Property mversion
 Matlab version number, this is transient so it is not saved.
 
Property sansFont
 sans font
 
Property monoFont
 monoFont
 
Property className
 class name
 
Property savePrefix
 save prefix generated from clock time
 
Property fullName_
 cached full name
 

Constructor & Destructor Documentation

◆ logGaborStimulus()

function logGaborStimulus::logGaborStimulus ( in  varargin)

Class constructor.

This parses any input values and initialises the object.

Parameters
vararginare passed as a list of parametoer or a structure of properties which is parsed.
Returns
instance of opticka class.

Member Function Documentation

◆ animate()

function logGaborStimulus::animate ( in  me)
virtual

Animate an structure for screenManager.

Reimplemented from baseStimulus.

◆ checkFileName()

function logGaborStimulus::checkFileName ( in  me)
protected

◆ doLogGabor()

static function logGaborStimulus::doLogGabor ( in  im,
in  FreqPeak,
in  FreqSigma,
in  ThetaPeak,
in  ThetaSigma 
)
static

◆ draw()

function logGaborStimulus::draw ( in  me)
virtual

Draw this stimulus object.

Reimplemented from baseStimulus.

◆ findFiles()

function logGaborStimulus::findFiles ( in  me)
protected

findFiles

◆ loadImage()

function logGaborStimulus::loadImage ( in  me,
in  in 
)

Load an image.

◆ makeGrating()

static function logGaborStimulus::makeGrating ( in  size)
static

◆ makeMask()

function logGaborStimulus::makeMask ( in  me)
protected

Make circular mask.

◆ reset()

function logGaborStimulus::reset ( in  me)
virtual

Reset an structure for screenManager.

Reimplemented from baseStimulus.

◆ scaleRange()

function logGaborStimulus::scaleRange ( in  me,
in  in 
)

Load an image.

◆ set_sizeOut()

function logGaborStimulus::set_sizeOut ( in  me,
in  value 
)

◆ set_xPositionOut()

function logGaborStimulus::set_xPositionOut ( in  me,
in  value 
)

◆ set_yPositionOut()

function logGaborStimulus::set_yPositionOut ( in  me,
in  value 
)

◆ setRect()

function logGaborStimulus::setRect ( in  me)
protected

setRect setRect makes the PsychRect based on the texture and screen values This is overridden from parent class so we can scale texture using the size value

◆ setup()

function logGaborStimulus::setup ( in  me,
in  sM,
in  in 
)

Setup this object in preperation for use When displaying a stimulus object, the main properties that are to be modified are copied into cache copies of the property, both to convert from visual description (c/d, Hz, degrees) to computer metrics; and to be animated and modified as independant variables. So xPosition is copied to xPositionOut and converted from degrees to pixels. The animation and drawing functions use these modified properties, and when they are updated, for example to change to a new xPosition, internal methods ensure reconversion and update any dependent properties. This method initialises the object in preperation for display.

Parameters
sMscreenManager object for reference
inmatrix for conversion to a PTB texture

◆ update()

function logGaborStimulus::update ( in  me)
virtual

Update this stimulus object structure for screenManager.

Reimplemented from baseStimulus.

Member Data Documentation

◆ angleSigma

Property logGaborStimulus::angleSigma

orientation SD

◆ contrast

Property logGaborStimulus::contrast

contrast multiplier

◆ direction

Property logGaborStimulus::direction

the direction of the whole grating object - i.e. the object can move (speed property) as well as the grating texture rotate within the object.

◆ family

Property logGaborStimulus::family

◆ fileName

Property logGaborStimulus::fileName

filename to load, if empty use random noise

◆ height

Property logGaborStimulus::height

◆ lockAngle

Property logGaborStimulus::lockAngle

do we lock the angle to the direction? If so what is the offset (0 = parallel, 90 = orthogonal etc.)

◆ mask

Property logGaborStimulus::mask

use mask?

◆ maskColour

Property logGaborStimulus::maskColour

colour of the mask, empty sets mask colour to = screen manager background

◆ maskSmoothing

Property logGaborStimulus::maskSmoothing

smooth the alpha edge of the mask by this number of pixels

◆ matrix

Property logGaborStimulus::matrix

◆ modulateColour

Property logGaborStimulus::modulateColour

◆ phaseReverseTime

Property logGaborStimulus::phaseReverseTime

For checkerboard, allow timed phase reversal.

◆ regenerateTexture

Property logGaborStimulus::regenerateTexture

update() method also regenerates the texture, this can be slow but normally update() is only called after a trial has finished

◆ scale

Property logGaborStimulus::scale

scale is set by size

◆ seed

Property logGaborStimulus::seed

seed for random textures

◆ sf

Property logGaborStimulus::sf

peak spatial frequency

◆ sfSigma

Property logGaborStimulus::sfSigma

spatial frequency SD

◆ type

Property logGaborStimulus::type

type

◆ width

Property logGaborStimulus::width

The documentation for this class was generated from the following file: