eelbrain.epoch_impulse_predictor

eelbrain.epoch_impulse_predictor(shape, value=1, latency=0, name=None, data=None)

Time series with one impulse for each of n epochs

Parameters:
  • shape (NDVar | str | Tuple[int, UTS]) – Shape of the output. Can be specified as the NDVar with the data to predict, or an (n_cases, time_dimension) tuple.

  • value (float | Sequence[float] | str) – Scalar or length n sequence of scalars specifying the value of each impulse (default 1).

  • latency (float | Sequence[float] | str) – Scalar or length n sequence of scalars specifying the latency of each impulse (default 0).

  • name (str) – Name for the output NDVar.

  • data (Dataset) – If specified, input items (shape, value and latency) can be strings to be evaluated in data.

Return type:

NDVar

See also

event_impulse_predictor

for continuous time series

Examples

See Impulse predictors for epochs example.