Standard Stimulus Generators

Symphony includes a number of built-in StimulusGenerators.

DirectCurrentGenerator

symphonyui.builtin.stimuli.DirectCurrentGenerator
Generates a constant, zero-frequency, direct current stimulus.

  • time - Duration (s)
  • offset - Mean value (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

dc

PulseGenerator

symphonyui.builtin.stimuli.PulseGenerator
Generates a single rectangular pulse stimulus.

  • preTime - Leading duration (ms)
  • stimTime - Pulse duration (ms)
  • tailTime - Trailing duration (ms)
  • amplitude - Pulse amplitude (units)
  • mean - Mean amplitude (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

pulse

PulseTrainGenerator

symphonyui.builtin.stimuli.PulseTrainGenerator
Generates a rectangular pulse train stimulus.

  • preTime - Leading duration before the train (ms)
  • pulseTime - Duration of each pulse in the train (ms)
  • intervalTime - Inter-pulse interval duration (ms)
  • tailTime - Trailing duration after the train (ms)
  • amplitude - Pulse amplitude (units)
  • mean - Mean amplitude (units)
  • numPulses - Number of pulses in the train
  • pulseTimeIncrement - Amount to increment the pulse duration with every pulse in the train (ms)
  • intervalTimeIncrement - Amount to increment the inter-pulse interval duration with every pulse in the train (ms)
  • amplitudeIncrement - Amount to increment the pulse amplitude with every pulse in the train (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

train

RampGenerator

symphonyui.builtin.stimuli.RampGenerator
Generates a single linear ramp stimulus.

  • preTime - Leading duration (ms)
  • stimTime - Ramp duration (ms)
  • tailTime - Trailing duration (ms)
  • amplitude - Ramp peak amplitude (units)
  • mean - Mean amplitude (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

ramp

RepeatingPulseGenerator

symphonyui.builtin.stimuli.RepeatingPulseGenerator
Generates an indefinitely repeating rectangular pulse stimulus.

  • preTime - Leading duration (ms)
  • stimTime - Pulse duration (ms)
  • tailTime - Trailing duration (ms)
  • amplitude - Pulse amplitude (units)
  • mean - Mean amplitude (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

pulse

SineGenerator

symphonyui.builtin.stimuli.SineGenerator
Generates a sine wave stimulus.

  • preTime - Leading duration (ms)
  • stimTime - Sine wave duration (ms)
  • tailTime - Trailing duration (ms)
  • amplitude - Sine wave amplitude (units)
  • period - Sine wave period (ms)
  • phase - Sine wave phase offset (radians)
  • mean - Mean amplitude (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

sine

SquareGenerator

symphonyui.builtin.stimuli.SquareGenerator
Generates a square wave stimulus.

  • preTime - Leading duration (ms)
  • stimTime - Square wave duration (ms)
  • tailTime - Trailing duration (ms)
  • amplitude - Square wave amplitude (units)
  • period - Square wave period (ms)
  • phase - Square wave phase offset (radians)
  • mean - Mean amplitude (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

square

SumGenerator

symphonyui.builtin.stimuli.SumGenerator
Generates a stimulus from the sum of a set of specified stimuli. All stimuli must have the same duration, units, and sample rate.

  • stimuli - Cell array of stimuli to sum

sum

WaveformGenerator

symphonyui.builtin.stimuli.WaveformGenerator
Generates an arbitrary waveform stimulus from a specified vector. WaveformGenerator must store the entire waveform vector with the stimulus in order be able to regenerate it (as opposed to just the parameters used to generate it). Because of this, prefer using other stimulus generators, or writing your own, over using WaveformGenerator to avoid increasing the size of your data files.

  • waveshape - Wave as a vector (units)
  • sampleRate - Sample rate of generated stimulus (Hz)
  • units - Units of generated stimulus

waveform

results matching ""

    No results matching ""