5. what are @key objects

A @key object contains one or more keys. Each key defines the criteria to select, from the @cortex object, a subset of trials that belong together, and specifies the time window to consider for the analysis of spike trains. Once a @key object is created, its keys can be passed to @cortex member functions.

A key is composed of the following parts:

field function type
default
label key name character string
'noname'
start beginning of analysis window (ms offset from cue event) integer scalar
-50
finish end of analysis window (ms offset from cue event) integer scalar (>start)
250
cues one or more events ("encodes") to which analysis windows lock on array of unsigned ntegers
23
conditions range of conditions to include (-1 to include all)
-1
blocks range of blocks to include (-1 to include all)
-1
responses range of response errors to include (-1 to include all)
0
trials range of "absolute" trials to include (-1 to include all)
-1
type range of trial types (expected responses) to include (-1 to include all)
-1
given range of given responses to include (-1 to include all)
-1
repetition range of repetition numbers to include (-1 to include all)
-1
relative range of "relative" trial numbers (trial # recorded in the trial header)
-1

note that only the first 3 case-irrelevant characters of the field name are considered. Thus, 'conditions', 'conds', and 'Con' are all equivalent.

Previous <-> Next