| Spike Toolbox |
|
STCreate
Create a spike train
Syntax
[stTrain] = STCreate(<train definition type>,
<definition arguments>,
<instantiation arguments>,
<mapping arguments>)
[stTrain] = STCreate('constant', fFreq, ...)
[stTrain] = STCreate('linear', fStartFreq, fEndFreq, ...)
[stTrain] = STCreate('sinusoid', fMinFreq, fMaxFreq, tPeriod, ...)
[stTrain] = STCreate('gamma', fMeanISI, fVarISI, ...)
[stTrain] = STCreate(..., strTemporalType, tDuration <, nAddr1, nAddr2, ...>)
[stTrain] = STCreate(..., strTemporalType, tDuration <, stasSpecification, nAddr1, nAddr2, ...>)
Description
STCreate will create a spike train definition of various types. The first
argument specifies the type of spike train, and must be one of {constant,
linear, sinusoid, gamma}.
The second set of parameters is passed to the definition creation
function (See STCreateConstant, STCreateLinear, STCreateSinusoid and
STCreateGamma for details of the parameters relating to the spike train
types). When called with only the train definition parameters, stTrain
will comprise of a single field defintion containing the spike train
definition.
STCreate can also be used to instantiate and map the resulting spike train.
By providing the instantiation arguments, the train will be instantiated
and stTrain will contain a field instance containing the spike train
instance. See STInstantiate for details of these parameters.
By providing the mapping arguments, the train will be mapped and
stTrain will contain a field mapping containing the mapped spike
train. See STMap for details of these arguments.
Arrays can be supplied for one or more arguments, according to the
calling syntax for the separate utility functions (ie STCreate...,
STInstantiate and STMap). In this case, stTrain will be a cell array
of spike trains. Note that the train(s) will be created in order: all
definitions will be created, then all instances, then all mappings. The
train will be a scalar train until a step is encountered that specifies
an array of arguments. This means that if an array is passed to the
mapping arguments but not the instantiation arguments, all mapped spike
trains will have been created from a single spike train instance, and
will have identical spike times for all spikes.
See Also
Generating spike trains,
Generating advanced spike trains,
STCreateConstant,
STCreateLinear,
STCreateSinusoid,
STCreateGamma,
STInstantiate,
STMap
|
STConcat
|
STCreateConstant
|