Struct AnalysisFunction_V3

struct AnalysisFunction_V3

The structure passed into V3 and later analysis functions.

Public Members

variable eventType

one of EVENT_TYPE_ANALYSIS_FUNCTIONS

WaveRefWave scaledDACWave

scaled and undecimated data from the DAC hardware, wave ref wave where each element is a channel wave. Channels are in the same order as the config wave rows.

variable headStage

active headstage index, [0, NUM_HEADSTAGES[

variable sweepNo

Potential future number of the sweep. Once the sweep is finished it will be saved with this number. Use GetSweepWave() to query the sweep itself.

variable sweepsInSet

Number of sweeps in the currently acquired stimset of the passed headstage.

string params

Analysis function parameters set in the stimset’s textual parameter wave. Settable via AFH_AddAnalysisParameter().

variable lastValidRowIndexDA

last valid row index for DA channels in rawDAQWave which will be filled with data at the end of DAQ. If the acquisition was aborted, the remaining samples beyond lastValidRowIndexDA are NaN. The total number of rows in rawDAQWave might be higher due to alignment requirements of the data acquisition hardware (e.g. ITC).

Always NaN for PRE_DAQ_EVENT/PRE_SET_EVENT events.

variable lastValidRowIndexAD

last valid row index for AD/TTL channels in rawDAQWave which will be filled with data at the end of DAQ. The total number of rows in rawDAQWave might be higher due to alignment requirements of the data acquisition hardware (e.g. ITC).

Always NaN for PRE_DAQ_EVENT/PRE_SET_EVENT events.

variable lastKnownRowIndexDA

last written row index in rawDAQWave/scaledDACWaves DA channel(s) with already acquired data

Always NaN for PRE_DAQ_EVENT/PRE_SET_EVENT/PRE_SWEEP_CONFIG_EVENT.

variable lastKnownRowIndexAD

last written row index in rawDAQWave/scaledDACWaves AD/TTL channel(s) with already acquired data

Always NaN for PRE_DAQ_EVENT/PRE_SET_EVENT/PRE_SWEEP_CONFIG_EVENT.

variable sampleIntervalDA

sample interval of DA channel(s) in ms

variable sampleIntervalAD

sample interval of AD channel(s) in ms