...
Peristimulus time histogram (PSTH) sink
The PSTH sink module is used to display average firing rate and average lfp, aligned to external events, such as TTL pulses, or more complex trials that are sent over the network.
The module uses the following commands that are sent using the Network Events module:
- ClearDesign
- This command clears up all known conditions
- NewDesign <design name>
- This command clears up all known conditions, and set up a name for the active "design". A design has any number of conditions. A condition has any number of trial types, and specific outcomes. See more below.
- AddCondition Name <condition name> TrialTypes <trial types> Outcomes <trial outcomes>
- This command add a new condition to the active design. The condition will average spike & lfp information only for trials that belong to the subset of trials defined in <trial types>.
- A trial type is any positive integer.
- You can further define whether to average a trial or not by its outcome. Outcomes can correspond to correct/incorrect, or any other response the animal makes.
- Outcomes can be any positive integer.
- TrialStart <trial type, optional>
- This command indicates that a trial has started. You can send (optionally) the trial type here as well. Otherwise, use the TrialType command
- TrialType <trial type>
- This command sends the trial type information of the current running trial.
- TrialAlign
- Spikes & LFP can be aligned not only to trial onset, but to other events (i.e., saccades, lever presses, etc). Use this command to indicate that firing rate should be aligned to the specific time point when this command was arrived.
- If TrialAlign command is not sent for a trial, the default is to average things relative to TrialStart
- TrialOutcome <trial outcome>
- This commands indicate the outcome of the trial.
- TrialEnd <trial outcome, optional>
- This indicates that a trial has finished, with the optional parameter that indicates what was the outcome.
- This indicates that a trial has finished, with the optional parameter that indicates what was the outcome.
For example, a two alternative force choice task, with four conditions can be constructed like this:
NewDesign 2AFC
AddCondition Name GoLeft TrialTypes 1
AddCondition Name GoRight TrialTypes 2
AddCondition Name AllTrials TrialTypes 1 2
AddCondition Name GoRightCorrect TrialTypes 2 Outcomes 2
individual trials can be send as follows:
TrialStart 1
TrialEnd
TrialStart 1
TrialEnd 2
Condition "GoLeft" will average both trials, condition "GoRight" won't have any information, since trial type 2 was never sent, condition "AllTrials" will also average both trials, but condition "GoRightCorrect" will only average the second trial.
TODO: add a simple C++ / Matlab program that show how to send trial information over zeromq.