types.js

// warning: must edit actions.js too
const STIMULUS = {
    BAR: 'BAR',
    SOLID: 'SOLID',
    CHIRP: 'CHIRP',
    CHIRP_AMPLITUDE: 'CHIRP_AMPLITUDE',
    WAIT: 'WAIT',
    TARGET: 'TARGET',
    GRATING: 'GRATING',
    SINUSOIDAL_GRATING: 'SINUSOIDAL_GRATING',
    CHECKERBOARD: "CHECKERBOARD",
    LETTER: "LETTER",
    TILED_LETTER: "TILED_LETTER",
    WHITE_NOISE: "WHITE_NOISE",
    EYECHART: "EYECHART",
    IMAGE: "IMAGE",
    VIDEO: "VIDEO"
}

class Stimulus {
    // parameters are used for program execution
    // metadata is used for stimulus generation & analysis
    constructor(lifespan, backgroundColor, metadata) {
        this.lifespan = lifespan
        this.backgroundColor = backgroundColor
        this.metadata = metadata
        this.age = 0
  }
}

class Bar extends Stimulus {
    constructor(lifespan, backgroundColor, speed, width, angle, barColor, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.BAR
        this.speed = speed
        this.width = width
        this.angle = angle
        this.barColor = barColor
    }
}
exports.Bar = Bar

class Grating extends Stimulus {
    constructor(lifespan, backgroundColor, speed, width, angle, barColor, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.GRATING
        this.speed = speed
        this.width = width
        this.angle = angle
        this.barColor = barColor
    }
}
exports.Grating = Grating

class SinusoidalGrating extends Stimulus {
    constructor(lifespan, backgroundColor, speed, width, angle, barColor, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.SINUSOIDAL_GRATING
        this.speed = speed
        this.width = width
        this.angle = angle
        this.barColor = barColor
    }
}
exports.SinusoidalGrating = SinusoidalGrating

class Letter extends Stimulus {
    constructor(lifespan, backgroundColor, letter, x, y, size, color, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.LETTER
        this.letter = letter
        this.x = x
        this.y = y
        this.size = size
        this.color = color
    }
}
exports.Letter = Letter

class LetterSaccade extends Stimulus {
    constructor(lifespan, backgroundColor, letter, x, y, size, color, saccadeSize, metadata) {
        // saccadeSize is a square of diameter 2*saccadeSize
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.LETTER
        this.letter = letter
        this.x = x
        this.y = y
        this.size = size
        this.color = color
        this.saccadeSize = saccadeSize
    }
}
exports.Letter = Letter

class TiledLetter extends Stimulus {
    constructor(lifespan, backgroundColor, letter, size, padding, color, angle, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.TILED_LETTER
        this.letter = letter
        this.size = size
        this.padding = padding
        this.color = color
        this.angle = angle
    }
}
exports.TiledLetter = TiledLetter

class WhiteNoise extends Stimulus {
    constructor(lifespan, rows, cols, color, metadata) {
        super(lifespan, "black", metadata)
        this.stimulusType = STIMULUS.WHITE_NOISE
        this.rows = rows
        this.cols = cols
        // TODO: color white noise not implemented
        this.color = false
    }
}
exports.WhiteNoise = WhiteNoise

class EyeChart extends Stimulus {
    constructor(lifespan, backgroundColor, letterMatrix, size, padding, color, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.EYECHART
        this.letterMatrix = letterMatrix
        this.size = size
        this.padding = padding
        this.color = color
    }
}
exports.EyeChart = EyeChart

class Image extends Stimulus {
    constructor(lifespan, backgroundColor, image,
                fixationPoint, scale, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.IMAGE
        // image can be a number (index) for client-side `renders` object that is stored in indexedDB
        this.image = image
        // e.g. {x: 0, y: 0}
        this.fixationPoint = fixationPoint
        // e.g. 1 for normal, or 2 for 2x height and 2x width
        //or [1,2] to scale only width by 2x
        this.scale = scale
    }
}
exports.Image = Image

class Video extends Stimulus {
    constructor(lifespan, backgroundColor, src, startTime, metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.VIDEO
        this.startTime = startTime
        this.src = src
    }
}
exports.Video = Video

class Solid extends Stimulus {
    constructor(lifespan, backgroundColor = "white", metadata) {
        super(lifespan, backgroundColor, metadata)
        this.stimulusType = STIMULUS.SOLID
    }
}
exports.Solid = Solid

class Chirp extends Stimulus {
    // https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.chirp.html
    constructor(lifespan, f0, f1, a0, a1, t1, phi, metadata) {
        // f0 (float) Frequency (e.g. Hz) at time t=0.
        // t1 (float) Time at which f1 is specified.
        // f1 (float) Frequency (e.g. Hz) of the waveform at time t1.
        // phi (float) Phase offset, in radians. Default is 0.
        const backgroundColor = "black"
        super(lifespan, backgroundColor , metadata)
        this.stimulusType = STIMULUS.CHIRP
        this.f0 = f0
        this.f1 = f1
        this.a0 = a0
        this.a1 = a1
        this.t1 = t1
        this.phi = phi
    }
}
exports.Chirp = Chirp

class Wait extends Stimulus {
    constructor(lifespan, metadata) {
        super(lifespan, "black", metadata)
        this.stimulusType = STIMULUS.WAIT
    }
}
exports.Wait = Wait

class Checkerboard extends Stimulus {
    constructor(lifespan, color, alternateColor, size, angle, metadata) {
        super(lifespan, alternateColor, metadata)
        this.stimulusType = STIMULUS.CHECKERBOARD
        this.color = color
        this.alternateColor = alternateColor
        this.size = size
        this.angle = angle
        // TODO try deleting--unecessary?
        this.count = 0
    }
}
exports.Checkerboard = Checkerboard