nwb-schema/core/nwb.behavior.yaml at e6c3a005f7d78ba4eef823e5a167b2c5b8a045cd · NeurodataWithoutBorders/nwb-schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
groups:
- neurodata_type_def: SpatialSeries
  neurodata_type_inc: TimeSeries
  doc: "Direction, e.g., of gaze or travel, or position. The TimeSeries::data field\
    \ is a 2D array storing position or direction relative to some reference frame.\
    \ Array structure: [num measurements] [num dimensions]. Each SpatialSeries has\
    \ a text dataset reference_frame that indicates the zero-position, or the zero-axes\
    \ for direction. For example, if representing gaze direction, 'straight-ahead'\
    \ might be a specific pixel on the monitor, or some other point in space. For\
    \ position data, the 0,0 point might be the top-left corner of an enclosure, as\
    \ viewed from the tracking camera. The unit of data will indicate how to interpret\
    \ SpatialSeries values."
  datasets:
  - name: data
    dtype: numeric
    dims:
    - - num_times
    - - num_times
      - x
    - - num_times
      - x,y
    - - num_times
      - x,y,z
    shape:
    - - null
    - - null
      - 1
    - - null
      - 2
    - - null
      - 3
    doc: 1-D or 2-D array storing position or direction relative to some reference frame.
    attributes:
    - name: unit
      dtype: text
      default_value: meters
      doc: Base unit of measurement for working with the data. The default value
        is 'meters'. Actual stored values are not necessarily stored in these units.
        To access the data in these units, multiply 'data' by 'conversion' and add 'offset'.
      required: false
  - name: reference_frame
    dtype: text
    doc: Description defining what exactly 'straight-ahead' means.
    quantity: '?'

- neurodata_type_def: BehavioralEpochs
  neurodata_type_inc: NWBDataInterface
  default_name: BehavioralEpochs
  doc: TimeSeries for storing behavioral epochs.  The objective of this and the other
    two Behavioral interfaces (e.g. BehavioralEvents and BehavioralTimeSeries) is
    to provide generic hooks for software tools/scripts. This allows a tool/script
    to take the output one specific interface (e.g., UnitTimes) and plot that data
    relative to another data modality (e.g., behavioral events) without having to
    define all possible modalities in advance. Declaring one of these interfaces means
    that one or more TimeSeries of the specified type is published. These TimeSeries
    should reside in a group having the same name as the interface. For example, if
    a BehavioralTimeSeries interface is declared, the module will have one or more
    TimeSeries defined in the module sub-group 'BehavioralTimeSeries'. BehavioralEpochs
    should use IntervalSeries. BehavioralEvents is used for irregular events. BehavioralTimeSeries
    is for continuous data.
  groups:
  - neurodata_type_inc: IntervalSeries
    doc: IntervalSeries object containing start and stop times of epochs.
    quantity: '+'

- neurodata_type_def: BehavioralEvents
  neurodata_type_inc: NWBDataInterface
  default_name: BehavioralEvents
  doc: DEPRECATED. Use an EventsTable instead.
    TimeSeries for storing behavioral events. See description of BehavioralEpochs
    for more details.
  groups:
  - neurodata_type_inc: TimeSeries
    doc: TimeSeries object containing behavioral events.
    quantity: '+'

- neurodata_type_def: BehavioralTimeSeries
  neurodata_type_inc: NWBDataInterface
  default_name: BehavioralTimeSeries
  doc: TimeSeries for storing behavioral time series data. See description of BehavioralEpochs
    for more details.
  groups:
  - neurodata_type_inc: TimeSeries
    doc: TimeSeries object containing continuous behavioral data.
    quantity: '+'

- neurodata_type_def: PupilTracking
  neurodata_type_inc: NWBDataInterface
  default_name: PupilTracking
  doc: Eye-tracking data, representing pupil size.
  groups:
  - neurodata_type_inc: TimeSeries
    doc: TimeSeries object containing time series data on pupil size.
    quantity: '+'

- neurodata_type_def: EyeTracking
  neurodata_type_inc: NWBDataInterface
  default_name: EyeTracking
  doc: Eye-tracking data, representing direction of gaze.
  groups:
  - neurodata_type_inc: SpatialSeries
    doc: SpatialSeries object containing data measuring direction of gaze.
    quantity: '+'

- neurodata_type_def: CompassDirection
  neurodata_type_inc: NWBDataInterface
  default_name: CompassDirection
  doc: With a CompassDirection interface, a module publishes a SpatialSeries object
    representing a floating point value for theta. The SpatialSeries::reference_frame
    field should indicate what direction corresponds to 0 and which is the direction
    of rotation (this should be clockwise). The si_unit for the SpatialSeries should
    be radians or degrees.
  groups:
  - neurodata_type_inc: SpatialSeries
    doc: SpatialSeries object containing direction of gaze travel.
    quantity: '+'

- neurodata_type_def: Position
  neurodata_type_inc: NWBDataInterface
  default_name: Position
  doc: Position data, whether along the x, x/y or x/y/z axis.
  groups:
  - neurodata_type_inc: SpatialSeries
    doc: SpatialSeries object containing position data.
    quantity: '+'