meanWaveform-methods: Calculate the mean waveform of neurons in a recording...

Description Usage Arguments Value

Description

Calculate the mean waveform of neurons in a recording session.

Usage

1
2
3
4
5
6
7
8
meanWaveform(sw, rs, st, cg, df, windowSizeMs = 3, divisorToMicroVolt = 7,
  numberSpikes = 500, minInterSpikeIntervalMs = 2, minPassHz = 500,
  maxPassHz = 10000, filter = FALSE)

## S4 method for signature 'SpikeWaveform'
meanWaveform(sw, rs, st, cg, df, windowSizeMs = 3,
  divisorToMicroVolt = 7, numberSpikes = 500, minInterSpikeIntervalMs = 2,
  minPassHz = 500, maxPassHz = 10000, filter = FALSE)

Arguments

sw

SpikeWaveform object

rs

RecSession object

st

SpikeTrain object

cg

CellGroup object

df

DatFiles object

windowSizeMs

The window size for the mean waveform

divisorToMicroVolt

Factor by which to divide the raw data to obtain values in micro volts.

numberSpikes

Number of spikes to use to calculate the mean

minInterSpikeIntervalMs

Minimum inter spike intervals between the spikes used to calculate the mean

minPassHz

Minimal frequency of the bandpass filter, only used if filter==TRUE

maxPassHz

Maximal frequency of the bandpass filter, only used if filter==TRUE

filter

Logical indicating whether to apply a bandpass filter to raw traces per neuron so that all neurons have the same number of channels.

Value

SpikeWaveform object with the mean waveform in wf matrix


kevin-allen/relectro documentation built on May 20, 2019, 9:06 a.m.