missed generated schema somehow...

This commit is contained in:
sneakers-the-rat 2024-07-03 16:00:56 -07:00
parent 19d97ad3af
commit c9a2423a9d
Signed by untrusted user who does not match committer: jonny
GPG key ID: 6DCB96EF1E4D232D
147 changed files with 5670 additions and 7357 deletions

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.2.0 version: 2.2.0
imports: imports:
@ -39,32 +46,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -130,7 +130,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -138,7 +141,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -146,7 +152,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -201,27 +210,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -268,13 +276,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.2.0 version: 2.2.0
imports: imports:
@ -59,19 +66,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -88,12 +91,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -101,12 +105,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -114,36 +119,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -154,22 +162,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.device name: core.nwb.device
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.device id: core.nwb.device
version: 2.2.0 version: 2.2.0
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.ecephys name: core.nwb.ecephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ecephys id: core.nwb.ecephys
version: 2.2.0 version: 2.2.0
imports: imports:
@ -25,8 +32,21 @@ classes:
name: data name: data
description: Recorded voltage data. description: Recorded voltage data.
multivalued: false multivalued: false
range: ElectricalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_channels
- array:
dimensions:
- alias: num_times
- alias: num_channels
- alias: num_samples
electrodes: electrodes:
name: electrodes name: electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -45,47 +65,13 @@ classes:
as native values generated by data acquisition systems. If this dataset as native values generated by data acquisition systems. If this dataset
is not present, then there is no channel-specific conversion factor, i.e. is not present, then there is no channel-specific conversion factor, i.e.
it is 1 for all channels. it is 1 for all channels.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_channels
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
ElectricalSeries__data:
name: ElectricalSeries__data
description: Recorded voltage data.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. This value
is fixed to 'volts'. Actual stored values are not necessarily stored in
these units. To access the data in these units, multiply 'data' by 'conversion'
and 'channel_conversion' (if present).
range: text
array:
name: array
range: ElectricalSeries__data__Array
ElectricalSeries__data__Array:
name: ElectricalSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
num_samples:
name: num_samples
range: numeric
required: false
ElectricalSeries__electrodes: ElectricalSeries__electrodes:
name: ElectricalSeries__electrodes name: ElectricalSeries__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -120,52 +106,31 @@ classes:
name: data name: data
description: Spike waveforms. description: Spike waveforms.
multivalued: false multivalued: false
range: SpikeEventSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_events
- alias: num_samples
- array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_samples
timestamps: timestamps:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
Timestamps are required for the events. Unlike for TimeSeries, timestamps Timestamps are required for the events. Unlike for TimeSeries, timestamps
are required for SpikeEventSeries and are thus re-specified here. are required for SpikeEventSeries and are thus re-specified here.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
SpikeEventSeries__data:
name: SpikeEventSeries__data
description: Spike waveforms.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Unit of measurement for waveforms, which is fixed to 'volts'.
range: text
array:
name: array
range: SpikeEventSeries__data__Array
SpikeEventSeries__data__Array:
name: SpikeEventSeries__data__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: numeric
required: true
num_samples:
name: num_samples
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
FeatureExtraction: FeatureExtraction:
name: FeatureExtraction name: FeatureExtraction
description: Features, such as PC1 and PC2, that are extracted from signals stored description: Features, such as PC1 and PC2, that are extracted from signals stored
@ -181,19 +146,30 @@ classes:
name: description name: description
description: Description of features (eg, ''PC1'') for each of the extracted description: Description of features (eg, ''PC1'') for each of the extracted
features. features.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
features: features:
name: features name: features
description: Multi-dimensional array of features extracted from each event. description: Multi-dimensional array of features extracted from each event.
multivalued: false multivalued: false
range: FeatureExtraction__features array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_features
range: float32
required: true required: true
times: times:
name: times name: times
description: Times of events that features correspond to (can be a link). description: Times of events that features correspond to (can be a link).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
electrodes: electrodes:
@ -204,36 +180,6 @@ classes:
range: FeatureExtraction__electrodes range: FeatureExtraction__electrodes
required: true required: true
tree_root: true tree_root: true
FeatureExtraction__features:
name: FeatureExtraction__features
description: Multi-dimensional array of features extracted from each event.
attributes:
name:
name: name
ifabsent: string(features)
identifier: true
range: string
required: true
equals_string: features
array:
name: array
range: FeatureExtraction__features__Array
FeatureExtraction__features__Array:
name: FeatureExtraction__features__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: float32
required: true
num_channels:
name: num_channels
range: float32
required: true
num_features:
name: num_features
range: float32
required: true
FeatureExtraction__electrodes: FeatureExtraction__electrodes:
name: FeatureExtraction__electrodes name: FeatureExtraction__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -270,13 +216,19 @@ classes:
corresponding to time of event. ''description'' should define what is meant corresponding to time of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing by time of event (e.g., .25 ms before action potential peak, zero-crossing
time, etc). The index points to each event from the raw data. time, etc). The index points to each event from the raw data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
times: times:
name: times name: times
description: Timestamps of events, in seconds. description: Timestamps of events, in seconds.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
@ -287,12 +239,13 @@ classes:
during experiment acquisition. during experiment acquisition.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpikeEventSeries any_of:
- range: SpikeEventSeries
tree_root: true tree_root: true
FilteredEphys: FilteredEphys:
name: FilteredEphys name: FilteredEphys
@ -309,12 +262,13 @@ classes:
the ElectricalSeries. the ElectricalSeries.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
LFP: LFP:
name: LFP name: LFP
@ -323,12 +277,13 @@ classes:
properties should be noted in the ElectricalSeries description or comments field. properties should be noted in the ElectricalSeries description or comments field.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
ElectrodeGroup: ElectrodeGroup:
name: ElectrodeGroup name: ElectrodeGroup
@ -385,72 +340,24 @@ classes:
3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence
should be empty (e.g., zero- filled) should be empty (e.g., zero- filled)
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_mean array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as description: Stdev of waveforms for each cluster, using the same indices as
in mean in mean
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_sd array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
tree_root: true tree_root: true
ClusterWaveforms__waveform_mean:
name: ClusterWaveforms__waveform_mean
description: The mean waveform for each cluster, using the same indices for each
wave as cluster numbers in the associated Clustering module (i.e, cluster 3
is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should
be empty (e.g., zero- filled)
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
array:
name: array
range: ClusterWaveforms__waveform_mean__Array
ClusterWaveforms__waveform_mean__Array:
name: ClusterWaveforms__waveform_mean__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
ClusterWaveforms__waveform_sd:
name: ClusterWaveforms__waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as in
mean
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
array:
name: array
range: ClusterWaveforms__waveform_sd__Array
ClusterWaveforms__waveform_sd__Array:
name: ClusterWaveforms__waveform_sd__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
Clustering: Clustering:
name: Clustering name: Clustering
description: DEPRECATED Clustered spike data, whether from automatic clustering description: DEPRECATED Clustered spike data, whether from automatic clustering
@ -472,21 +379,30 @@ classes:
num: num:
name: num name: num
description: Cluster number of each event description: Cluster number of each event
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
peak_over_rms: peak_over_rms:
name: peak_over_rms name: peak_over_rms
description: Maximum ratio of waveform peak to RMS on any channel in the cluster description: Maximum ratio of waveform peak to RMS on any channel in the cluster
(provides a basic clustering metric). (provides a basic clustering metric).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_clusters
range: float32 range: float32
required: true required: true
times: times:
name: times name: times
description: Times of clustered events, in seconds. This may be a link to description: Times of clustered events, in seconds. This may be a link to
times field in associated FeatureExtraction module. times field in associated FeatureExtraction module.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.epoch name: core.nwb.epoch
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.epoch id: core.nwb.epoch
version: 2.2.0 version: 2.2.0
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.file name: core.nwb.file
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.file id: core.nwb.file
version: 2.2.0 version: 2.2.0
imports: imports:
@ -41,7 +48,10 @@ classes:
The file can be created after the experiment was run, so this may differ The file can be created after the experiment was run, so this may differ
from the experiment start time. Each modification to the nwb file adds a from the experiment start time. Each modification to the nwb file adds a
new entry to the array.' new entry to the array.'
multivalued: true multivalued: false
array:
dimensions:
- alias: num_modifications
range: isodatetime range: isodatetime
required: true required: true
identifier: identifier:
@ -183,9 +193,14 @@ classes:
having a particular scientific goal, trials (see trials subgroup) during having a particular scientific goal, trials (see trials subgroup) during
an experiment, or epochs (see epochs subgroup) deriving from analysis of an experiment, or epochs (see epochs subgroup) deriving from analysis of
data. data.
multivalued: false multivalued: true
range: NWBFile__intervals inlined: true
required: false inlined_as_list: false
any_of:
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
units: units:
name: units name: units
description: Data about sorted spike units. description: Data about sorted spike units.
@ -274,7 +289,10 @@ classes:
name: experimenter name: experimenter
description: Name of person(s) who performed the experiment. Can also specify description: Name of person(s) who performed the experiment. Can also specify
roles of different people involved. roles of different people involved.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_experimenters
range: text range: text
required: false required: false
institution: institution:
@ -286,7 +304,10 @@ classes:
keywords: keywords:
name: keywords name: keywords
description: Terms to search over. description: Terms to search over.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_keywords
range: text range: text
required: false required: false
lab: lab:
@ -318,7 +339,10 @@ classes:
related_publications: related_publications:
name: related_publications name: related_publications
description: Publication information. PMID, DOI, URL, etc. description: Publication information. PMID, DOI, URL, etc.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_publications
range: text range: text
required: false required: false
session_id: session_id:
@ -622,42 +646,3 @@ classes:
multivalued: false multivalued: false
range: SweepTable range: SweepTable
required: false required: false
NWBFile__intervals:
name: NWBFile__intervals
description: Experimental intervals, whether that be logically distinct sub-experiments
having a particular scientific goal, trials (see trials subgroup) during an
experiment, or epochs (see epochs subgroup) deriving from analysis of data.
attributes:
name:
name: name
ifabsent: string(intervals)
identifier: true
range: string
required: true
equals_string: intervals
epochs:
name: epochs
description: Divisions in time marking experimental stages or sub-divisions
of a single recording session.
multivalued: false
range: TimeIntervals
required: false
trials:
name: trials
description: Repeated experimental events that have a logical grouping.
multivalued: false
range: TimeIntervals
required: false
invalid_times:
name: invalid_times
description: Time intervals that should be removed from analysis.
multivalued: false
range: TimeIntervals
required: false
time_intervals:
name: time_intervals
description: Optional additional table(s) for describing other experimental
time intervals.
multivalued: true
range: TimeIntervals
required: false

View file

@ -1,4 +1,11 @@
name: core.nwb.icephys name: core.nwb.icephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.icephys id: core.nwb.icephys
version: 2.2.0 version: 2.2.0
imports: imports:
@ -30,8 +37,8 @@ classes:
data: data:
name: data name: data
description: Recorded voltage or current. description: Recorded voltage or current.
multivalued: true multivalued: false
range: numeric range: PatchClampSeries__data
required: true required: true
gain: gain:
name: gain name: gain
@ -41,6 +48,29 @@ classes:
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
PatchClampSeries__data:
name: PatchClampSeries__data
description: Recorded voltage or current.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. Actual stored
values are not necessarily stored in these units. To access the data in
these units, multiply 'data' by 'conversion'.
range: text
array:
name: array
array:
dimensions:
- alias: num_times
range: numeric
CurrentClampSeries: CurrentClampSeries:
name: CurrentClampSeries name: CurrentClampSeries
description: Voltage data from an intracellular current-clamp recording. A corresponding description: Voltage data from an intracellular current-clamp recording. A corresponding

View file

@ -1,4 +1,11 @@
name: core.nwb.image name: core.nwb.image
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.image id: core.nwb.image
version: 2.2.0 version: 2.2.0
imports: imports:
@ -16,22 +23,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: GrayscaleImage__Array
tree_root: true tree_root: true
GrayscaleImage__Array:
name: GrayscaleImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
RGBImage: RGBImage:
name: RGBImage name: RGBImage
description: A color image. description: A color image.
@ -42,28 +34,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBImage__Array
tree_root: true tree_root: true
RGBImage__Array:
name: RGBImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RGBAImage: RGBAImage:
name: RGBAImage name: RGBAImage
description: A color image with transparency. description: A color image with transparency.
@ -74,28 +45,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBAImage__Array
tree_root: true tree_root: true
RGBAImage__Array:
name: RGBAImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b, a:
name: r, g, b, a
range: numeric
required: true
minimum_cardinality: 4
maximum_cardinality: 4
ImageSeries: ImageSeries:
name: ImageSeries name: ImageSeries
description: General image data that is common between acquisition and stimulus description: General image data that is common between acquisition and stimulus
@ -115,12 +65,27 @@ classes:
name: data name: data
description: Binary data representing images across frames. description: Binary data representing images across frames.
multivalued: false multivalued: false
range: ImageSeries__data range: numeric
required: false required: false
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: z
dimension: dimension:
name: dimension name: dimension
description: Number of pixels on x, y, (and z) axes. description: Number of pixels on x, y, (and z) axes.
multivalued: true multivalued: false
array:
dimensions:
- alias: rank
range: int32 range: int32
required: false required: false
external_file: external_file:
@ -130,8 +95,8 @@ classes:
in the file system as one or more image file(s). This field should NOT be in the file system as one or more image file(s). This field should NOT be
used if the image is stored in another NWB file and that file is linked used if the image is stored in another NWB file and that file is linked
to this file. to this file.
multivalued: true multivalued: false
range: text range: ImageSeries__external_file
required: false required: false
format: format:
name: format name: format
@ -143,40 +108,41 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
ImageSeries__data: ImageSeries__external_file:
name: ImageSeries__data name: ImageSeries__external_file
description: Binary data representing images across frames. description: Paths to one or more external file(s). The field is only present
if format='external'. This is only relevant if the image series is stored in
the file system as one or more image file(s). This field should NOT be used
if the image is stored in another NWB file and that file is linked to this file.
attributes: attributes:
name: name:
name: name name: name
ifabsent: string(data) ifabsent: string(external_file)
identifier: true identifier: true
range: string range: string
required: true required: true
equals_string: data equals_string: external_file
starting_frame:
name: starting_frame
description: Each external image may contain one or more consecutive frames
of the full ImageSeries. This attribute serves as an index to indicate which
frames each file contains, to faciliate random access. The 'starting_frame'
attribute, hence, contains a list of frame numbers within the full ImageSeries
of the first frame of each file listed in the parent 'external_file' dataset.
Zero-based indexing is used (hence, the first element will always be zero).
For example, if the 'external_file' dataset has three paths to files and
the first file has 5 frames, the second file has 10 frames, and the third
file has 20 frames, then this attribute will have values [0, 5, 15]. If
there is a single external file that holds all of the frames of the ImageSeries
(and so there is a single element in the 'external_file' dataset), then
this attribute should have value [0].
range: int32
array: array:
name: array name: array
range: ImageSeries__data__Array array:
ImageSeries__data__Array: dimensions:
name: ImageSeries__data__Array - alias: num_files
is_a: Arraylike range: text
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
z:
name: z
range: numeric
required: false
ImageMaskSeries: ImageMaskSeries:
name: ImageMaskSeries name: ImageMaskSeries
description: An alpha mask that is applied to a presented visual stimulus. The description: An alpha mask that is applied to a presented visual stimulus. The
@ -216,8 +182,17 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: OpticalSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width, height
exact_cardinality: 2
- array:
dimensions:
- alias: width, height, depth
exact_cardinality: 3
orientation: orientation:
name: orientation name: orientation
description: Description of image relative to some reference frame (e.g., description: Description of image relative to some reference frame (e.g.,
@ -226,36 +201,6 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
OpticalSeries__field_of_view:
name: OpticalSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: OpticalSeries__field_of_view__Array
OpticalSeries__field_of_view__Array:
name: OpticalSeries__field_of_view__Array
is_a: Arraylike
attributes:
width, height:
name: width, height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width, height, depth:
name: width, height, depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
IndexSeries: IndexSeries:
name: IndexSeries name: IndexSeries
description: Stores indices to image frames stored in an ImageSeries. The purpose description: Stores indices to image frames stored in an ImageSeries. The purpose
@ -274,7 +219,10 @@ classes:
data: data:
name: data name: data
description: Index of the frame in the referenced ImageSeries. description: Index of the frame in the referenced ImageSeries.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int32 range: int32
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.language name: core.nwb.language
annotations:
is_namespace:
tag: is_namespace
value: 'False'
namespace:
tag: namespace
value: core
description: Adapter objects to mimic the behavior of elements in the nwb-schema-language description: Adapter objects to mimic the behavior of elements in the nwb-schema-language
id: nwb.language id: nwb.language
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.misc name: core.nwb.misc
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.misc id: core.nwb.misc
version: 2.2.0 version: 2.2.0
imports: imports:
@ -35,13 +42,19 @@ classes:
feature_units: feature_units:
name: feature_units name: feature_units
description: Units of each feature. description: Units of each feature.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: false required: false
features: features:
name: features name: features
description: Description of the features represented in TimeSeries::data. description: Description of the features represented in TimeSeries::data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -64,19 +77,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AbstractFeatureSeries__data__Array
AbstractFeatureSeries__data__Array:
name: AbstractFeatureSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
AnnotationSeries: AnnotationSeries:
name: AnnotationSeries name: AnnotationSeries
description: Stores user annotations made during an experiment. The data[] field description: Stores user annotations made during an experiment. The data[] field
@ -93,7 +102,10 @@ classes:
data: data:
name: data name: data
description: Annotations made during an experiment. description: Annotations made during an experiment.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -116,7 +128,10 @@ classes:
data: data:
name: data name: data
description: Use values >0 if interval started, <0 if interval ended. description: Use values >0 if interval started, <0 if interval ended.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int8 range: int8
required: true required: true
tree_root: true tree_root: true
@ -169,23 +184,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: DecompositionSeries__data__Array array:
DecompositionSeries__data__Array: dimensions:
name: DecompositionSeries__data__Array - alias: num_times
is_a: Arraylike - alias: num_channels
attributes: - alias: num_bands
num_times:
name: num_times
range: numeric range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: true
num_bands:
name: num_bands
range: numeric
required: true
DecompositionSeries__bands: DecompositionSeries__bands:
name: DecompositionSeries__bands name: DecompositionSeries__bands
description: Table for describing the bands that this series was generated from. description: Table for describing the bands that this series was generated from.
@ -209,33 +213,31 @@ classes:
description: Low and high limit of each band in Hz. If it is a Gaussian filter, description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center. use 2 SD on either side of the center.
multivalued: false multivalued: false
range: DecompositionSeries__bands__band_limits array:
dimensions:
- alias: num_bands
- alias: low, high
exact_cardinality: 2
range: float32
required: true required: true
band_mean: band_mean:
name: band_mean name: band_mean
description: The mean Gaussian filters, in Hz. description: The mean Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
band_stdev: band_stdev:
name: band_stdev name: band_stdev
description: The standard deviation of Gaussian filters, in Hz. description: The standard deviation of Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
DecompositionSeries__bands__band_limits:
name: DecompositionSeries__bands__band_limits
description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(band_limits)
identifier: true
range: string
required: true
equals_string: band_limits
Units: Units:
name: Units name: Units
description: Data about spiking units. Event times of observed units (e.g. cell, description: Data about spiking units. Event times of observed units (e.g. cell,
@ -269,7 +271,12 @@ classes:
name: obs_intervals name: obs_intervals
description: Observation intervals for each unit. description: Observation intervals for each unit.
multivalued: false multivalued: false
range: Units__obs_intervals array:
dimensions:
- alias: num_intervals
- alias: start|end
exact_cardinality: 2
range: float64
required: false required: false
electrodes_index: electrodes_index:
name: electrodes_index name: electrodes_index
@ -292,14 +299,34 @@ classes:
name: waveform_mean name: waveform_mean
description: Spike waveform mean for each spike unit. description: Spike waveform mean for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_mean range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Spike waveform standard deviation for each spike unit. description: Spike waveform standard deviation for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_sd range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
tree_root: true tree_root: true
Units__spike_times_index: Units__spike_times_index:
name: Units__spike_times_index name: Units__spike_times_index
@ -345,18 +372,6 @@ classes:
range: string range: string
required: true required: true
equals_string: obs_intervals_index equals_string: obs_intervals_index
Units__obs_intervals:
name: Units__obs_intervals
description: Observation intervals for each unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(obs_intervals)
identifier: true
range: string
required: true
equals_string: obs_intervals
Units__electrodes_index: Units__electrodes_index:
name: Units__electrodes_index name: Units__electrodes_index
description: Index into electrodes. description: Index into electrodes.
@ -381,43 +396,3 @@ classes:
range: string range: string
required: true required: true
equals_string: electrodes equals_string: electrodes
Units__waveform_mean:
name: Units__waveform_mean
description: Spike waveform mean for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveform_sd:
name: Units__waveform_sd
description: Spike waveform standard deviation for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text

View file

@ -1,4 +1,11 @@
name: core.nwb.ogen name: core.nwb.ogen
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ogen id: core.nwb.ogen
version: 2.2.0 version: 2.2.0
imports: imports:
@ -20,7 +27,10 @@ classes:
data: data:
name: data name: data
description: Applied power for optogenetic stimulus, in watts. description: Applied power for optogenetic stimulus, in watts.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: numeric range: numeric
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.ophys name: core.nwb.ophys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ophys id: core.nwb.ophys
version: 2.2.0 version: 2.2.0
imports: imports:
@ -33,39 +40,18 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: TwoPhotonSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width|height
exact_cardinality: 2
- array:
dimensions:
- alias: width|height
exact_cardinality: 3
tree_root: true tree_root: true
TwoPhotonSeries__field_of_view:
name: TwoPhotonSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: TwoPhotonSeries__field_of_view__Array
TwoPhotonSeries__field_of_view__Array:
name: TwoPhotonSeries__field_of_view__Array
is_a: Arraylike
attributes:
width|height:
name: width|height
range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
width|height|depth:
name: width|height|depth
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RoiResponseSeries: RoiResponseSeries:
name: RoiResponseSeries name: RoiResponseSeries
description: ROI responses over an imaging plane. The first dimension represents description: ROI responses over an imaging plane. The first dimension represents
@ -81,8 +67,16 @@ classes:
name: data name: data
description: Signals from ROIs. description: Signals from ROIs.
multivalued: false multivalued: false
range: RoiResponseSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_ROIs
rois: rois:
name: rois name: rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -91,32 +85,6 @@ classes:
range: RoiResponseSeries__rois range: RoiResponseSeries__rois
required: true required: true
tree_root: true tree_root: true
RoiResponseSeries__data:
name: RoiResponseSeries__data
description: Signals from ROIs.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: RoiResponseSeries__data__Array
RoiResponseSeries__data__Array:
name: RoiResponseSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_ROIs:
name: num_ROIs
range: numeric
required: false
RoiResponseSeries__rois: RoiResponseSeries__rois:
name: RoiResponseSeries__rois name: RoiResponseSeries__rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -137,12 +105,13 @@ classes:
for image planes). for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
Fluorescence: Fluorescence:
name: Fluorescence name: Fluorescence
@ -151,12 +120,13 @@ classes:
for ROIs and for image planes). for ROIs and for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
ImageSegmentation: ImageSegmentation:
name: ImageSegmentation name: ImageSegmentation
@ -169,12 +139,13 @@ classes:
is required and ROI names should remain consistent between them. is required and ROI names should remain consistent between them.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: DynamicTable any_of:
- range: DynamicTable
tree_root: true tree_root: true
ImagingPlane: ImagingPlane:
name: ImagingPlane name: ImagingPlane
@ -302,29 +273,21 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingPlane__manifold__Array
ImagingPlane__manifold__Array:
name: ImagingPlane__manifold__Array
is_a: Arraylike
attributes:
height:
name: height
range: float32 range: float32
required: true any_of:
width: - array:
name: width dimensions:
range: float32 - alias: height
required: true - alias: width
x, y, z: - alias: x, y, z
name: x, y, z exact_cardinality: 3
range: float32 - array:
required: true dimensions:
minimum_cardinality: 3 - alias: height
maximum_cardinality: 3 - alias: width
depth: - alias: depth
name: depth - alias: x, y, z
range: float32 exact_cardinality: 3
required: false
ImagingPlane__origin_coords: ImagingPlane__origin_coords:
name: ImagingPlane__origin_coords name: ImagingPlane__origin_coords
description: Physical location of the first element of the imaging plane (0, 0) description: Physical location of the first element of the imaging plane (0, 0)
@ -344,23 +307,13 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingPlane__origin_coords__Array array:
ImagingPlane__origin_coords__Array: dimensions:
name: ImagingPlane__origin_coords__Array - alias: x, y
is_a: Arraylike exact_cardinality: 2
attributes: - alias: x, y, z
x, y: exact_cardinality: 3
name: x, y
range: float32 range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
x, y, z:
name: x, y, z
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
ImagingPlane__grid_spacing: ImagingPlane__grid_spacing:
name: ImagingPlane__grid_spacing name: ImagingPlane__grid_spacing
description: Space between pixels in (x, y) or voxels in (x, y, z) directions, description: Space between pixels in (x, y) or voxels in (x, y, z) directions,
@ -380,23 +333,13 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingPlane__grid_spacing__Array array:
ImagingPlane__grid_spacing__Array: dimensions:
name: ImagingPlane__grid_spacing__Array - alias: x, y
is_a: Arraylike exact_cardinality: 2
attributes: - alias: x, y, z
x, y: exact_cardinality: 3
name: x, y
range: float32 range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
x, y, z:
name: x, y, z
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
OpticalChannel: OpticalChannel:
name: OpticalChannel name: OpticalChannel
description: An optical channel used to record from an imaging plane. description: An optical channel used to record from an imaging plane.
@ -426,10 +369,11 @@ classes:
frame at each point in time is assumed to be 2-D (has only x & y dimensions).' frame at each point in time is assumed to be 2-D (has only x & y dimensions).'
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: NWBDataInterface
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.retinotopy name: core.nwb.retinotopy
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.retinotopy id: core.nwb.retinotopy
version: 2.2.0 version: 2.2.0
imports: imports:
@ -28,20 +35,12 @@ classes:
range: float32 range: float32
array: array:
name: array name: array
range: RetinotopyMap__Array array:
dimensions:
- alias: num_rows
- alias: num_cols
range: float32
tree_root: true tree_root: true
RetinotopyMap__Array:
name: RetinotopyMap__Array
is_a: Arraylike
attributes:
num_rows:
name: num_rows
range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
AxisMap: AxisMap:
name: AxisMap name: AxisMap
description: Abstract two-dimensional map of responses to stimuli along a single description: Abstract two-dimensional map of responses to stimuli along a single
@ -59,20 +58,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AxisMap__Array array:
dimensions:
- alias: num_rows
- alias: num_cols
range: float32
tree_root: true tree_root: true
AxisMap__Array:
name: AxisMap__Array
is_a: Arraylike
attributes:
num_rows:
name: num_rows
range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
RetinotopyImage: RetinotopyImage:
name: RetinotopyImage name: RetinotopyImage
description: 'Gray-scale image related to retinotopic mapping. Array structure: description: 'Gray-scale image related to retinotopic mapping. Array structure:
@ -155,7 +146,11 @@ classes:
description: Two-element array describing the contents of the two response description: Two-element array describing the contents of the two response
axis fields. Description should be something like ['altitude', 'azimuth'] axis fields. Description should be something like ['altitude', 'azimuth']
or '['radius', 'theta']. or '['radius', 'theta'].
multivalued: true multivalued: false
array:
dimensions:
- alias: num_axes
exact_cardinality: 2
range: text range: text
required: true required: true
focal_depth_image: focal_depth_image:

View file

@ -1,8 +1,11 @@
name: core name: core
annotations: annotations:
is_namespace:
tag: is_namespace
value: true
namespace: namespace:
tag: namespace tag: namespace
value: 'True' value: core
description: NWB namespace description: NWB namespace
id: core id: core
version: 2.2.0 version: 2.2.0

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.2.1 version: 2.2.1
imports: imports:
@ -39,32 +46,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -130,7 +130,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -138,7 +141,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -146,7 +152,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -201,27 +210,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -268,13 +276,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.2.1 version: 2.2.1
imports: imports:
@ -59,19 +66,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -88,12 +91,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -101,12 +105,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -114,36 +119,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -154,22 +162,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.device name: core.nwb.device
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.device id: core.nwb.device
version: 2.2.1 version: 2.2.1
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.ecephys name: core.nwb.ecephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ecephys id: core.nwb.ecephys
version: 2.2.1 version: 2.2.1
imports: imports:
@ -25,8 +32,21 @@ classes:
name: data name: data
description: Recorded voltage data. description: Recorded voltage data.
multivalued: false multivalued: false
range: ElectricalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_channels
- array:
dimensions:
- alias: num_times
- alias: num_channels
- alias: num_samples
electrodes: electrodes:
name: electrodes name: electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -45,47 +65,13 @@ classes:
as native values generated by data acquisition systems. If this dataset as native values generated by data acquisition systems. If this dataset
is not present, then there is no channel-specific conversion factor, i.e. is not present, then there is no channel-specific conversion factor, i.e.
it is 1 for all channels. it is 1 for all channels.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_channels
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
ElectricalSeries__data:
name: ElectricalSeries__data
description: Recorded voltage data.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. This value
is fixed to 'volts'. Actual stored values are not necessarily stored in
these units. To access the data in these units, multiply 'data' by 'conversion'
and 'channel_conversion' (if present).
range: text
array:
name: array
range: ElectricalSeries__data__Array
ElectricalSeries__data__Array:
name: ElectricalSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
num_samples:
name: num_samples
range: numeric
required: false
ElectricalSeries__electrodes: ElectricalSeries__electrodes:
name: ElectricalSeries__electrodes name: ElectricalSeries__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -120,52 +106,31 @@ classes:
name: data name: data
description: Spike waveforms. description: Spike waveforms.
multivalued: false multivalued: false
range: SpikeEventSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_events
- alias: num_samples
- array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_samples
timestamps: timestamps:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
Timestamps are required for the events. Unlike for TimeSeries, timestamps Timestamps are required for the events. Unlike for TimeSeries, timestamps
are required for SpikeEventSeries and are thus re-specified here. are required for SpikeEventSeries and are thus re-specified here.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
SpikeEventSeries__data:
name: SpikeEventSeries__data
description: Spike waveforms.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Unit of measurement for waveforms, which is fixed to 'volts'.
range: text
array:
name: array
range: SpikeEventSeries__data__Array
SpikeEventSeries__data__Array:
name: SpikeEventSeries__data__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: numeric
required: true
num_samples:
name: num_samples
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
FeatureExtraction: FeatureExtraction:
name: FeatureExtraction name: FeatureExtraction
description: Features, such as PC1 and PC2, that are extracted from signals stored description: Features, such as PC1 and PC2, that are extracted from signals stored
@ -181,19 +146,30 @@ classes:
name: description name: description
description: Description of features (eg, ''PC1'') for each of the extracted description: Description of features (eg, ''PC1'') for each of the extracted
features. features.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
features: features:
name: features name: features
description: Multi-dimensional array of features extracted from each event. description: Multi-dimensional array of features extracted from each event.
multivalued: false multivalued: false
range: FeatureExtraction__features array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_features
range: float32
required: true required: true
times: times:
name: times name: times
description: Times of events that features correspond to (can be a link). description: Times of events that features correspond to (can be a link).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
electrodes: electrodes:
@ -204,36 +180,6 @@ classes:
range: FeatureExtraction__electrodes range: FeatureExtraction__electrodes
required: true required: true
tree_root: true tree_root: true
FeatureExtraction__features:
name: FeatureExtraction__features
description: Multi-dimensional array of features extracted from each event.
attributes:
name:
name: name
ifabsent: string(features)
identifier: true
range: string
required: true
equals_string: features
array:
name: array
range: FeatureExtraction__features__Array
FeatureExtraction__features__Array:
name: FeatureExtraction__features__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: float32
required: true
num_channels:
name: num_channels
range: float32
required: true
num_features:
name: num_features
range: float32
required: true
FeatureExtraction__electrodes: FeatureExtraction__electrodes:
name: FeatureExtraction__electrodes name: FeatureExtraction__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -270,13 +216,19 @@ classes:
corresponding to time of event. ''description'' should define what is meant corresponding to time of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing by time of event (e.g., .25 ms before action potential peak, zero-crossing
time, etc). The index points to each event from the raw data. time, etc). The index points to each event from the raw data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
times: times:
name: times name: times
description: Timestamps of events, in seconds. description: Timestamps of events, in seconds.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
@ -287,12 +239,13 @@ classes:
during experiment acquisition. during experiment acquisition.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpikeEventSeries any_of:
- range: SpikeEventSeries
tree_root: true tree_root: true
FilteredEphys: FilteredEphys:
name: FilteredEphys name: FilteredEphys
@ -309,12 +262,13 @@ classes:
the ElectricalSeries. the ElectricalSeries.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
LFP: LFP:
name: LFP name: LFP
@ -323,12 +277,13 @@ classes:
properties should be noted in the ElectricalSeries description or comments field. properties should be noted in the ElectricalSeries description or comments field.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
ElectrodeGroup: ElectrodeGroup:
name: ElectrodeGroup name: ElectrodeGroup
@ -385,72 +340,24 @@ classes:
3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence
should be empty (e.g., zero- filled) should be empty (e.g., zero- filled)
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_mean array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as description: Stdev of waveforms for each cluster, using the same indices as
in mean in mean
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_sd array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
tree_root: true tree_root: true
ClusterWaveforms__waveform_mean:
name: ClusterWaveforms__waveform_mean
description: The mean waveform for each cluster, using the same indices for each
wave as cluster numbers in the associated Clustering module (i.e, cluster 3
is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should
be empty (e.g., zero- filled)
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
array:
name: array
range: ClusterWaveforms__waveform_mean__Array
ClusterWaveforms__waveform_mean__Array:
name: ClusterWaveforms__waveform_mean__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
ClusterWaveforms__waveform_sd:
name: ClusterWaveforms__waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as in
mean
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
array:
name: array
range: ClusterWaveforms__waveform_sd__Array
ClusterWaveforms__waveform_sd__Array:
name: ClusterWaveforms__waveform_sd__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
Clustering: Clustering:
name: Clustering name: Clustering
description: DEPRECATED Clustered spike data, whether from automatic clustering description: DEPRECATED Clustered spike data, whether from automatic clustering
@ -472,21 +379,30 @@ classes:
num: num:
name: num name: num
description: Cluster number of each event description: Cluster number of each event
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
peak_over_rms: peak_over_rms:
name: peak_over_rms name: peak_over_rms
description: Maximum ratio of waveform peak to RMS on any channel in the cluster description: Maximum ratio of waveform peak to RMS on any channel in the cluster
(provides a basic clustering metric). (provides a basic clustering metric).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_clusters
range: float32 range: float32
required: true required: true
times: times:
name: times name: times
description: Times of clustered events, in seconds. This may be a link to description: Times of clustered events, in seconds. This may be a link to
times field in associated FeatureExtraction module. times field in associated FeatureExtraction module.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.epoch name: core.nwb.epoch
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.epoch id: core.nwb.epoch
version: 2.2.1 version: 2.2.1
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.file name: core.nwb.file
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.file id: core.nwb.file
version: 2.2.1 version: 2.2.1
imports: imports:
@ -41,7 +48,10 @@ classes:
The file can be created after the experiment was run, so this may differ The file can be created after the experiment was run, so this may differ
from the experiment start time. Each modification to the nwb file adds a from the experiment start time. Each modification to the nwb file adds a
new entry to the array.' new entry to the array.'
multivalued: true multivalued: false
array:
dimensions:
- alias: num_modifications
range: isodatetime range: isodatetime
required: true required: true
identifier: identifier:
@ -183,9 +193,14 @@ classes:
having a particular scientific goal, trials (see trials subgroup) during having a particular scientific goal, trials (see trials subgroup) during
an experiment, or epochs (see epochs subgroup) deriving from analysis of an experiment, or epochs (see epochs subgroup) deriving from analysis of
data. data.
multivalued: false multivalued: true
range: NWBFile__intervals inlined: true
required: false inlined_as_list: false
any_of:
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
units: units:
name: units name: units
description: Data about sorted spike units. description: Data about sorted spike units.
@ -274,7 +289,10 @@ classes:
name: experimenter name: experimenter
description: Name of person(s) who performed the experiment. Can also specify description: Name of person(s) who performed the experiment. Can also specify
roles of different people involved. roles of different people involved.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_experimenters
range: text range: text
required: false required: false
institution: institution:
@ -286,7 +304,10 @@ classes:
keywords: keywords:
name: keywords name: keywords
description: Terms to search over. description: Terms to search over.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_keywords
range: text range: text
required: false required: false
lab: lab:
@ -318,7 +339,10 @@ classes:
related_publications: related_publications:
name: related_publications name: related_publications
description: Publication information. PMID, DOI, URL, etc. description: Publication information. PMID, DOI, URL, etc.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_publications
range: text range: text
required: false required: false
session_id: session_id:
@ -622,42 +646,3 @@ classes:
multivalued: false multivalued: false
range: SweepTable range: SweepTable
required: false required: false
NWBFile__intervals:
name: NWBFile__intervals
description: Experimental intervals, whether that be logically distinct sub-experiments
having a particular scientific goal, trials (see trials subgroup) during an
experiment, or epochs (see epochs subgroup) deriving from analysis of data.
attributes:
name:
name: name
ifabsent: string(intervals)
identifier: true
range: string
required: true
equals_string: intervals
epochs:
name: epochs
description: Divisions in time marking experimental stages or sub-divisions
of a single recording session.
multivalued: false
range: TimeIntervals
required: false
trials:
name: trials
description: Repeated experimental events that have a logical grouping.
multivalued: false
range: TimeIntervals
required: false
invalid_times:
name: invalid_times
description: Time intervals that should be removed from analysis.
multivalued: false
range: TimeIntervals
required: false
time_intervals:
name: time_intervals
description: Optional additional table(s) for describing other experimental
time intervals.
multivalued: true
range: TimeIntervals
required: false

View file

@ -1,4 +1,11 @@
name: core.nwb.icephys name: core.nwb.icephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.icephys id: core.nwb.icephys
version: 2.2.1 version: 2.2.1
imports: imports:
@ -30,8 +37,8 @@ classes:
data: data:
name: data name: data
description: Recorded voltage or current. description: Recorded voltage or current.
multivalued: true multivalued: false
range: numeric range: PatchClampSeries__data
required: true required: true
gain: gain:
name: gain name: gain
@ -41,6 +48,29 @@ classes:
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
PatchClampSeries__data:
name: PatchClampSeries__data
description: Recorded voltage or current.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. Actual stored
values are not necessarily stored in these units. To access the data in
these units, multiply 'data' by 'conversion'.
range: text
array:
name: array
array:
dimensions:
- alias: num_times
range: numeric
CurrentClampSeries: CurrentClampSeries:
name: CurrentClampSeries name: CurrentClampSeries
description: Voltage data from an intracellular current-clamp recording. A corresponding description: Voltage data from an intracellular current-clamp recording. A corresponding

View file

@ -1,4 +1,11 @@
name: core.nwb.image name: core.nwb.image
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.image id: core.nwb.image
version: 2.2.1 version: 2.2.1
imports: imports:
@ -16,22 +23,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: GrayscaleImage__Array
tree_root: true tree_root: true
GrayscaleImage__Array:
name: GrayscaleImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
RGBImage: RGBImage:
name: RGBImage name: RGBImage
description: A color image. description: A color image.
@ -42,28 +34,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBImage__Array
tree_root: true tree_root: true
RGBImage__Array:
name: RGBImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RGBAImage: RGBAImage:
name: RGBAImage name: RGBAImage
description: A color image with transparency. description: A color image with transparency.
@ -74,28 +45,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBAImage__Array
tree_root: true tree_root: true
RGBAImage__Array:
name: RGBAImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b, a:
name: r, g, b, a
range: numeric
required: true
minimum_cardinality: 4
maximum_cardinality: 4
ImageSeries: ImageSeries:
name: ImageSeries name: ImageSeries
description: General image data that is common between acquisition and stimulus description: General image data that is common between acquisition and stimulus
@ -115,12 +65,27 @@ classes:
name: data name: data
description: Binary data representing images across frames. description: Binary data representing images across frames.
multivalued: false multivalued: false
range: ImageSeries__data range: numeric
required: false required: false
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: z
dimension: dimension:
name: dimension name: dimension
description: Number of pixels on x, y, (and z) axes. description: Number of pixels on x, y, (and z) axes.
multivalued: true multivalued: false
array:
dimensions:
- alias: rank
range: int32 range: int32
required: false required: false
external_file: external_file:
@ -130,8 +95,8 @@ classes:
in the file system as one or more image file(s). This field should NOT be in the file system as one or more image file(s). This field should NOT be
used if the image is stored in another NWB file and that file is linked used if the image is stored in another NWB file and that file is linked
to this file. to this file.
multivalued: true multivalued: false
range: text range: ImageSeries__external_file
required: false required: false
format: format:
name: format name: format
@ -143,40 +108,41 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
ImageSeries__data: ImageSeries__external_file:
name: ImageSeries__data name: ImageSeries__external_file
description: Binary data representing images across frames. description: Paths to one or more external file(s). The field is only present
if format='external'. This is only relevant if the image series is stored in
the file system as one or more image file(s). This field should NOT be used
if the image is stored in another NWB file and that file is linked to this file.
attributes: attributes:
name: name:
name: name name: name
ifabsent: string(data) ifabsent: string(external_file)
identifier: true identifier: true
range: string range: string
required: true required: true
equals_string: data equals_string: external_file
starting_frame:
name: starting_frame
description: Each external image may contain one or more consecutive frames
of the full ImageSeries. This attribute serves as an index to indicate which
frames each file contains, to faciliate random access. The 'starting_frame'
attribute, hence, contains a list of frame numbers within the full ImageSeries
of the first frame of each file listed in the parent 'external_file' dataset.
Zero-based indexing is used (hence, the first element will always be zero).
For example, if the 'external_file' dataset has three paths to files and
the first file has 5 frames, the second file has 10 frames, and the third
file has 20 frames, then this attribute will have values [0, 5, 15]. If
there is a single external file that holds all of the frames of the ImageSeries
(and so there is a single element in the 'external_file' dataset), then
this attribute should have value [0].
range: int32
array: array:
name: array name: array
range: ImageSeries__data__Array array:
ImageSeries__data__Array: dimensions:
name: ImageSeries__data__Array - alias: num_files
is_a: Arraylike range: text
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
z:
name: z
range: numeric
required: false
ImageMaskSeries: ImageMaskSeries:
name: ImageMaskSeries name: ImageMaskSeries
description: An alpha mask that is applied to a presented visual stimulus. The description: An alpha mask that is applied to a presented visual stimulus. The
@ -216,8 +182,17 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: OpticalSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width, height
exact_cardinality: 2
- array:
dimensions:
- alias: width, height, depth
exact_cardinality: 3
orientation: orientation:
name: orientation name: orientation
description: Description of image relative to some reference frame (e.g., description: Description of image relative to some reference frame (e.g.,
@ -226,36 +201,6 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
OpticalSeries__field_of_view:
name: OpticalSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: OpticalSeries__field_of_view__Array
OpticalSeries__field_of_view__Array:
name: OpticalSeries__field_of_view__Array
is_a: Arraylike
attributes:
width, height:
name: width, height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width, height, depth:
name: width, height, depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
IndexSeries: IndexSeries:
name: IndexSeries name: IndexSeries
description: Stores indices to image frames stored in an ImageSeries. The purpose description: Stores indices to image frames stored in an ImageSeries. The purpose
@ -274,7 +219,10 @@ classes:
data: data:
name: data name: data
description: Index of the frame in the referenced ImageSeries. description: Index of the frame in the referenced ImageSeries.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int32 range: int32
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.language name: core.nwb.language
annotations:
is_namespace:
tag: is_namespace
value: 'False'
namespace:
tag: namespace
value: core
description: Adapter objects to mimic the behavior of elements in the nwb-schema-language description: Adapter objects to mimic the behavior of elements in the nwb-schema-language
id: nwb.language id: nwb.language
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.misc name: core.nwb.misc
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.misc id: core.nwb.misc
version: 2.2.1 version: 2.2.1
imports: imports:
@ -35,13 +42,19 @@ classes:
feature_units: feature_units:
name: feature_units name: feature_units
description: Units of each feature. description: Units of each feature.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: false required: false
features: features:
name: features name: features
description: Description of the features represented in TimeSeries::data. description: Description of the features represented in TimeSeries::data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -64,19 +77,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AbstractFeatureSeries__data__Array
AbstractFeatureSeries__data__Array:
name: AbstractFeatureSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
AnnotationSeries: AnnotationSeries:
name: AnnotationSeries name: AnnotationSeries
description: Stores user annotations made during an experiment. The data[] field description: Stores user annotations made during an experiment. The data[] field
@ -93,7 +102,10 @@ classes:
data: data:
name: data name: data
description: Annotations made during an experiment. description: Annotations made during an experiment.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -116,7 +128,10 @@ classes:
data: data:
name: data name: data
description: Use values >0 if interval started, <0 if interval ended. description: Use values >0 if interval started, <0 if interval ended.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int8 range: int8
required: true required: true
tree_root: true tree_root: true
@ -169,23 +184,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: DecompositionSeries__data__Array array:
DecompositionSeries__data__Array: dimensions:
name: DecompositionSeries__data__Array - alias: num_times
is_a: Arraylike - alias: num_channels
attributes: - alias: num_bands
num_times:
name: num_times
range: numeric range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: true
num_bands:
name: num_bands
range: numeric
required: true
DecompositionSeries__bands: DecompositionSeries__bands:
name: DecompositionSeries__bands name: DecompositionSeries__bands
description: Table for describing the bands that this series was generated from. description: Table for describing the bands that this series was generated from.
@ -209,33 +213,31 @@ classes:
description: Low and high limit of each band in Hz. If it is a Gaussian filter, description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center. use 2 SD on either side of the center.
multivalued: false multivalued: false
range: DecompositionSeries__bands__band_limits array:
dimensions:
- alias: num_bands
- alias: low, high
exact_cardinality: 2
range: float32
required: true required: true
band_mean: band_mean:
name: band_mean name: band_mean
description: The mean Gaussian filters, in Hz. description: The mean Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
band_stdev: band_stdev:
name: band_stdev name: band_stdev
description: The standard deviation of Gaussian filters, in Hz. description: The standard deviation of Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
DecompositionSeries__bands__band_limits:
name: DecompositionSeries__bands__band_limits
description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(band_limits)
identifier: true
range: string
required: true
equals_string: band_limits
Units: Units:
name: Units name: Units
description: Data about spiking units. Event times of observed units (e.g. cell, description: Data about spiking units. Event times of observed units (e.g. cell,
@ -269,7 +271,12 @@ classes:
name: obs_intervals name: obs_intervals
description: Observation intervals for each unit. description: Observation intervals for each unit.
multivalued: false multivalued: false
range: Units__obs_intervals array:
dimensions:
- alias: num_intervals
- alias: start|end
exact_cardinality: 2
range: float64
required: false required: false
electrodes_index: electrodes_index:
name: electrodes_index name: electrodes_index
@ -292,14 +299,34 @@ classes:
name: waveform_mean name: waveform_mean
description: Spike waveform mean for each spike unit. description: Spike waveform mean for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_mean range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Spike waveform standard deviation for each spike unit. description: Spike waveform standard deviation for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_sd range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
tree_root: true tree_root: true
Units__spike_times_index: Units__spike_times_index:
name: Units__spike_times_index name: Units__spike_times_index
@ -345,18 +372,6 @@ classes:
range: string range: string
required: true required: true
equals_string: obs_intervals_index equals_string: obs_intervals_index
Units__obs_intervals:
name: Units__obs_intervals
description: Observation intervals for each unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(obs_intervals)
identifier: true
range: string
required: true
equals_string: obs_intervals
Units__electrodes_index: Units__electrodes_index:
name: Units__electrodes_index name: Units__electrodes_index
description: Index into electrodes. description: Index into electrodes.
@ -381,43 +396,3 @@ classes:
range: string range: string
required: true required: true
equals_string: electrodes equals_string: electrodes
Units__waveform_mean:
name: Units__waveform_mean
description: Spike waveform mean for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveform_sd:
name: Units__waveform_sd
description: Spike waveform standard deviation for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text

View file

@ -1,4 +1,11 @@
name: core.nwb.ogen name: core.nwb.ogen
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ogen id: core.nwb.ogen
version: 2.2.1 version: 2.2.1
imports: imports:
@ -20,7 +27,10 @@ classes:
data: data:
name: data name: data
description: Applied power for optogenetic stimulus, in watts. description: Applied power for optogenetic stimulus, in watts.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: numeric range: numeric
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.ophys name: core.nwb.ophys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ophys id: core.nwb.ophys
version: 2.2.1 version: 2.2.1
imports: imports:
@ -33,39 +40,18 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: TwoPhotonSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width|height
exact_cardinality: 2
- array:
dimensions:
- alias: width|height
exact_cardinality: 3
tree_root: true tree_root: true
TwoPhotonSeries__field_of_view:
name: TwoPhotonSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: TwoPhotonSeries__field_of_view__Array
TwoPhotonSeries__field_of_view__Array:
name: TwoPhotonSeries__field_of_view__Array
is_a: Arraylike
attributes:
width|height:
name: width|height
range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
width|height|depth:
name: width|height|depth
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RoiResponseSeries: RoiResponseSeries:
name: RoiResponseSeries name: RoiResponseSeries
description: ROI responses over an imaging plane. The first dimension represents description: ROI responses over an imaging plane. The first dimension represents
@ -81,8 +67,16 @@ classes:
name: data name: data
description: Signals from ROIs. description: Signals from ROIs.
multivalued: false multivalued: false
range: RoiResponseSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_ROIs
rois: rois:
name: rois name: rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -91,32 +85,6 @@ classes:
range: RoiResponseSeries__rois range: RoiResponseSeries__rois
required: true required: true
tree_root: true tree_root: true
RoiResponseSeries__data:
name: RoiResponseSeries__data
description: Signals from ROIs.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: RoiResponseSeries__data__Array
RoiResponseSeries__data__Array:
name: RoiResponseSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_ROIs:
name: num_ROIs
range: numeric
required: false
RoiResponseSeries__rois: RoiResponseSeries__rois:
name: RoiResponseSeries__rois name: RoiResponseSeries__rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -137,12 +105,13 @@ classes:
for image planes). for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
Fluorescence: Fluorescence:
name: Fluorescence name: Fluorescence
@ -151,12 +120,13 @@ classes:
for ROIs and for image planes). for ROIs and for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
ImageSegmentation: ImageSegmentation:
name: ImageSegmentation name: ImageSegmentation
@ -169,12 +139,13 @@ classes:
is required and ROI names should remain consistent between them. is required and ROI names should remain consistent between them.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: DynamicTable any_of:
- range: DynamicTable
tree_root: true tree_root: true
ImagingPlane: ImagingPlane:
name: ImagingPlane name: ImagingPlane
@ -302,29 +273,21 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingPlane__manifold__Array
ImagingPlane__manifold__Array:
name: ImagingPlane__manifold__Array
is_a: Arraylike
attributes:
height:
name: height
range: float32 range: float32
required: true any_of:
width: - array:
name: width dimensions:
range: float32 - alias: height
required: true - alias: width
x, y, z: - alias: x, y, z
name: x, y, z exact_cardinality: 3
range: float32 - array:
required: true dimensions:
minimum_cardinality: 3 - alias: height
maximum_cardinality: 3 - alias: width
depth: - alias: depth
name: depth - alias: x, y, z
range: float32 exact_cardinality: 3
required: false
ImagingPlane__origin_coords: ImagingPlane__origin_coords:
name: ImagingPlane__origin_coords name: ImagingPlane__origin_coords
description: Physical location of the first element of the imaging plane (0, 0) description: Physical location of the first element of the imaging plane (0, 0)
@ -344,23 +307,13 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingPlane__origin_coords__Array array:
ImagingPlane__origin_coords__Array: dimensions:
name: ImagingPlane__origin_coords__Array - alias: x, y
is_a: Arraylike exact_cardinality: 2
attributes: - alias: x, y, z
x, y: exact_cardinality: 3
name: x, y
range: float32 range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
x, y, z:
name: x, y, z
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
ImagingPlane__grid_spacing: ImagingPlane__grid_spacing:
name: ImagingPlane__grid_spacing name: ImagingPlane__grid_spacing
description: Space between pixels in (x, y) or voxels in (x, y, z) directions, description: Space between pixels in (x, y) or voxels in (x, y, z) directions,
@ -380,23 +333,13 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingPlane__grid_spacing__Array array:
ImagingPlane__grid_spacing__Array: dimensions:
name: ImagingPlane__grid_spacing__Array - alias: x, y
is_a: Arraylike exact_cardinality: 2
attributes: - alias: x, y, z
x, y: exact_cardinality: 3
name: x, y
range: float32 range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
x, y, z:
name: x, y, z
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
OpticalChannel: OpticalChannel:
name: OpticalChannel name: OpticalChannel
description: An optical channel used to record from an imaging plane. description: An optical channel used to record from an imaging plane.
@ -426,10 +369,11 @@ classes:
frame at each point in time is assumed to be 2-D (has only x & y dimensions).' frame at each point in time is assumed to be 2-D (has only x & y dimensions).'
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: NWBDataInterface
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.retinotopy name: core.nwb.retinotopy
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.retinotopy id: core.nwb.retinotopy
version: 2.2.1 version: 2.2.1
imports: imports:
@ -28,20 +35,12 @@ classes:
range: float32 range: float32
array: array:
name: array name: array
range: RetinotopyMap__Array array:
dimensions:
- alias: num_rows
- alias: num_cols
range: float32
tree_root: true tree_root: true
RetinotopyMap__Array:
name: RetinotopyMap__Array
is_a: Arraylike
attributes:
num_rows:
name: num_rows
range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
AxisMap: AxisMap:
name: AxisMap name: AxisMap
description: Abstract two-dimensional map of responses to stimuli along a single description: Abstract two-dimensional map of responses to stimuli along a single
@ -59,20 +58,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AxisMap__Array array:
dimensions:
- alias: num_rows
- alias: num_cols
range: float32
tree_root: true tree_root: true
AxisMap__Array:
name: AxisMap__Array
is_a: Arraylike
attributes:
num_rows:
name: num_rows
range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
RetinotopyImage: RetinotopyImage:
name: RetinotopyImage name: RetinotopyImage
description: 'Gray-scale image related to retinotopic mapping. Array structure: description: 'Gray-scale image related to retinotopic mapping. Array structure:
@ -155,7 +146,11 @@ classes:
description: Two-element array describing the contents of the two response description: Two-element array describing the contents of the two response
axis fields. Description should be something like ['altitude', 'azimuth'] axis fields. Description should be something like ['altitude', 'azimuth']
or '['radius', 'theta']. or '['radius', 'theta'].
multivalued: true multivalued: false
array:
dimensions:
- alias: num_axes
exact_cardinality: 2
range: text range: text
required: true required: true
focal_depth_image: focal_depth_image:

View file

@ -1,8 +1,11 @@
name: core name: core
annotations: annotations:
is_namespace:
tag: is_namespace
value: true
namespace: namespace:
tag: namespace tag: namespace
value: 'True' value: core
description: NWB namespace description: NWB namespace
id: core id: core
version: 2.2.1 version: 2.2.1

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.2.2 version: 2.2.2
imports: imports:
@ -39,32 +46,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -130,7 +130,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -138,7 +141,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -146,7 +152,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -201,27 +210,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -268,13 +276,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.2.2 version: 2.2.2
imports: imports:
@ -59,19 +66,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -88,12 +91,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -101,12 +105,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -114,36 +119,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -154,22 +162,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.device name: core.nwb.device
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.device id: core.nwb.device
version: 2.2.2 version: 2.2.2
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.ecephys name: core.nwb.ecephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ecephys id: core.nwb.ecephys
version: 2.2.2 version: 2.2.2
imports: imports:
@ -25,8 +32,21 @@ classes:
name: data name: data
description: Recorded voltage data. description: Recorded voltage data.
multivalued: false multivalued: false
range: ElectricalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_channels
- array:
dimensions:
- alias: num_times
- alias: num_channels
- alias: num_samples
electrodes: electrodes:
name: electrodes name: electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -45,47 +65,13 @@ classes:
as native values generated by data acquisition systems. If this dataset as native values generated by data acquisition systems. If this dataset
is not present, then there is no channel-specific conversion factor, i.e. is not present, then there is no channel-specific conversion factor, i.e.
it is 1 for all channels. it is 1 for all channels.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_channels
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
ElectricalSeries__data:
name: ElectricalSeries__data
description: Recorded voltage data.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. This value
is fixed to 'volts'. Actual stored values are not necessarily stored in
these units. To access the data in these units, multiply 'data' by 'conversion'
and 'channel_conversion' (if present).
range: text
array:
name: array
range: ElectricalSeries__data__Array
ElectricalSeries__data__Array:
name: ElectricalSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
num_samples:
name: num_samples
range: numeric
required: false
ElectricalSeries__electrodes: ElectricalSeries__electrodes:
name: ElectricalSeries__electrodes name: ElectricalSeries__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -120,52 +106,31 @@ classes:
name: data name: data
description: Spike waveforms. description: Spike waveforms.
multivalued: false multivalued: false
range: SpikeEventSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_events
- alias: num_samples
- array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_samples
timestamps: timestamps:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
Timestamps are required for the events. Unlike for TimeSeries, timestamps Timestamps are required for the events. Unlike for TimeSeries, timestamps
are required for SpikeEventSeries and are thus re-specified here. are required for SpikeEventSeries and are thus re-specified here.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
SpikeEventSeries__data:
name: SpikeEventSeries__data
description: Spike waveforms.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Unit of measurement for waveforms, which is fixed to 'volts'.
range: text
array:
name: array
range: SpikeEventSeries__data__Array
SpikeEventSeries__data__Array:
name: SpikeEventSeries__data__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: numeric
required: true
num_samples:
name: num_samples
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
FeatureExtraction: FeatureExtraction:
name: FeatureExtraction name: FeatureExtraction
description: Features, such as PC1 and PC2, that are extracted from signals stored description: Features, such as PC1 and PC2, that are extracted from signals stored
@ -181,19 +146,30 @@ classes:
name: description name: description
description: Description of features (eg, ''PC1'') for each of the extracted description: Description of features (eg, ''PC1'') for each of the extracted
features. features.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
features: features:
name: features name: features
description: Multi-dimensional array of features extracted from each event. description: Multi-dimensional array of features extracted from each event.
multivalued: false multivalued: false
range: FeatureExtraction__features array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_features
range: float32
required: true required: true
times: times:
name: times name: times
description: Times of events that features correspond to (can be a link). description: Times of events that features correspond to (can be a link).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
electrodes: electrodes:
@ -204,36 +180,6 @@ classes:
range: FeatureExtraction__electrodes range: FeatureExtraction__electrodes
required: true required: true
tree_root: true tree_root: true
FeatureExtraction__features:
name: FeatureExtraction__features
description: Multi-dimensional array of features extracted from each event.
attributes:
name:
name: name
ifabsent: string(features)
identifier: true
range: string
required: true
equals_string: features
array:
name: array
range: FeatureExtraction__features__Array
FeatureExtraction__features__Array:
name: FeatureExtraction__features__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: float32
required: true
num_channels:
name: num_channels
range: float32
required: true
num_features:
name: num_features
range: float32
required: true
FeatureExtraction__electrodes: FeatureExtraction__electrodes:
name: FeatureExtraction__electrodes name: FeatureExtraction__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -270,13 +216,19 @@ classes:
corresponding to time of event. ''description'' should define what is meant corresponding to time of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing by time of event (e.g., .25 ms before action potential peak, zero-crossing
time, etc). The index points to each event from the raw data. time, etc). The index points to each event from the raw data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
times: times:
name: times name: times
description: Timestamps of events, in seconds. description: Timestamps of events, in seconds.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
@ -287,12 +239,13 @@ classes:
during experiment acquisition. during experiment acquisition.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpikeEventSeries any_of:
- range: SpikeEventSeries
tree_root: true tree_root: true
FilteredEphys: FilteredEphys:
name: FilteredEphys name: FilteredEphys
@ -309,12 +262,13 @@ classes:
the ElectricalSeries. the ElectricalSeries.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
LFP: LFP:
name: LFP name: LFP
@ -323,12 +277,13 @@ classes:
properties should be noted in the ElectricalSeries description or comments field. properties should be noted in the ElectricalSeries description or comments field.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
ElectrodeGroup: ElectrodeGroup:
name: ElectrodeGroup name: ElectrodeGroup
@ -385,72 +340,24 @@ classes:
3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence
should be empty (e.g., zero- filled) should be empty (e.g., zero- filled)
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_mean array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as description: Stdev of waveforms for each cluster, using the same indices as
in mean in mean
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_sd array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
tree_root: true tree_root: true
ClusterWaveforms__waveform_mean:
name: ClusterWaveforms__waveform_mean
description: The mean waveform for each cluster, using the same indices for each
wave as cluster numbers in the associated Clustering module (i.e, cluster 3
is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should
be empty (e.g., zero- filled)
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
array:
name: array
range: ClusterWaveforms__waveform_mean__Array
ClusterWaveforms__waveform_mean__Array:
name: ClusterWaveforms__waveform_mean__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
ClusterWaveforms__waveform_sd:
name: ClusterWaveforms__waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as in
mean
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
array:
name: array
range: ClusterWaveforms__waveform_sd__Array
ClusterWaveforms__waveform_sd__Array:
name: ClusterWaveforms__waveform_sd__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
Clustering: Clustering:
name: Clustering name: Clustering
description: DEPRECATED Clustered spike data, whether from automatic clustering description: DEPRECATED Clustered spike data, whether from automatic clustering
@ -472,21 +379,30 @@ classes:
num: num:
name: num name: num
description: Cluster number of each event description: Cluster number of each event
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
peak_over_rms: peak_over_rms:
name: peak_over_rms name: peak_over_rms
description: Maximum ratio of waveform peak to RMS on any channel in the cluster description: Maximum ratio of waveform peak to RMS on any channel in the cluster
(provides a basic clustering metric). (provides a basic clustering metric).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_clusters
range: float32 range: float32
required: true required: true
times: times:
name: times name: times
description: Times of clustered events, in seconds. This may be a link to description: Times of clustered events, in seconds. This may be a link to
times field in associated FeatureExtraction module. times field in associated FeatureExtraction module.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.epoch name: core.nwb.epoch
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.epoch id: core.nwb.epoch
version: 2.2.2 version: 2.2.2
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.file name: core.nwb.file
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.file id: core.nwb.file
version: 2.2.2 version: 2.2.2
imports: imports:
@ -41,7 +48,10 @@ classes:
The file can be created after the experiment was run, so this may differ The file can be created after the experiment was run, so this may differ
from the experiment start time. Each modification to the nwb file adds a from the experiment start time. Each modification to the nwb file adds a
new entry to the array.' new entry to the array.'
multivalued: true multivalued: false
array:
dimensions:
- alias: num_modifications
range: isodatetime range: isodatetime
required: true required: true
identifier: identifier:
@ -183,9 +193,14 @@ classes:
having a particular scientific goal, trials (see trials subgroup) during having a particular scientific goal, trials (see trials subgroup) during
an experiment, or epochs (see epochs subgroup) deriving from analysis of an experiment, or epochs (see epochs subgroup) deriving from analysis of
data. data.
multivalued: false multivalued: true
range: NWBFile__intervals inlined: true
required: false inlined_as_list: false
any_of:
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
units: units:
name: units name: units
description: Data about sorted spike units. description: Data about sorted spike units.
@ -274,7 +289,10 @@ classes:
name: experimenter name: experimenter
description: Name of person(s) who performed the experiment. Can also specify description: Name of person(s) who performed the experiment. Can also specify
roles of different people involved. roles of different people involved.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_experimenters
range: text range: text
required: false required: false
institution: institution:
@ -286,7 +304,10 @@ classes:
keywords: keywords:
name: keywords name: keywords
description: Terms to search over. description: Terms to search over.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_keywords
range: text range: text
required: false required: false
lab: lab:
@ -318,7 +339,10 @@ classes:
related_publications: related_publications:
name: related_publications name: related_publications
description: Publication information. PMID, DOI, URL, etc. description: Publication information. PMID, DOI, URL, etc.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_publications
range: text range: text
required: false required: false
session_id: session_id:
@ -622,42 +646,3 @@ classes:
multivalued: false multivalued: false
range: SweepTable range: SweepTable
required: false required: false
NWBFile__intervals:
name: NWBFile__intervals
description: Experimental intervals, whether that be logically distinct sub-experiments
having a particular scientific goal, trials (see trials subgroup) during an
experiment, or epochs (see epochs subgroup) deriving from analysis of data.
attributes:
name:
name: name
ifabsent: string(intervals)
identifier: true
range: string
required: true
equals_string: intervals
epochs:
name: epochs
description: Divisions in time marking experimental stages or sub-divisions
of a single recording session.
multivalued: false
range: TimeIntervals
required: false
trials:
name: trials
description: Repeated experimental events that have a logical grouping.
multivalued: false
range: TimeIntervals
required: false
invalid_times:
name: invalid_times
description: Time intervals that should be removed from analysis.
multivalued: false
range: TimeIntervals
required: false
time_intervals:
name: time_intervals
description: Optional additional table(s) for describing other experimental
time intervals.
multivalued: true
range: TimeIntervals
required: false

View file

@ -1,4 +1,11 @@
name: core.nwb.icephys name: core.nwb.icephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.icephys id: core.nwb.icephys
version: 2.2.2 version: 2.2.2
imports: imports:
@ -30,8 +37,8 @@ classes:
data: data:
name: data name: data
description: Recorded voltage or current. description: Recorded voltage or current.
multivalued: true multivalued: false
range: numeric range: PatchClampSeries__data
required: true required: true
gain: gain:
name: gain name: gain
@ -41,6 +48,29 @@ classes:
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
PatchClampSeries__data:
name: PatchClampSeries__data
description: Recorded voltage or current.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. Actual stored
values are not necessarily stored in these units. To access the data in
these units, multiply 'data' by 'conversion'.
range: text
array:
name: array
array:
dimensions:
- alias: num_times
range: numeric
CurrentClampSeries: CurrentClampSeries:
name: CurrentClampSeries name: CurrentClampSeries
description: Voltage data from an intracellular current-clamp recording. A corresponding description: Voltage data from an intracellular current-clamp recording. A corresponding

View file

@ -1,4 +1,11 @@
name: core.nwb.image name: core.nwb.image
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.image id: core.nwb.image
version: 2.2.2 version: 2.2.2
imports: imports:
@ -16,22 +23,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: GrayscaleImage__Array
tree_root: true tree_root: true
GrayscaleImage__Array:
name: GrayscaleImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
RGBImage: RGBImage:
name: RGBImage name: RGBImage
description: A color image. description: A color image.
@ -42,28 +34,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBImage__Array
tree_root: true tree_root: true
RGBImage__Array:
name: RGBImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RGBAImage: RGBAImage:
name: RGBAImage name: RGBAImage
description: A color image with transparency. description: A color image with transparency.
@ -74,28 +45,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBAImage__Array
tree_root: true tree_root: true
RGBAImage__Array:
name: RGBAImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b, a:
name: r, g, b, a
range: numeric
required: true
minimum_cardinality: 4
maximum_cardinality: 4
ImageSeries: ImageSeries:
name: ImageSeries name: ImageSeries
description: General image data that is common between acquisition and stimulus description: General image data that is common between acquisition and stimulus
@ -115,12 +65,27 @@ classes:
name: data name: data
description: Binary data representing images across frames. description: Binary data representing images across frames.
multivalued: false multivalued: false
range: ImageSeries__data range: numeric
required: false required: false
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: z
dimension: dimension:
name: dimension name: dimension
description: Number of pixels on x, y, (and z) axes. description: Number of pixels on x, y, (and z) axes.
multivalued: true multivalued: false
array:
dimensions:
- alias: rank
range: int32 range: int32
required: false required: false
external_file: external_file:
@ -130,8 +95,8 @@ classes:
in the file system as one or more image file(s). This field should NOT be in the file system as one or more image file(s). This field should NOT be
used if the image is stored in another NWB file and that file is linked used if the image is stored in another NWB file and that file is linked
to this file. to this file.
multivalued: true multivalued: false
range: text range: ImageSeries__external_file
required: false required: false
format: format:
name: format name: format
@ -143,40 +108,41 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
ImageSeries__data: ImageSeries__external_file:
name: ImageSeries__data name: ImageSeries__external_file
description: Binary data representing images across frames. description: Paths to one or more external file(s). The field is only present
if format='external'. This is only relevant if the image series is stored in
the file system as one or more image file(s). This field should NOT be used
if the image is stored in another NWB file and that file is linked to this file.
attributes: attributes:
name: name:
name: name name: name
ifabsent: string(data) ifabsent: string(external_file)
identifier: true identifier: true
range: string range: string
required: true required: true
equals_string: data equals_string: external_file
starting_frame:
name: starting_frame
description: Each external image may contain one or more consecutive frames
of the full ImageSeries. This attribute serves as an index to indicate which
frames each file contains, to faciliate random access. The 'starting_frame'
attribute, hence, contains a list of frame numbers within the full ImageSeries
of the first frame of each file listed in the parent 'external_file' dataset.
Zero-based indexing is used (hence, the first element will always be zero).
For example, if the 'external_file' dataset has three paths to files and
the first file has 5 frames, the second file has 10 frames, and the third
file has 20 frames, then this attribute will have values [0, 5, 15]. If
there is a single external file that holds all of the frames of the ImageSeries
(and so there is a single element in the 'external_file' dataset), then
this attribute should have value [0].
range: int32
array: array:
name: array name: array
range: ImageSeries__data__Array array:
ImageSeries__data__Array: dimensions:
name: ImageSeries__data__Array - alias: num_files
is_a: Arraylike range: text
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
z:
name: z
range: numeric
required: false
ImageMaskSeries: ImageMaskSeries:
name: ImageMaskSeries name: ImageMaskSeries
description: An alpha mask that is applied to a presented visual stimulus. The description: An alpha mask that is applied to a presented visual stimulus. The
@ -216,14 +182,36 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: OpticalSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width, height
exact_cardinality: 2
- array:
dimensions:
- alias: width, height, depth
exact_cardinality: 3
data: data:
name: data name: data
description: Images presented to subject, either grayscale or RGB description: Images presented to subject, either grayscale or RGB
multivalued: false multivalued: false
range: OpticalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
orientation: orientation:
name: orientation name: orientation
description: Description of image relative to some reference frame (e.g., description: Description of image relative to some reference frame (e.g.,
@ -232,72 +220,6 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
OpticalSeries__field_of_view:
name: OpticalSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: OpticalSeries__field_of_view__Array
OpticalSeries__field_of_view__Array:
name: OpticalSeries__field_of_view__Array
is_a: Arraylike
attributes:
width, height:
name: width, height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width, height, depth:
name: width, height, depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
OpticalSeries__data:
name: OpticalSeries__data
description: Images presented to subject, either grayscale or RGB
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: OpticalSeries__data__Array
OpticalSeries__data__Array:
name: OpticalSeries__data__Array
is_a: Arraylike
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
IndexSeries: IndexSeries:
name: IndexSeries name: IndexSeries
description: Stores indices to image frames stored in an ImageSeries. The purpose description: Stores indices to image frames stored in an ImageSeries. The purpose
@ -316,7 +238,10 @@ classes:
data: data:
name: data name: data
description: Index of the frame in the referenced ImageSeries. description: Index of the frame in the referenced ImageSeries.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int32 range: int32
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.language name: core.nwb.language
annotations:
is_namespace:
tag: is_namespace
value: 'False'
namespace:
tag: namespace
value: core
description: Adapter objects to mimic the behavior of elements in the nwb-schema-language description: Adapter objects to mimic the behavior of elements in the nwb-schema-language
id: nwb.language id: nwb.language
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.misc name: core.nwb.misc
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.misc id: core.nwb.misc
version: 2.2.2 version: 2.2.2
imports: imports:
@ -35,13 +42,19 @@ classes:
feature_units: feature_units:
name: feature_units name: feature_units
description: Units of each feature. description: Units of each feature.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: false required: false
features: features:
name: features name: features
description: Description of the features represented in TimeSeries::data. description: Description of the features represented in TimeSeries::data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -64,19 +77,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AbstractFeatureSeries__data__Array
AbstractFeatureSeries__data__Array:
name: AbstractFeatureSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
AnnotationSeries: AnnotationSeries:
name: AnnotationSeries name: AnnotationSeries
description: Stores user annotations made during an experiment. The data[] field description: Stores user annotations made during an experiment. The data[] field
@ -93,7 +102,10 @@ classes:
data: data:
name: data name: data
description: Annotations made during an experiment. description: Annotations made during an experiment.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -116,7 +128,10 @@ classes:
data: data:
name: data name: data
description: Use values >0 if interval started, <0 if interval ended. description: Use values >0 if interval started, <0 if interval ended.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int8 range: int8
required: true required: true
tree_root: true tree_root: true
@ -169,23 +184,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: DecompositionSeries__data__Array array:
DecompositionSeries__data__Array: dimensions:
name: DecompositionSeries__data__Array - alias: num_times
is_a: Arraylike - alias: num_channels
attributes: - alias: num_bands
num_times:
name: num_times
range: numeric range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: true
num_bands:
name: num_bands
range: numeric
required: true
DecompositionSeries__bands: DecompositionSeries__bands:
name: DecompositionSeries__bands name: DecompositionSeries__bands
description: Table for describing the bands that this series was generated from. description: Table for describing the bands that this series was generated from.
@ -209,33 +213,31 @@ classes:
description: Low and high limit of each band in Hz. If it is a Gaussian filter, description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center. use 2 SD on either side of the center.
multivalued: false multivalued: false
range: DecompositionSeries__bands__band_limits array:
dimensions:
- alias: num_bands
- alias: low, high
exact_cardinality: 2
range: float32
required: true required: true
band_mean: band_mean:
name: band_mean name: band_mean
description: The mean Gaussian filters, in Hz. description: The mean Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
band_stdev: band_stdev:
name: band_stdev name: band_stdev
description: The standard deviation of Gaussian filters, in Hz. description: The standard deviation of Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
DecompositionSeries__bands__band_limits:
name: DecompositionSeries__bands__band_limits
description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(band_limits)
identifier: true
range: string
required: true
equals_string: band_limits
Units: Units:
name: Units name: Units
description: Data about spiking units. Event times of observed units (e.g. cell, description: Data about spiking units. Event times of observed units (e.g. cell,
@ -269,7 +271,12 @@ classes:
name: obs_intervals name: obs_intervals
description: Observation intervals for each unit. description: Observation intervals for each unit.
multivalued: false multivalued: false
range: Units__obs_intervals array:
dimensions:
- alias: num_intervals
- alias: start|end
exact_cardinality: 2
range: float64
required: false required: false
electrodes_index: electrodes_index:
name: electrodes_index name: electrodes_index
@ -292,14 +299,34 @@ classes:
name: waveform_mean name: waveform_mean
description: Spike waveform mean for each spike unit. description: Spike waveform mean for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_mean range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Spike waveform standard deviation for each spike unit. description: Spike waveform standard deviation for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_sd range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
tree_root: true tree_root: true
Units__spike_times_index: Units__spike_times_index:
name: Units__spike_times_index name: Units__spike_times_index
@ -345,18 +372,6 @@ classes:
range: string range: string
required: true required: true
equals_string: obs_intervals_index equals_string: obs_intervals_index
Units__obs_intervals:
name: Units__obs_intervals
description: Observation intervals for each unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(obs_intervals)
identifier: true
range: string
required: true
equals_string: obs_intervals
Units__electrodes_index: Units__electrodes_index:
name: Units__electrodes_index name: Units__electrodes_index
description: Index into electrodes. description: Index into electrodes.
@ -381,43 +396,3 @@ classes:
range: string range: string
required: true required: true
equals_string: electrodes equals_string: electrodes
Units__waveform_mean:
name: Units__waveform_mean
description: Spike waveform mean for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveform_sd:
name: Units__waveform_sd
description: Spike waveform standard deviation for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text

View file

@ -1,4 +1,11 @@
name: core.nwb.ogen name: core.nwb.ogen
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ogen id: core.nwb.ogen
version: 2.2.2 version: 2.2.2
imports: imports:
@ -20,7 +27,10 @@ classes:
data: data:
name: data name: data
description: Applied power for optogenetic stimulus, in watts. description: Applied power for optogenetic stimulus, in watts.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: numeric range: numeric
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.ophys name: core.nwb.ophys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ophys id: core.nwb.ophys
version: 2.2.2 version: 2.2.2
imports: imports:
@ -33,39 +40,18 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: TwoPhotonSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width|height
exact_cardinality: 2
- array:
dimensions:
- alias: width|height
exact_cardinality: 3
tree_root: true tree_root: true
TwoPhotonSeries__field_of_view:
name: TwoPhotonSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: TwoPhotonSeries__field_of_view__Array
TwoPhotonSeries__field_of_view__Array:
name: TwoPhotonSeries__field_of_view__Array
is_a: Arraylike
attributes:
width|height:
name: width|height
range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
width|height|depth:
name: width|height|depth
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RoiResponseSeries: RoiResponseSeries:
name: RoiResponseSeries name: RoiResponseSeries
description: ROI responses over an imaging plane. The first dimension represents description: ROI responses over an imaging plane. The first dimension represents
@ -81,8 +67,16 @@ classes:
name: data name: data
description: Signals from ROIs. description: Signals from ROIs.
multivalued: false multivalued: false
range: RoiResponseSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_ROIs
rois: rois:
name: rois name: rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -91,32 +85,6 @@ classes:
range: RoiResponseSeries__rois range: RoiResponseSeries__rois
required: true required: true
tree_root: true tree_root: true
RoiResponseSeries__data:
name: RoiResponseSeries__data
description: Signals from ROIs.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: RoiResponseSeries__data__Array
RoiResponseSeries__data__Array:
name: RoiResponseSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_ROIs:
name: num_ROIs
range: numeric
required: false
RoiResponseSeries__rois: RoiResponseSeries__rois:
name: RoiResponseSeries__rois name: RoiResponseSeries__rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -137,12 +105,13 @@ classes:
for image planes). for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
Fluorescence: Fluorescence:
name: Fluorescence name: Fluorescence
@ -151,12 +120,13 @@ classes:
for ROIs and for image planes). for ROIs and for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
ImageSegmentation: ImageSegmentation:
name: ImageSegmentation name: ImageSegmentation
@ -169,24 +139,26 @@ classes:
is required and ROI names should remain consistent between them. is required and ROI names should remain consistent between them.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: DynamicTable any_of:
- range: DynamicTable
tree_root: true tree_root: true
ImagingPlane: ImagingPlane:
name: ImagingPlane name: ImagingPlane
description: An imaging plane and its metadata. description: An imaging plane and its metadata.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBContainer any_of:
- range: NWBContainer
tree_root: true tree_root: true
MotionCorrection: MotionCorrection:
name: MotionCorrection name: MotionCorrection
@ -195,10 +167,11 @@ classes:
frame at each point in time is assumed to be 2-D (has only x & y dimensions).' frame at each point in time is assumed to be 2-D (has only x & y dimensions).'
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: NWBDataInterface
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.retinotopy name: core.nwb.retinotopy
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.retinotopy id: core.nwb.retinotopy
version: 2.2.2 version: 2.2.2
imports: imports:
@ -55,7 +62,11 @@ classes:
description: Two-element array describing the contents of the two response description: Two-element array describing the contents of the two response
axis fields. Description should be something like ['altitude', 'azimuth'] axis fields. Description should be something like ['altitude', 'azimuth']
or '['radius', 'theta']. or '['radius', 'theta'].
multivalued: true multivalued: false
array:
dimensions:
- alias: axis_1, axis_2
exact_cardinality: 2
range: text range: text
required: true required: true
focal_depth_image: focal_depth_image:
@ -106,19 +117,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_phase_map__Array array:
ImagingRetinotopy__axis_1_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_1_power_map: ImagingRetinotopy__axis_1_power_map:
name: ImagingRetinotopy__axis_1_power_map name: ImagingRetinotopy__axis_1_power_map
description: Power response on the first measured axis. Response is scaled so description: Power response on the first measured axis. Response is scaled so
@ -146,19 +149,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_power_map__Array array:
ImagingRetinotopy__axis_1_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_phase_map: ImagingRetinotopy__axis_2_phase_map:
name: ImagingRetinotopy__axis_2_phase_map name: ImagingRetinotopy__axis_2_phase_map
description: Phase response to stimulus on the second measured axis. description: Phase response to stimulus on the second measured axis.
@ -185,19 +180,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_phase_map__Array array:
ImagingRetinotopy__axis_2_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_power_map: ImagingRetinotopy__axis_2_power_map:
name: ImagingRetinotopy__axis_2_power_map name: ImagingRetinotopy__axis_2_power_map
description: Power response on the second measured axis. Response is scaled so description: Power response on the second measured axis. Response is scaled so
@ -225,19 +212,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_power_map__Array array:
ImagingRetinotopy__axis_2_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__focal_depth_image: ImagingRetinotopy__focal_depth_image:
name: ImagingRetinotopy__focal_depth_image name: ImagingRetinotopy__focal_depth_image
description: 'Gray-scale image taken with same settings/parameters (e.g., focal description: 'Gray-scale image taken with same settings/parameters (e.g., focal
@ -274,19 +253,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__focal_depth_image__Array array:
ImagingRetinotopy__focal_depth_image__Array: dimensions:
name: ImagingRetinotopy__focal_depth_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true
ImagingRetinotopy__sign_map: ImagingRetinotopy__sign_map:
name: ImagingRetinotopy__sign_map name: ImagingRetinotopy__sign_map
description: Sine of the angle between the direction of the gradient in axis_1 description: Sine of the angle between the direction of the gradient in axis_1
@ -310,19 +281,11 @@ classes:
range: float32 range: float32
array: array:
name: array name: array
range: ImagingRetinotopy__sign_map__Array array:
ImagingRetinotopy__sign_map__Array: dimensions:
name: ImagingRetinotopy__sign_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__vasculature_image: ImagingRetinotopy__vasculature_image:
name: ImagingRetinotopy__vasculature_image name: ImagingRetinotopy__vasculature_image
description: 'Gray-scale anatomical image of cortical surface. Array structure: description: 'Gray-scale anatomical image of cortical surface. Array structure:
@ -355,16 +318,8 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__vasculature_image__Array array:
ImagingRetinotopy__vasculature_image__Array: dimensions:
name: ImagingRetinotopy__vasculature_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true

View file

@ -1,8 +1,11 @@
name: core name: core
annotations: annotations:
is_namespace:
tag: is_namespace
value: true
namespace: namespace:
tag: namespace tag: namespace
value: 'True' value: core
description: NWB namespace description: NWB namespace
id: core id: core
version: 2.2.2 version: 2.2.2

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.2.4 version: 2.2.4
imports: imports:
@ -39,32 +46,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -130,7 +130,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -138,7 +141,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -146,7 +152,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -201,27 +210,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -268,13 +276,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.2.4 version: 2.2.4
imports: imports:
@ -59,19 +66,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -88,12 +91,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -101,12 +105,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -114,36 +119,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -154,22 +162,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.device name: core.nwb.device
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.device id: core.nwb.device
version: 2.2.4 version: 2.2.4
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.ecephys name: core.nwb.ecephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ecephys id: core.nwb.ecephys
version: 2.2.4 version: 2.2.4
imports: imports:
@ -25,8 +32,21 @@ classes:
name: data name: data
description: Recorded voltage data. description: Recorded voltage data.
multivalued: false multivalued: false
range: ElectricalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_channels
- array:
dimensions:
- alias: num_times
- alias: num_channels
- alias: num_samples
electrodes: electrodes:
name: electrodes name: electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -45,47 +65,13 @@ classes:
as native values generated by data acquisition systems. If this dataset as native values generated by data acquisition systems. If this dataset
is not present, then there is no channel-specific conversion factor, i.e. is not present, then there is no channel-specific conversion factor, i.e.
it is 1 for all channels. it is 1 for all channels.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_channels
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
ElectricalSeries__data:
name: ElectricalSeries__data
description: Recorded voltage data.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. This value
is fixed to 'volts'. Actual stored values are not necessarily stored in
these units. To access the data in these units, multiply 'data' by 'conversion'
and 'channel_conversion' (if present).
range: text
array:
name: array
range: ElectricalSeries__data__Array
ElectricalSeries__data__Array:
name: ElectricalSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
num_samples:
name: num_samples
range: numeric
required: false
ElectricalSeries__electrodes: ElectricalSeries__electrodes:
name: ElectricalSeries__electrodes name: ElectricalSeries__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -120,52 +106,31 @@ classes:
name: data name: data
description: Spike waveforms. description: Spike waveforms.
multivalued: false multivalued: false
range: SpikeEventSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_events
- alias: num_samples
- array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_samples
timestamps: timestamps:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
Timestamps are required for the events. Unlike for TimeSeries, timestamps Timestamps are required for the events. Unlike for TimeSeries, timestamps
are required for SpikeEventSeries and are thus re-specified here. are required for SpikeEventSeries and are thus re-specified here.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
SpikeEventSeries__data:
name: SpikeEventSeries__data
description: Spike waveforms.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Unit of measurement for waveforms, which is fixed to 'volts'.
range: text
array:
name: array
range: SpikeEventSeries__data__Array
SpikeEventSeries__data__Array:
name: SpikeEventSeries__data__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: numeric
required: true
num_samples:
name: num_samples
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
FeatureExtraction: FeatureExtraction:
name: FeatureExtraction name: FeatureExtraction
description: Features, such as PC1 and PC2, that are extracted from signals stored description: Features, such as PC1 and PC2, that are extracted from signals stored
@ -181,19 +146,30 @@ classes:
name: description name: description
description: Description of features (eg, ''PC1'') for each of the extracted description: Description of features (eg, ''PC1'') for each of the extracted
features. features.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
features: features:
name: features name: features
description: Multi-dimensional array of features extracted from each event. description: Multi-dimensional array of features extracted from each event.
multivalued: false multivalued: false
range: FeatureExtraction__features array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_features
range: float32
required: true required: true
times: times:
name: times name: times
description: Times of events that features correspond to (can be a link). description: Times of events that features correspond to (can be a link).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
electrodes: electrodes:
@ -204,36 +180,6 @@ classes:
range: FeatureExtraction__electrodes range: FeatureExtraction__electrodes
required: true required: true
tree_root: true tree_root: true
FeatureExtraction__features:
name: FeatureExtraction__features
description: Multi-dimensional array of features extracted from each event.
attributes:
name:
name: name
ifabsent: string(features)
identifier: true
range: string
required: true
equals_string: features
array:
name: array
range: FeatureExtraction__features__Array
FeatureExtraction__features__Array:
name: FeatureExtraction__features__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: float32
required: true
num_channels:
name: num_channels
range: float32
required: true
num_features:
name: num_features
range: float32
required: true
FeatureExtraction__electrodes: FeatureExtraction__electrodes:
name: FeatureExtraction__electrodes name: FeatureExtraction__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -270,13 +216,19 @@ classes:
corresponding to time of event. ''description'' should define what is meant corresponding to time of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing by time of event (e.g., .25 ms before action potential peak, zero-crossing
time, etc). The index points to each event from the raw data. time, etc). The index points to each event from the raw data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
times: times:
name: times name: times
description: Timestamps of events, in seconds. description: Timestamps of events, in seconds.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
@ -287,12 +239,13 @@ classes:
during experiment acquisition. during experiment acquisition.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpikeEventSeries any_of:
- range: SpikeEventSeries
tree_root: true tree_root: true
FilteredEphys: FilteredEphys:
name: FilteredEphys name: FilteredEphys
@ -309,12 +262,13 @@ classes:
the ElectricalSeries. the ElectricalSeries.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
LFP: LFP:
name: LFP name: LFP
@ -323,12 +277,13 @@ classes:
properties should be noted in the ElectricalSeries description or comments field. properties should be noted in the ElectricalSeries description or comments field.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
ElectrodeGroup: ElectrodeGroup:
name: ElectrodeGroup name: ElectrodeGroup
@ -385,72 +340,24 @@ classes:
3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence
should be empty (e.g., zero- filled) should be empty (e.g., zero- filled)
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_mean array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as description: Stdev of waveforms for each cluster, using the same indices as
in mean in mean
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_sd array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
tree_root: true tree_root: true
ClusterWaveforms__waveform_mean:
name: ClusterWaveforms__waveform_mean
description: The mean waveform for each cluster, using the same indices for each
wave as cluster numbers in the associated Clustering module (i.e, cluster 3
is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should
be empty (e.g., zero- filled)
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
array:
name: array
range: ClusterWaveforms__waveform_mean__Array
ClusterWaveforms__waveform_mean__Array:
name: ClusterWaveforms__waveform_mean__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
ClusterWaveforms__waveform_sd:
name: ClusterWaveforms__waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as in
mean
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
array:
name: array
range: ClusterWaveforms__waveform_sd__Array
ClusterWaveforms__waveform_sd__Array:
name: ClusterWaveforms__waveform_sd__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
Clustering: Clustering:
name: Clustering name: Clustering
description: DEPRECATED Clustered spike data, whether from automatic clustering description: DEPRECATED Clustered spike data, whether from automatic clustering
@ -472,21 +379,30 @@ classes:
num: num:
name: num name: num
description: Cluster number of each event description: Cluster number of each event
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
peak_over_rms: peak_over_rms:
name: peak_over_rms name: peak_over_rms
description: Maximum ratio of waveform peak to RMS on any channel in the cluster description: Maximum ratio of waveform peak to RMS on any channel in the cluster
(provides a basic clustering metric). (provides a basic clustering metric).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_clusters
range: float32 range: float32
required: true required: true
times: times:
name: times name: times
description: Times of clustered events, in seconds. This may be a link to description: Times of clustered events, in seconds. This may be a link to
times field in associated FeatureExtraction module. times field in associated FeatureExtraction module.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.epoch name: core.nwb.epoch
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.epoch id: core.nwb.epoch
version: 2.2.4 version: 2.2.4
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.file name: core.nwb.file
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.file id: core.nwb.file
version: 2.2.4 version: 2.2.4
imports: imports:
@ -56,7 +63,10 @@ classes:
The file can be created after the experiment was run, so this may differ The file can be created after the experiment was run, so this may differ
from the experiment start time. Each modification to the nwb file adds a from the experiment start time. Each modification to the nwb file adds a
new entry to the array.' new entry to the array.'
multivalued: true multivalued: false
array:
dimensions:
- alias: num_modifications
range: isodatetime range: isodatetime
required: true required: true
identifier: identifier:
@ -198,9 +208,14 @@ classes:
having a particular scientific goal, trials (see trials subgroup) during having a particular scientific goal, trials (see trials subgroup) during
an experiment, or epochs (see epochs subgroup) deriving from analysis of an experiment, or epochs (see epochs subgroup) deriving from analysis of
data. data.
multivalued: false multivalued: true
range: NWBFile__intervals inlined: true
required: false inlined_as_list: false
any_of:
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
units: units:
name: units name: units
description: Data about sorted spike units. description: Data about sorted spike units.
@ -289,7 +304,10 @@ classes:
name: experimenter name: experimenter
description: Name of person(s) who performed the experiment. Can also specify description: Name of person(s) who performed the experiment. Can also specify
roles of different people involved. roles of different people involved.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_experimenters
range: text range: text
required: false required: false
institution: institution:
@ -301,7 +319,10 @@ classes:
keywords: keywords:
name: keywords name: keywords
description: Terms to search over. description: Terms to search over.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_keywords
range: text range: text
required: false required: false
lab: lab:
@ -333,7 +354,10 @@ classes:
related_publications: related_publications:
name: related_publications name: related_publications
description: Publication information. PMID, DOI, URL, etc. description: Publication information. PMID, DOI, URL, etc.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_publications
range: text range: text
required: false required: false
session_id: session_id:
@ -575,45 +599,6 @@ classes:
multivalued: false multivalued: false
range: SweepTable range: SweepTable
required: false required: false
NWBFile__intervals:
name: NWBFile__intervals
description: Experimental intervals, whether that be logically distinct sub-experiments
having a particular scientific goal, trials (see trials subgroup) during an
experiment, or epochs (see epochs subgroup) deriving from analysis of data.
attributes:
name:
name: name
ifabsent: string(intervals)
identifier: true
range: string
required: true
equals_string: intervals
epochs:
name: epochs
description: Divisions in time marking experimental stages or sub-divisions
of a single recording session.
multivalued: false
range: TimeIntervals
required: false
trials:
name: trials
description: Repeated experimental events that have a logical grouping.
multivalued: false
range: TimeIntervals
required: false
invalid_times:
name: invalid_times
description: Time intervals that should be removed from analysis.
multivalued: false
range: TimeIntervals
required: false
time_intervals:
name: time_intervals
description: Optional additional table(s) for describing other experimental
time intervals.
multivalued: true
range: TimeIntervals
required: false
LabMetaData: LabMetaData:
name: LabMetaData name: LabMetaData
description: Lab-specific meta-data. description: Lab-specific meta-data.

View file

@ -1,4 +1,11 @@
name: core.nwb.icephys name: core.nwb.icephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.icephys id: core.nwb.icephys
version: 2.2.4 version: 2.2.4
imports: imports:
@ -30,8 +37,8 @@ classes:
data: data:
name: data name: data
description: Recorded voltage or current. description: Recorded voltage or current.
multivalued: true multivalued: false
range: numeric range: PatchClampSeries__data
required: true required: true
gain: gain:
name: gain name: gain
@ -41,6 +48,29 @@ classes:
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
PatchClampSeries__data:
name: PatchClampSeries__data
description: Recorded voltage or current.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. Actual stored
values are not necessarily stored in these units. To access the data in
these units, multiply 'data' by 'conversion'.
range: text
array:
name: array
array:
dimensions:
- alias: num_times
range: numeric
CurrentClampSeries: CurrentClampSeries:
name: CurrentClampSeries name: CurrentClampSeries
description: Voltage data from an intracellular current-clamp recording. A corresponding description: Voltage data from an intracellular current-clamp recording. A corresponding

View file

@ -1,4 +1,11 @@
name: core.nwb.image name: core.nwb.image
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.image id: core.nwb.image
version: 2.2.4 version: 2.2.4
imports: imports:
@ -16,22 +23,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: GrayscaleImage__Array
tree_root: true tree_root: true
GrayscaleImage__Array:
name: GrayscaleImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
RGBImage: RGBImage:
name: RGBImage name: RGBImage
description: A color image. description: A color image.
@ -42,28 +34,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBImage__Array
tree_root: true tree_root: true
RGBImage__Array:
name: RGBImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RGBAImage: RGBAImage:
name: RGBAImage name: RGBAImage
description: A color image with transparency. description: A color image with transparency.
@ -74,28 +45,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBAImage__Array
tree_root: true tree_root: true
RGBAImage__Array:
name: RGBAImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b, a:
name: r, g, b, a
range: numeric
required: true
minimum_cardinality: 4
maximum_cardinality: 4
ImageSeries: ImageSeries:
name: ImageSeries name: ImageSeries
description: General image data that is common between acquisition and stimulus description: General image data that is common between acquisition and stimulus
@ -115,12 +65,27 @@ classes:
name: data name: data
description: Binary data representing images across frames. description: Binary data representing images across frames.
multivalued: false multivalued: false
range: ImageSeries__data range: numeric
required: false required: false
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: z
dimension: dimension:
name: dimension name: dimension
description: Number of pixels on x, y, (and z) axes. description: Number of pixels on x, y, (and z) axes.
multivalued: true multivalued: false
array:
dimensions:
- alias: rank
range: int32 range: int32
required: false required: false
external_file: external_file:
@ -130,8 +95,8 @@ classes:
in the file system as one or more image file(s). This field should NOT be in the file system as one or more image file(s). This field should NOT be
used if the image is stored in another NWB file and that file is linked used if the image is stored in another NWB file and that file is linked
to this file. to this file.
multivalued: true multivalued: false
range: text range: ImageSeries__external_file
required: false required: false
format: format:
name: format name: format
@ -143,40 +108,41 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
ImageSeries__data: ImageSeries__external_file:
name: ImageSeries__data name: ImageSeries__external_file
description: Binary data representing images across frames. description: Paths to one or more external file(s). The field is only present
if format='external'. This is only relevant if the image series is stored in
the file system as one or more image file(s). This field should NOT be used
if the image is stored in another NWB file and that file is linked to this file.
attributes: attributes:
name: name:
name: name name: name
ifabsent: string(data) ifabsent: string(external_file)
identifier: true identifier: true
range: string range: string
required: true required: true
equals_string: data equals_string: external_file
starting_frame:
name: starting_frame
description: Each external image may contain one or more consecutive frames
of the full ImageSeries. This attribute serves as an index to indicate which
frames each file contains, to faciliate random access. The 'starting_frame'
attribute, hence, contains a list of frame numbers within the full ImageSeries
of the first frame of each file listed in the parent 'external_file' dataset.
Zero-based indexing is used (hence, the first element will always be zero).
For example, if the 'external_file' dataset has three paths to files and
the first file has 5 frames, the second file has 10 frames, and the third
file has 20 frames, then this attribute will have values [0, 5, 15]. If
there is a single external file that holds all of the frames of the ImageSeries
(and so there is a single element in the 'external_file' dataset), then
this attribute should have value [0].
range: int32
array: array:
name: array name: array
range: ImageSeries__data__Array array:
ImageSeries__data__Array: dimensions:
name: ImageSeries__data__Array - alias: num_files
is_a: Arraylike range: text
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
z:
name: z
range: numeric
required: false
ImageMaskSeries: ImageMaskSeries:
name: ImageMaskSeries name: ImageMaskSeries
description: An alpha mask that is applied to a presented visual stimulus. The description: An alpha mask that is applied to a presented visual stimulus. The
@ -216,14 +182,36 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: OpticalSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width, height
exact_cardinality: 2
- array:
dimensions:
- alias: width, height, depth
exact_cardinality: 3
data: data:
name: data name: data
description: Images presented to subject, either grayscale or RGB description: Images presented to subject, either grayscale or RGB
multivalued: false multivalued: false
range: OpticalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
orientation: orientation:
name: orientation name: orientation
description: Description of image relative to some reference frame (e.g., description: Description of image relative to some reference frame (e.g.,
@ -232,72 +220,6 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
OpticalSeries__field_of_view:
name: OpticalSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: OpticalSeries__field_of_view__Array
OpticalSeries__field_of_view__Array:
name: OpticalSeries__field_of_view__Array
is_a: Arraylike
attributes:
width, height:
name: width, height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width, height, depth:
name: width, height, depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
OpticalSeries__data:
name: OpticalSeries__data
description: Images presented to subject, either grayscale or RGB
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: OpticalSeries__data__Array
OpticalSeries__data__Array:
name: OpticalSeries__data__Array
is_a: Arraylike
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
IndexSeries: IndexSeries:
name: IndexSeries name: IndexSeries
description: Stores indices to image frames stored in an ImageSeries. The purpose description: Stores indices to image frames stored in an ImageSeries. The purpose
@ -316,7 +238,10 @@ classes:
data: data:
name: data name: data
description: Index of the frame in the referenced ImageSeries. description: Index of the frame in the referenced ImageSeries.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int32 range: int32
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.language name: core.nwb.language
annotations:
is_namespace:
tag: is_namespace
value: 'False'
namespace:
tag: namespace
value: core
description: Adapter objects to mimic the behavior of elements in the nwb-schema-language description: Adapter objects to mimic the behavior of elements in the nwb-schema-language
id: nwb.language id: nwb.language
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.misc name: core.nwb.misc
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.misc id: core.nwb.misc
version: 2.2.4 version: 2.2.4
imports: imports:
@ -35,13 +42,19 @@ classes:
feature_units: feature_units:
name: feature_units name: feature_units
description: Units of each feature. description: Units of each feature.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: false required: false
features: features:
name: features name: features
description: Description of the features represented in TimeSeries::data. description: Description of the features represented in TimeSeries::data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -64,19 +77,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AbstractFeatureSeries__data__Array
AbstractFeatureSeries__data__Array:
name: AbstractFeatureSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
AnnotationSeries: AnnotationSeries:
name: AnnotationSeries name: AnnotationSeries
description: Stores user annotations made during an experiment. The data[] field description: Stores user annotations made during an experiment. The data[] field
@ -93,7 +102,10 @@ classes:
data: data:
name: data name: data
description: Annotations made during an experiment. description: Annotations made during an experiment.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -116,7 +128,10 @@ classes:
data: data:
name: data name: data
description: Use values >0 if interval started, <0 if interval ended. description: Use values >0 if interval started, <0 if interval ended.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int8 range: int8
required: true required: true
tree_root: true tree_root: true
@ -169,23 +184,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: DecompositionSeries__data__Array array:
DecompositionSeries__data__Array: dimensions:
name: DecompositionSeries__data__Array - alias: num_times
is_a: Arraylike - alias: num_channels
attributes: - alias: num_bands
num_times:
name: num_times
range: numeric range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: true
num_bands:
name: num_bands
range: numeric
required: true
DecompositionSeries__bands: DecompositionSeries__bands:
name: DecompositionSeries__bands name: DecompositionSeries__bands
description: Table for describing the bands that this series was generated from. description: Table for describing the bands that this series was generated from.
@ -209,33 +213,31 @@ classes:
description: Low and high limit of each band in Hz. If it is a Gaussian filter, description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center. use 2 SD on either side of the center.
multivalued: false multivalued: false
range: DecompositionSeries__bands__band_limits array:
dimensions:
- alias: num_bands
- alias: low, high
exact_cardinality: 2
range: float32
required: true required: true
band_mean: band_mean:
name: band_mean name: band_mean
description: The mean Gaussian filters, in Hz. description: The mean Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
band_stdev: band_stdev:
name: band_stdev name: band_stdev
description: The standard deviation of Gaussian filters, in Hz. description: The standard deviation of Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
DecompositionSeries__bands__band_limits:
name: DecompositionSeries__bands__band_limits
description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(band_limits)
identifier: true
range: string
required: true
equals_string: band_limits
Units: Units:
name: Units name: Units
description: Data about spiking units. Event times of observed units (e.g. cell, description: Data about spiking units. Event times of observed units (e.g. cell,
@ -269,7 +271,12 @@ classes:
name: obs_intervals name: obs_intervals
description: Observation intervals for each unit. description: Observation intervals for each unit.
multivalued: false multivalued: false
range: Units__obs_intervals array:
dimensions:
- alias: num_intervals
- alias: start|end
exact_cardinality: 2
range: float64
required: false required: false
electrodes_index: electrodes_index:
name: electrodes_index name: electrodes_index
@ -292,14 +299,34 @@ classes:
name: waveform_mean name: waveform_mean
description: Spike waveform mean for each spike unit. description: Spike waveform mean for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_mean range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Spike waveform standard deviation for each spike unit. description: Spike waveform standard deviation for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_sd range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
tree_root: true tree_root: true
Units__spike_times_index: Units__spike_times_index:
name: Units__spike_times_index name: Units__spike_times_index
@ -345,18 +372,6 @@ classes:
range: string range: string
required: true required: true
equals_string: obs_intervals_index equals_string: obs_intervals_index
Units__obs_intervals:
name: Units__obs_intervals
description: Observation intervals for each unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(obs_intervals)
identifier: true
range: string
required: true
equals_string: obs_intervals
Units__electrodes_index: Units__electrodes_index:
name: Units__electrodes_index name: Units__electrodes_index
description: Index into electrodes. description: Index into electrodes.
@ -381,43 +396,3 @@ classes:
range: string range: string
required: true required: true
equals_string: electrodes equals_string: electrodes
Units__waveform_mean:
name: Units__waveform_mean
description: Spike waveform mean for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveform_sd:
name: Units__waveform_sd
description: Spike waveform standard deviation for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text

View file

@ -1,4 +1,11 @@
name: core.nwb.ogen name: core.nwb.ogen
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ogen id: core.nwb.ogen
version: 2.2.4 version: 2.2.4
imports: imports:
@ -20,7 +27,10 @@ classes:
data: data:
name: data name: data
description: Applied power for optogenetic stimulus, in watts. description: Applied power for optogenetic stimulus, in watts.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: numeric range: numeric
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.ophys name: core.nwb.ophys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ophys id: core.nwb.ophys
version: 2.2.4 version: 2.2.4
imports: imports:
@ -33,39 +40,18 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: TwoPhotonSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width|height
exact_cardinality: 2
- array:
dimensions:
- alias: width|height
exact_cardinality: 3
tree_root: true tree_root: true
TwoPhotonSeries__field_of_view:
name: TwoPhotonSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: TwoPhotonSeries__field_of_view__Array
TwoPhotonSeries__field_of_view__Array:
name: TwoPhotonSeries__field_of_view__Array
is_a: Arraylike
attributes:
width|height:
name: width|height
range: float32
required: true
minimum_cardinality: 2
maximum_cardinality: 2
width|height|depth:
name: width|height|depth
range: float32
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RoiResponseSeries: RoiResponseSeries:
name: RoiResponseSeries name: RoiResponseSeries
description: ROI responses over an imaging plane. The first dimension represents description: ROI responses over an imaging plane. The first dimension represents
@ -81,8 +67,16 @@ classes:
name: data name: data
description: Signals from ROIs. description: Signals from ROIs.
multivalued: false multivalued: false
range: RoiResponseSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_ROIs
rois: rois:
name: rois name: rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -91,32 +85,6 @@ classes:
range: RoiResponseSeries__rois range: RoiResponseSeries__rois
required: true required: true
tree_root: true tree_root: true
RoiResponseSeries__data:
name: RoiResponseSeries__data
description: Signals from ROIs.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: RoiResponseSeries__data__Array
RoiResponseSeries__data__Array:
name: RoiResponseSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_ROIs:
name: num_ROIs
range: numeric
required: false
RoiResponseSeries__rois: RoiResponseSeries__rois:
name: RoiResponseSeries__rois name: RoiResponseSeries__rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -137,12 +105,13 @@ classes:
for image planes). for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
Fluorescence: Fluorescence:
name: Fluorescence name: Fluorescence
@ -151,12 +120,13 @@ classes:
for ROIs and for image planes). for ROIs and for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
ImageSegmentation: ImageSegmentation:
name: ImageSegmentation name: ImageSegmentation
@ -169,12 +139,13 @@ classes:
is required and ROI names should remain consistent between them. is required and ROI names should remain consistent between them.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: PlaneSegmentation any_of:
- range: PlaneSegmentation
tree_root: true tree_root: true
PlaneSegmentation: PlaneSegmentation:
name: PlaneSegmentation name: PlaneSegmentation
@ -191,8 +162,20 @@ classes:
description: ROI masks for each ROI. Each image mask is the size of the original description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero. imaging plane (or volume) and members of the ROI are finite non-zero.
multivalued: false multivalued: false
range: PlaneSegmentation__image_mask range: AnyType
required: false required: false
any_of:
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- alias: num_z
pixel_mask_index: pixel_mask_index:
name: pixel_mask_index name: pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -228,19 +211,6 @@ classes:
any_of: any_of:
- range: ImageSeries - range: ImageSeries
tree_root: true tree_root: true
PlaneSegmentation__image_mask:
name: PlaneSegmentation__image_mask
description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(image_mask)
identifier: true
range: string
required: true
equals_string: image_mask
PlaneSegmentation__pixel_mask_index: PlaneSegmentation__pixel_mask_index:
name: PlaneSegmentation__pixel_mask_index name: PlaneSegmentation__pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -270,12 +240,13 @@ classes:
description: An imaging plane and its metadata. description: An imaging plane and its metadata.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: OpticalChannel any_of:
- range: OpticalChannel
tree_root: true tree_root: true
OpticalChannel: OpticalChannel:
name: OpticalChannel name: OpticalChannel
@ -307,12 +278,13 @@ classes:
frame at each point in time is assumed to be 2-D (has only x & y dimensions).' frame at each point in time is assumed to be 2-D (has only x & y dimensions).'
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: CorrectedImageStack any_of:
- range: CorrectedImageStack
tree_root: true tree_root: true
CorrectedImageStack: CorrectedImageStack:
name: CorrectedImageStack name: CorrectedImageStack

View file

@ -1,4 +1,11 @@
name: core.nwb.retinotopy name: core.nwb.retinotopy
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.retinotopy id: core.nwb.retinotopy
version: 2.2.4 version: 2.2.4
imports: imports:
@ -55,7 +62,11 @@ classes:
description: Two-element array describing the contents of the two response description: Two-element array describing the contents of the two response
axis fields. Description should be something like ['altitude', 'azimuth'] axis fields. Description should be something like ['altitude', 'azimuth']
or '['radius', 'theta']. or '['radius', 'theta'].
multivalued: true multivalued: false
array:
dimensions:
- alias: axis_1, axis_2
exact_cardinality: 2
range: text range: text
required: true required: true
focal_depth_image: focal_depth_image:
@ -106,19 +117,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_phase_map__Array array:
ImagingRetinotopy__axis_1_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_1_power_map: ImagingRetinotopy__axis_1_power_map:
name: ImagingRetinotopy__axis_1_power_map name: ImagingRetinotopy__axis_1_power_map
description: Power response on the first measured axis. Response is scaled so description: Power response on the first measured axis. Response is scaled so
@ -146,19 +149,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_power_map__Array array:
ImagingRetinotopy__axis_1_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_phase_map: ImagingRetinotopy__axis_2_phase_map:
name: ImagingRetinotopy__axis_2_phase_map name: ImagingRetinotopy__axis_2_phase_map
description: Phase response to stimulus on the second measured axis. description: Phase response to stimulus on the second measured axis.
@ -185,19 +180,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_phase_map__Array array:
ImagingRetinotopy__axis_2_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_power_map: ImagingRetinotopy__axis_2_power_map:
name: ImagingRetinotopy__axis_2_power_map name: ImagingRetinotopy__axis_2_power_map
description: Power response on the second measured axis. Response is scaled so description: Power response on the second measured axis. Response is scaled so
@ -225,19 +212,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_power_map__Array array:
ImagingRetinotopy__axis_2_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__focal_depth_image: ImagingRetinotopy__focal_depth_image:
name: ImagingRetinotopy__focal_depth_image name: ImagingRetinotopy__focal_depth_image
description: 'Gray-scale image taken with same settings/parameters (e.g., focal description: 'Gray-scale image taken with same settings/parameters (e.g., focal
@ -274,19 +253,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__focal_depth_image__Array array:
ImagingRetinotopy__focal_depth_image__Array: dimensions:
name: ImagingRetinotopy__focal_depth_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true
ImagingRetinotopy__sign_map: ImagingRetinotopy__sign_map:
name: ImagingRetinotopy__sign_map name: ImagingRetinotopy__sign_map
description: Sine of the angle between the direction of the gradient in axis_1 description: Sine of the angle between the direction of the gradient in axis_1
@ -310,19 +281,11 @@ classes:
range: float32 range: float32
array: array:
name: array name: array
range: ImagingRetinotopy__sign_map__Array array:
ImagingRetinotopy__sign_map__Array: dimensions:
name: ImagingRetinotopy__sign_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__vasculature_image: ImagingRetinotopy__vasculature_image:
name: ImagingRetinotopy__vasculature_image name: ImagingRetinotopy__vasculature_image
description: 'Gray-scale anatomical image of cortical surface. Array structure: description: 'Gray-scale anatomical image of cortical surface. Array structure:
@ -355,16 +318,8 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__vasculature_image__Array array:
ImagingRetinotopy__vasculature_image__Array: dimensions:
name: ImagingRetinotopy__vasculature_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true

View file

@ -1,8 +1,11 @@
name: core name: core
annotations: annotations:
is_namespace:
tag: is_namespace
value: true
namespace: namespace:
tag: namespace tag: namespace
value: 'True' value: core
description: NWB namespace description: NWB namespace
id: core id: core
version: 2.2.4 version: 2.2.4

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.2.5 version: 2.2.5
imports: imports:
@ -39,32 +46,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -130,7 +130,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -138,7 +141,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -146,7 +152,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -201,27 +210,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -268,13 +276,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.2.5 version: 2.2.5
imports: imports:
@ -59,19 +66,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -88,12 +91,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -101,12 +105,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -114,36 +119,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -154,22 +162,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.device name: core.nwb.device
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.device id: core.nwb.device
version: 2.2.5 version: 2.2.5
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.ecephys name: core.nwb.ecephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ecephys id: core.nwb.ecephys
version: 2.2.5 version: 2.2.5
imports: imports:
@ -25,8 +32,21 @@ classes:
name: data name: data
description: Recorded voltage data. description: Recorded voltage data.
multivalued: false multivalued: false
range: ElectricalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_channels
- array:
dimensions:
- alias: num_times
- alias: num_channels
- alias: num_samples
electrodes: electrodes:
name: electrodes name: electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -45,47 +65,13 @@ classes:
as native values generated by data acquisition systems. If this dataset as native values generated by data acquisition systems. If this dataset
is not present, then there is no channel-specific conversion factor, i.e. is not present, then there is no channel-specific conversion factor, i.e.
it is 1 for all channels. it is 1 for all channels.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_channels
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
ElectricalSeries__data:
name: ElectricalSeries__data
description: Recorded voltage data.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. This value
is fixed to 'volts'. Actual stored values are not necessarily stored in
these units. To access the data in these units, multiply 'data' by 'conversion'
and 'channel_conversion' (if present).
range: text
array:
name: array
range: ElectricalSeries__data__Array
ElectricalSeries__data__Array:
name: ElectricalSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
num_samples:
name: num_samples
range: numeric
required: false
ElectricalSeries__electrodes: ElectricalSeries__electrodes:
name: ElectricalSeries__electrodes name: ElectricalSeries__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -120,52 +106,31 @@ classes:
name: data name: data
description: Spike waveforms. description: Spike waveforms.
multivalued: false multivalued: false
range: SpikeEventSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_events
- alias: num_samples
- array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_samples
timestamps: timestamps:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
Timestamps are required for the events. Unlike for TimeSeries, timestamps Timestamps are required for the events. Unlike for TimeSeries, timestamps
are required for SpikeEventSeries and are thus re-specified here. are required for SpikeEventSeries and are thus re-specified here.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
SpikeEventSeries__data:
name: SpikeEventSeries__data
description: Spike waveforms.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Unit of measurement for waveforms, which is fixed to 'volts'.
range: text
array:
name: array
range: SpikeEventSeries__data__Array
SpikeEventSeries__data__Array:
name: SpikeEventSeries__data__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: numeric
required: true
num_samples:
name: num_samples
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
FeatureExtraction: FeatureExtraction:
name: FeatureExtraction name: FeatureExtraction
description: Features, such as PC1 and PC2, that are extracted from signals stored description: Features, such as PC1 and PC2, that are extracted from signals stored
@ -181,19 +146,30 @@ classes:
name: description name: description
description: Description of features (eg, ''PC1'') for each of the extracted description: Description of features (eg, ''PC1'') for each of the extracted
features. features.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
features: features:
name: features name: features
description: Multi-dimensional array of features extracted from each event. description: Multi-dimensional array of features extracted from each event.
multivalued: false multivalued: false
range: FeatureExtraction__features array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_features
range: float32
required: true required: true
times: times:
name: times name: times
description: Times of events that features correspond to (can be a link). description: Times of events that features correspond to (can be a link).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
electrodes: electrodes:
@ -204,36 +180,6 @@ classes:
range: FeatureExtraction__electrodes range: FeatureExtraction__electrodes
required: true required: true
tree_root: true tree_root: true
FeatureExtraction__features:
name: FeatureExtraction__features
description: Multi-dimensional array of features extracted from each event.
attributes:
name:
name: name
ifabsent: string(features)
identifier: true
range: string
required: true
equals_string: features
array:
name: array
range: FeatureExtraction__features__Array
FeatureExtraction__features__Array:
name: FeatureExtraction__features__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: float32
required: true
num_channels:
name: num_channels
range: float32
required: true
num_features:
name: num_features
range: float32
required: true
FeatureExtraction__electrodes: FeatureExtraction__electrodes:
name: FeatureExtraction__electrodes name: FeatureExtraction__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -270,13 +216,19 @@ classes:
corresponding to time of event. ''description'' should define what is meant corresponding to time of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing by time of event (e.g., .25 ms before action potential peak, zero-crossing
time, etc). The index points to each event from the raw data. time, etc). The index points to each event from the raw data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
times: times:
name: times name: times
description: Timestamps of events, in seconds. description: Timestamps of events, in seconds.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
@ -287,12 +239,13 @@ classes:
during experiment acquisition. during experiment acquisition.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpikeEventSeries any_of:
- range: SpikeEventSeries
tree_root: true tree_root: true
FilteredEphys: FilteredEphys:
name: FilteredEphys name: FilteredEphys
@ -309,12 +262,13 @@ classes:
the ElectricalSeries. the ElectricalSeries.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
LFP: LFP:
name: LFP name: LFP
@ -323,12 +277,13 @@ classes:
properties should be noted in the ElectricalSeries description or comments field. properties should be noted in the ElectricalSeries description or comments field.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
ElectrodeGroup: ElectrodeGroup:
name: ElectrodeGroup name: ElectrodeGroup
@ -385,72 +340,24 @@ classes:
3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence
should be empty (e.g., zero- filled) should be empty (e.g., zero- filled)
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_mean array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as description: Stdev of waveforms for each cluster, using the same indices as
in mean in mean
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_sd array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
tree_root: true tree_root: true
ClusterWaveforms__waveform_mean:
name: ClusterWaveforms__waveform_mean
description: The mean waveform for each cluster, using the same indices for each
wave as cluster numbers in the associated Clustering module (i.e, cluster 3
is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should
be empty (e.g., zero- filled)
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
array:
name: array
range: ClusterWaveforms__waveform_mean__Array
ClusterWaveforms__waveform_mean__Array:
name: ClusterWaveforms__waveform_mean__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
ClusterWaveforms__waveform_sd:
name: ClusterWaveforms__waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as in
mean
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
array:
name: array
range: ClusterWaveforms__waveform_sd__Array
ClusterWaveforms__waveform_sd__Array:
name: ClusterWaveforms__waveform_sd__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
Clustering: Clustering:
name: Clustering name: Clustering
description: DEPRECATED Clustered spike data, whether from automatic clustering description: DEPRECATED Clustered spike data, whether from automatic clustering
@ -472,21 +379,30 @@ classes:
num: num:
name: num name: num
description: Cluster number of each event description: Cluster number of each event
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
peak_over_rms: peak_over_rms:
name: peak_over_rms name: peak_over_rms
description: Maximum ratio of waveform peak to RMS on any channel in the cluster description: Maximum ratio of waveform peak to RMS on any channel in the cluster
(provides a basic clustering metric). (provides a basic clustering metric).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_clusters
range: float32 range: float32
required: true required: true
times: times:
name: times name: times
description: Times of clustered events, in seconds. This may be a link to description: Times of clustered events, in seconds. This may be a link to
times field in associated FeatureExtraction module. times field in associated FeatureExtraction module.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.epoch name: core.nwb.epoch
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.epoch id: core.nwb.epoch
version: 2.2.5 version: 2.2.5
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.file name: core.nwb.file
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.file id: core.nwb.file
version: 2.2.5 version: 2.2.5
imports: imports:
@ -56,7 +63,10 @@ classes:
The file can be created after the experiment was run, so this may differ The file can be created after the experiment was run, so this may differ
from the experiment start time. Each modification to the nwb file adds a from the experiment start time. Each modification to the nwb file adds a
new entry to the array.' new entry to the array.'
multivalued: true multivalued: false
array:
dimensions:
- alias: num_modifications
range: isodatetime range: isodatetime
required: true required: true
identifier: identifier:
@ -198,9 +208,14 @@ classes:
having a particular scientific goal, trials (see trials subgroup) during having a particular scientific goal, trials (see trials subgroup) during
an experiment, or epochs (see epochs subgroup) deriving from analysis of an experiment, or epochs (see epochs subgroup) deriving from analysis of
data. data.
multivalued: false multivalued: true
range: NWBFile__intervals inlined: true
required: false inlined_as_list: false
any_of:
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
units: units:
name: units name: units
description: Data about sorted spike units. description: Data about sorted spike units.
@ -289,7 +304,10 @@ classes:
name: experimenter name: experimenter
description: Name of person(s) who performed the experiment. Can also specify description: Name of person(s) who performed the experiment. Can also specify
roles of different people involved. roles of different people involved.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_experimenters
range: text range: text
required: false required: false
institution: institution:
@ -301,7 +319,10 @@ classes:
keywords: keywords:
name: keywords name: keywords
description: Terms to search over. description: Terms to search over.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_keywords
range: text range: text
required: false required: false
lab: lab:
@ -333,7 +354,10 @@ classes:
related_publications: related_publications:
name: related_publications name: related_publications
description: Publication information. PMID, DOI, URL, etc. description: Publication information. PMID, DOI, URL, etc.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_publications
range: text range: text
required: false required: false
session_id: session_id:
@ -575,45 +599,6 @@ classes:
multivalued: false multivalued: false
range: SweepTable range: SweepTable
required: false required: false
NWBFile__intervals:
name: NWBFile__intervals
description: Experimental intervals, whether that be logically distinct sub-experiments
having a particular scientific goal, trials (see trials subgroup) during an
experiment, or epochs (see epochs subgroup) deriving from analysis of data.
attributes:
name:
name: name
ifabsent: string(intervals)
identifier: true
range: string
required: true
equals_string: intervals
epochs:
name: epochs
description: Divisions in time marking experimental stages or sub-divisions
of a single recording session.
multivalued: false
range: TimeIntervals
required: false
trials:
name: trials
description: Repeated experimental events that have a logical grouping.
multivalued: false
range: TimeIntervals
required: false
invalid_times:
name: invalid_times
description: Time intervals that should be removed from analysis.
multivalued: false
range: TimeIntervals
required: false
time_intervals:
name: time_intervals
description: Optional additional table(s) for describing other experimental
time intervals.
multivalued: true
range: TimeIntervals
required: false
LabMetaData: LabMetaData:
name: LabMetaData name: LabMetaData
description: Lab-specific meta-data. description: Lab-specific meta-data.

View file

@ -1,4 +1,11 @@
name: core.nwb.icephys name: core.nwb.icephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.icephys id: core.nwb.icephys
version: 2.2.5 version: 2.2.5
imports: imports:
@ -30,8 +37,8 @@ classes:
data: data:
name: data name: data
description: Recorded voltage or current. description: Recorded voltage or current.
multivalued: true multivalued: false
range: numeric range: PatchClampSeries__data
required: true required: true
gain: gain:
name: gain name: gain
@ -41,6 +48,29 @@ classes:
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
PatchClampSeries__data:
name: PatchClampSeries__data
description: Recorded voltage or current.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. Actual stored
values are not necessarily stored in these units. To access the data in
these units, multiply 'data' by 'conversion'.
range: text
array:
name: array
array:
dimensions:
- alias: num_times
range: numeric
CurrentClampSeries: CurrentClampSeries:
name: CurrentClampSeries name: CurrentClampSeries
description: Voltage data from an intracellular current-clamp recording. A corresponding description: Voltage data from an intracellular current-clamp recording. A corresponding

View file

@ -1,4 +1,11 @@
name: core.nwb.image name: core.nwb.image
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.image id: core.nwb.image
version: 2.2.5 version: 2.2.5
imports: imports:
@ -16,22 +23,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: GrayscaleImage__Array
tree_root: true tree_root: true
GrayscaleImage__Array:
name: GrayscaleImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
RGBImage: RGBImage:
name: RGBImage name: RGBImage
description: A color image. description: A color image.
@ -42,28 +34,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBImage__Array
tree_root: true tree_root: true
RGBImage__Array:
name: RGBImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RGBAImage: RGBAImage:
name: RGBAImage name: RGBAImage
description: A color image with transparency. description: A color image with transparency.
@ -74,28 +45,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBAImage__Array
tree_root: true tree_root: true
RGBAImage__Array:
name: RGBAImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b, a:
name: r, g, b, a
range: numeric
required: true
minimum_cardinality: 4
maximum_cardinality: 4
ImageSeries: ImageSeries:
name: ImageSeries name: ImageSeries
description: General image data that is common between acquisition and stimulus description: General image data that is common between acquisition and stimulus
@ -115,12 +65,27 @@ classes:
name: data name: data
description: Binary data representing images across frames. description: Binary data representing images across frames.
multivalued: false multivalued: false
range: ImageSeries__data range: numeric
required: false required: false
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: z
dimension: dimension:
name: dimension name: dimension
description: Number of pixels on x, y, (and z) axes. description: Number of pixels on x, y, (and z) axes.
multivalued: true multivalued: false
array:
dimensions:
- alias: rank
range: int32 range: int32
required: false required: false
external_file: external_file:
@ -130,8 +95,8 @@ classes:
in the file system as one or more image file(s). This field should NOT be in the file system as one or more image file(s). This field should NOT be
used if the image is stored in another NWB file and that file is linked used if the image is stored in another NWB file and that file is linked
to this file. to this file.
multivalued: true multivalued: false
range: text range: ImageSeries__external_file
required: false required: false
format: format:
name: format name: format
@ -143,40 +108,41 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
ImageSeries__data: ImageSeries__external_file:
name: ImageSeries__data name: ImageSeries__external_file
description: Binary data representing images across frames. description: Paths to one or more external file(s). The field is only present
if format='external'. This is only relevant if the image series is stored in
the file system as one or more image file(s). This field should NOT be used
if the image is stored in another NWB file and that file is linked to this file.
attributes: attributes:
name: name:
name: name name: name
ifabsent: string(data) ifabsent: string(external_file)
identifier: true identifier: true
range: string range: string
required: true required: true
equals_string: data equals_string: external_file
starting_frame:
name: starting_frame
description: Each external image may contain one or more consecutive frames
of the full ImageSeries. This attribute serves as an index to indicate which
frames each file contains, to faciliate random access. The 'starting_frame'
attribute, hence, contains a list of frame numbers within the full ImageSeries
of the first frame of each file listed in the parent 'external_file' dataset.
Zero-based indexing is used (hence, the first element will always be zero).
For example, if the 'external_file' dataset has three paths to files and
the first file has 5 frames, the second file has 10 frames, and the third
file has 20 frames, then this attribute will have values [0, 5, 15]. If
there is a single external file that holds all of the frames of the ImageSeries
(and so there is a single element in the 'external_file' dataset), then
this attribute should have value [0].
range: int32
array: array:
name: array name: array
range: ImageSeries__data__Array array:
ImageSeries__data__Array: dimensions:
name: ImageSeries__data__Array - alias: num_files
is_a: Arraylike range: text
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
z:
name: z
range: numeric
required: false
ImageMaskSeries: ImageMaskSeries:
name: ImageMaskSeries name: ImageMaskSeries
description: An alpha mask that is applied to a presented visual stimulus. The description: An alpha mask that is applied to a presented visual stimulus. The
@ -216,14 +182,36 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: OpticalSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width, height
exact_cardinality: 2
- array:
dimensions:
- alias: width, height, depth
exact_cardinality: 3
data: data:
name: data name: data
description: Images presented to subject, either grayscale or RGB description: Images presented to subject, either grayscale or RGB
multivalued: false multivalued: false
range: OpticalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
orientation: orientation:
name: orientation name: orientation
description: Description of image relative to some reference frame (e.g., description: Description of image relative to some reference frame (e.g.,
@ -232,72 +220,6 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
OpticalSeries__field_of_view:
name: OpticalSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: OpticalSeries__field_of_view__Array
OpticalSeries__field_of_view__Array:
name: OpticalSeries__field_of_view__Array
is_a: Arraylike
attributes:
width, height:
name: width, height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width, height, depth:
name: width, height, depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
OpticalSeries__data:
name: OpticalSeries__data
description: Images presented to subject, either grayscale or RGB
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: OpticalSeries__data__Array
OpticalSeries__data__Array:
name: OpticalSeries__data__Array
is_a: Arraylike
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
IndexSeries: IndexSeries:
name: IndexSeries name: IndexSeries
description: Stores indices to image frames stored in an ImageSeries. The purpose description: Stores indices to image frames stored in an ImageSeries. The purpose
@ -316,7 +238,10 @@ classes:
data: data:
name: data name: data
description: Index of the frame in the referenced ImageSeries. description: Index of the frame in the referenced ImageSeries.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int32 range: int32
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.language name: core.nwb.language
annotations:
is_namespace:
tag: is_namespace
value: 'False'
namespace:
tag: namespace
value: core
description: Adapter objects to mimic the behavior of elements in the nwb-schema-language description: Adapter objects to mimic the behavior of elements in the nwb-schema-language
id: nwb.language id: nwb.language
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.misc name: core.nwb.misc
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.misc id: core.nwb.misc
version: 2.2.5 version: 2.2.5
imports: imports:
@ -35,13 +42,19 @@ classes:
feature_units: feature_units:
name: feature_units name: feature_units
description: Units of each feature. description: Units of each feature.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: false required: false
features: features:
name: features name: features
description: Description of the features represented in TimeSeries::data. description: Description of the features represented in TimeSeries::data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -64,19 +77,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AbstractFeatureSeries__data__Array
AbstractFeatureSeries__data__Array:
name: AbstractFeatureSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
AnnotationSeries: AnnotationSeries:
name: AnnotationSeries name: AnnotationSeries
description: Stores user annotations made during an experiment. The data[] field description: Stores user annotations made during an experiment. The data[] field
@ -93,7 +102,10 @@ classes:
data: data:
name: data name: data
description: Annotations made during an experiment. description: Annotations made during an experiment.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -116,7 +128,10 @@ classes:
data: data:
name: data name: data
description: Use values >0 if interval started, <0 if interval ended. description: Use values >0 if interval started, <0 if interval ended.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int8 range: int8
required: true required: true
tree_root: true tree_root: true
@ -169,23 +184,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: DecompositionSeries__data__Array array:
DecompositionSeries__data__Array: dimensions:
name: DecompositionSeries__data__Array - alias: num_times
is_a: Arraylike - alias: num_channels
attributes: - alias: num_bands
num_times:
name: num_times
range: numeric range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: true
num_bands:
name: num_bands
range: numeric
required: true
DecompositionSeries__bands: DecompositionSeries__bands:
name: DecompositionSeries__bands name: DecompositionSeries__bands
description: Table for describing the bands that this series was generated from. description: Table for describing the bands that this series was generated from.
@ -209,33 +213,31 @@ classes:
description: Low and high limit of each band in Hz. If it is a Gaussian filter, description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center. use 2 SD on either side of the center.
multivalued: false multivalued: false
range: DecompositionSeries__bands__band_limits array:
dimensions:
- alias: num_bands
- alias: low, high
exact_cardinality: 2
range: float32
required: true required: true
band_mean: band_mean:
name: band_mean name: band_mean
description: The mean Gaussian filters, in Hz. description: The mean Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
band_stdev: band_stdev:
name: band_stdev name: band_stdev
description: The standard deviation of Gaussian filters, in Hz. description: The standard deviation of Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
DecompositionSeries__bands__band_limits:
name: DecompositionSeries__bands__band_limits
description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(band_limits)
identifier: true
range: string
required: true
equals_string: band_limits
Units: Units:
name: Units name: Units
description: Data about spiking units. Event times of observed units (e.g. cell, description: Data about spiking units. Event times of observed units (e.g. cell,
@ -269,7 +271,12 @@ classes:
name: obs_intervals name: obs_intervals
description: Observation intervals for each unit. description: Observation intervals for each unit.
multivalued: false multivalued: false
range: Units__obs_intervals array:
dimensions:
- alias: num_intervals
- alias: start|end
exact_cardinality: 2
range: float64
required: false required: false
electrodes_index: electrodes_index:
name: electrodes_index name: electrodes_index
@ -292,14 +299,34 @@ classes:
name: waveform_mean name: waveform_mean
description: Spike waveform mean for each spike unit. description: Spike waveform mean for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_mean range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Spike waveform standard deviation for each spike unit. description: Spike waveform standard deviation for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_sd range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
tree_root: true tree_root: true
Units__spike_times_index: Units__spike_times_index:
name: Units__spike_times_index name: Units__spike_times_index
@ -345,18 +372,6 @@ classes:
range: string range: string
required: true required: true
equals_string: obs_intervals_index equals_string: obs_intervals_index
Units__obs_intervals:
name: Units__obs_intervals
description: Observation intervals for each unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(obs_intervals)
identifier: true
range: string
required: true
equals_string: obs_intervals
Units__electrodes_index: Units__electrodes_index:
name: Units__electrodes_index name: Units__electrodes_index
description: Index into electrodes. description: Index into electrodes.
@ -381,43 +396,3 @@ classes:
range: string range: string
required: true required: true
equals_string: electrodes equals_string: electrodes
Units__waveform_mean:
name: Units__waveform_mean
description: Spike waveform mean for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveform_sd:
name: Units__waveform_sd
description: Spike waveform standard deviation for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text

View file

@ -1,4 +1,11 @@
name: core.nwb.ogen name: core.nwb.ogen
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ogen id: core.nwb.ogen
version: 2.2.5 version: 2.2.5
imports: imports:
@ -20,7 +27,10 @@ classes:
data: data:
name: data name: data
description: Applied power for optogenetic stimulus, in watts. description: Applied power for optogenetic stimulus, in watts.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: numeric range: numeric
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.ophys name: core.nwb.ophys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ophys id: core.nwb.ophys
version: 2.2.5 version: 2.2.5
imports: imports:
@ -33,39 +40,18 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: TwoPhotonSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width|height
exact_cardinality: 2
- array:
dimensions:
- alias: width|height|depth
exact_cardinality: 3
tree_root: true tree_root: true
TwoPhotonSeries__field_of_view:
name: TwoPhotonSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: TwoPhotonSeries__field_of_view__Array
TwoPhotonSeries__field_of_view__Array:
name: TwoPhotonSeries__field_of_view__Array
is_a: Arraylike
attributes:
width|height:
name: width|height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width|height|depth:
name: width|height|depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
RoiResponseSeries: RoiResponseSeries:
name: RoiResponseSeries name: RoiResponseSeries
description: ROI responses over an imaging plane. The first dimension represents description: ROI responses over an imaging plane. The first dimension represents
@ -81,8 +67,16 @@ classes:
name: data name: data
description: Signals from ROIs. description: Signals from ROIs.
multivalued: false multivalued: false
range: RoiResponseSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_ROIs
rois: rois:
name: rois name: rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -91,32 +85,6 @@ classes:
range: RoiResponseSeries__rois range: RoiResponseSeries__rois
required: true required: true
tree_root: true tree_root: true
RoiResponseSeries__data:
name: RoiResponseSeries__data
description: Signals from ROIs.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: RoiResponseSeries__data__Array
RoiResponseSeries__data__Array:
name: RoiResponseSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_ROIs:
name: num_ROIs
range: numeric
required: false
RoiResponseSeries__rois: RoiResponseSeries__rois:
name: RoiResponseSeries__rois name: RoiResponseSeries__rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -137,12 +105,13 @@ classes:
for image planes). for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
Fluorescence: Fluorescence:
name: Fluorescence name: Fluorescence
@ -151,12 +120,13 @@ classes:
for ROIs and for image planes). for ROIs and for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
ImageSegmentation: ImageSegmentation:
name: ImageSegmentation name: ImageSegmentation
@ -169,12 +139,13 @@ classes:
is required and ROI names should remain consistent between them. is required and ROI names should remain consistent between them.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: PlaneSegmentation any_of:
- range: PlaneSegmentation
tree_root: true tree_root: true
PlaneSegmentation: PlaneSegmentation:
name: PlaneSegmentation name: PlaneSegmentation
@ -191,8 +162,20 @@ classes:
description: ROI masks for each ROI. Each image mask is the size of the original description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero. imaging plane (or volume) and members of the ROI are finite non-zero.
multivalued: false multivalued: false
range: PlaneSegmentation__image_mask range: AnyType
required: false required: false
any_of:
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- alias: num_z
pixel_mask_index: pixel_mask_index:
name: pixel_mask_index name: pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -228,19 +211,6 @@ classes:
any_of: any_of:
- range: ImageSeries - range: ImageSeries
tree_root: true tree_root: true
PlaneSegmentation__image_mask:
name: PlaneSegmentation__image_mask
description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(image_mask)
identifier: true
range: string
required: true
equals_string: image_mask
PlaneSegmentation__pixel_mask_index: PlaneSegmentation__pixel_mask_index:
name: PlaneSegmentation__pixel_mask_index name: PlaneSegmentation__pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -270,12 +240,13 @@ classes:
description: An imaging plane and its metadata. description: An imaging plane and its metadata.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: OpticalChannel any_of:
- range: OpticalChannel
tree_root: true tree_root: true
OpticalChannel: OpticalChannel:
name: OpticalChannel name: OpticalChannel
@ -307,12 +278,13 @@ classes:
frame at each point in time is assumed to be 2-D (has only x & y dimensions).' frame at each point in time is assumed to be 2-D (has only x & y dimensions).'
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: CorrectedImageStack any_of:
- range: CorrectedImageStack
tree_root: true tree_root: true
CorrectedImageStack: CorrectedImageStack:
name: CorrectedImageStack name: CorrectedImageStack

View file

@ -1,4 +1,11 @@
name: core.nwb.retinotopy name: core.nwb.retinotopy
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.retinotopy id: core.nwb.retinotopy
version: 2.2.5 version: 2.2.5
imports: imports:
@ -55,7 +62,11 @@ classes:
description: Two-element array describing the contents of the two response description: Two-element array describing the contents of the two response
axis fields. Description should be something like ['altitude', 'azimuth'] axis fields. Description should be something like ['altitude', 'azimuth']
or '['radius', 'theta']. or '['radius', 'theta'].
multivalued: true multivalued: false
array:
dimensions:
- alias: axis_1, axis_2
exact_cardinality: 2
range: text range: text
required: true required: true
focal_depth_image: focal_depth_image:
@ -106,19 +117,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_phase_map__Array array:
ImagingRetinotopy__axis_1_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_1_power_map: ImagingRetinotopy__axis_1_power_map:
name: ImagingRetinotopy__axis_1_power_map name: ImagingRetinotopy__axis_1_power_map
description: Power response on the first measured axis. Response is scaled so description: Power response on the first measured axis. Response is scaled so
@ -146,19 +149,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_power_map__Array array:
ImagingRetinotopy__axis_1_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_phase_map: ImagingRetinotopy__axis_2_phase_map:
name: ImagingRetinotopy__axis_2_phase_map name: ImagingRetinotopy__axis_2_phase_map
description: Phase response to stimulus on the second measured axis. description: Phase response to stimulus on the second measured axis.
@ -185,19 +180,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_phase_map__Array array:
ImagingRetinotopy__axis_2_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_power_map: ImagingRetinotopy__axis_2_power_map:
name: ImagingRetinotopy__axis_2_power_map name: ImagingRetinotopy__axis_2_power_map
description: Power response on the second measured axis. Response is scaled so description: Power response on the second measured axis. Response is scaled so
@ -225,19 +212,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_power_map__Array array:
ImagingRetinotopy__axis_2_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__focal_depth_image: ImagingRetinotopy__focal_depth_image:
name: ImagingRetinotopy__focal_depth_image name: ImagingRetinotopy__focal_depth_image
description: 'Gray-scale image taken with same settings/parameters (e.g., focal description: 'Gray-scale image taken with same settings/parameters (e.g., focal
@ -274,19 +253,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__focal_depth_image__Array array:
ImagingRetinotopy__focal_depth_image__Array: dimensions:
name: ImagingRetinotopy__focal_depth_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true
ImagingRetinotopy__sign_map: ImagingRetinotopy__sign_map:
name: ImagingRetinotopy__sign_map name: ImagingRetinotopy__sign_map
description: Sine of the angle between the direction of the gradient in axis_1 description: Sine of the angle between the direction of the gradient in axis_1
@ -310,19 +281,11 @@ classes:
range: float32 range: float32
array: array:
name: array name: array
range: ImagingRetinotopy__sign_map__Array array:
ImagingRetinotopy__sign_map__Array: dimensions:
name: ImagingRetinotopy__sign_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__vasculature_image: ImagingRetinotopy__vasculature_image:
name: ImagingRetinotopy__vasculature_image name: ImagingRetinotopy__vasculature_image
description: 'Gray-scale anatomical image of cortical surface. Array structure: description: 'Gray-scale anatomical image of cortical surface. Array structure:
@ -355,16 +318,8 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__vasculature_image__Array array:
ImagingRetinotopy__vasculature_image__Array: dimensions:
name: ImagingRetinotopy__vasculature_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true

View file

@ -1,8 +1,11 @@
name: core name: core
annotations: annotations:
is_namespace:
tag: is_namespace
value: true
namespace: namespace:
tag: namespace tag: namespace
value: 'True' value: core
description: NWB namespace description: NWB namespace
id: core id: core
version: 2.2.5 version: 2.2.5

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.3.0 version: 2.3.0
imports: imports:
@ -40,32 +47,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -131,7 +131,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -139,7 +142,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -147,7 +153,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -214,27 +223,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -281,13 +289,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.3.0 version: 2.3.0
imports: imports:
@ -59,19 +66,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -88,12 +91,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -101,12 +105,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -114,36 +119,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -154,22 +162,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.device name: core.nwb.device
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.device id: core.nwb.device
version: 2.3.0 version: 2.3.0
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.ecephys name: core.nwb.ecephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ecephys id: core.nwb.ecephys
version: 2.3.0 version: 2.3.0
imports: imports:
@ -35,8 +42,21 @@ classes:
name: data name: data
description: Recorded voltage data. description: Recorded voltage data.
multivalued: false multivalued: false
range: ElectricalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_channels
- array:
dimensions:
- alias: num_times
- alias: num_channels
- alias: num_samples
electrodes: electrodes:
name: electrodes name: electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -55,47 +75,13 @@ classes:
as native values generated by data acquisition systems. If this dataset as native values generated by data acquisition systems. If this dataset
is not present, then there is no channel-specific conversion factor, i.e. is not present, then there is no channel-specific conversion factor, i.e.
it is 1 for all channels. it is 1 for all channels.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_channels
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
ElectricalSeries__data:
name: ElectricalSeries__data
description: Recorded voltage data.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. This value
is fixed to 'volts'. Actual stored values are not necessarily stored in
these units. To access the data in these units, multiply 'data' by 'conversion'
and 'channel_conversion' (if present).
range: text
array:
name: array
range: ElectricalSeries__data__Array
ElectricalSeries__data__Array:
name: ElectricalSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
num_samples:
name: num_samples
range: numeric
required: false
ElectricalSeries__electrodes: ElectricalSeries__electrodes:
name: ElectricalSeries__electrodes name: ElectricalSeries__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -130,52 +116,31 @@ classes:
name: data name: data
description: Spike waveforms. description: Spike waveforms.
multivalued: false multivalued: false
range: SpikeEventSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_events
- alias: num_samples
- array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_samples
timestamps: timestamps:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
Timestamps are required for the events. Unlike for TimeSeries, timestamps Timestamps are required for the events. Unlike for TimeSeries, timestamps
are required for SpikeEventSeries and are thus re-specified here. are required for SpikeEventSeries and are thus re-specified here.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
SpikeEventSeries__data:
name: SpikeEventSeries__data
description: Spike waveforms.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Unit of measurement for waveforms, which is fixed to 'volts'.
range: text
array:
name: array
range: SpikeEventSeries__data__Array
SpikeEventSeries__data__Array:
name: SpikeEventSeries__data__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: numeric
required: true
num_samples:
name: num_samples
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
FeatureExtraction: FeatureExtraction:
name: FeatureExtraction name: FeatureExtraction
description: Features, such as PC1 and PC2, that are extracted from signals stored description: Features, such as PC1 and PC2, that are extracted from signals stored
@ -191,19 +156,30 @@ classes:
name: description name: description
description: Description of features (eg, ''PC1'') for each of the extracted description: Description of features (eg, ''PC1'') for each of the extracted
features. features.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
features: features:
name: features name: features
description: Multi-dimensional array of features extracted from each event. description: Multi-dimensional array of features extracted from each event.
multivalued: false multivalued: false
range: FeatureExtraction__features array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_features
range: float32
required: true required: true
times: times:
name: times name: times
description: Times of events that features correspond to (can be a link). description: Times of events that features correspond to (can be a link).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
electrodes: electrodes:
@ -214,36 +190,6 @@ classes:
range: FeatureExtraction__electrodes range: FeatureExtraction__electrodes
required: true required: true
tree_root: true tree_root: true
FeatureExtraction__features:
name: FeatureExtraction__features
description: Multi-dimensional array of features extracted from each event.
attributes:
name:
name: name
ifabsent: string(features)
identifier: true
range: string
required: true
equals_string: features
array:
name: array
range: FeatureExtraction__features__Array
FeatureExtraction__features__Array:
name: FeatureExtraction__features__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: float32
required: true
num_channels:
name: num_channels
range: float32
required: true
num_features:
name: num_features
range: float32
required: true
FeatureExtraction__electrodes: FeatureExtraction__electrodes:
name: FeatureExtraction__electrodes name: FeatureExtraction__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -280,13 +226,19 @@ classes:
corresponding to time of event. ''description'' should define what is meant corresponding to time of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing by time of event (e.g., .25 ms before action potential peak, zero-crossing
time, etc). The index points to each event from the raw data. time, etc). The index points to each event from the raw data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
times: times:
name: times name: times
description: Timestamps of events, in seconds. description: Timestamps of events, in seconds.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
@ -297,12 +249,13 @@ classes:
during experiment acquisition. during experiment acquisition.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpikeEventSeries any_of:
- range: SpikeEventSeries
tree_root: true tree_root: true
FilteredEphys: FilteredEphys:
name: FilteredEphys name: FilteredEphys
@ -319,12 +272,13 @@ classes:
the ElectricalSeries 'filtering' attribute. the ElectricalSeries 'filtering' attribute.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
LFP: LFP:
name: LFP name: LFP
@ -333,12 +287,13 @@ classes:
properties should be noted in the ElectricalSeries 'filtering' attribute. properties should be noted in the ElectricalSeries 'filtering' attribute.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
ElectrodeGroup: ElectrodeGroup:
name: ElectrodeGroup name: ElectrodeGroup
@ -395,72 +350,24 @@ classes:
3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence
should be empty (e.g., zero- filled) should be empty (e.g., zero- filled)
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_mean array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as description: Stdev of waveforms for each cluster, using the same indices as
in mean in mean
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_sd array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
tree_root: true tree_root: true
ClusterWaveforms__waveform_mean:
name: ClusterWaveforms__waveform_mean
description: The mean waveform for each cluster, using the same indices for each
wave as cluster numbers in the associated Clustering module (i.e, cluster 3
is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should
be empty (e.g., zero- filled)
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
array:
name: array
range: ClusterWaveforms__waveform_mean__Array
ClusterWaveforms__waveform_mean__Array:
name: ClusterWaveforms__waveform_mean__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
ClusterWaveforms__waveform_sd:
name: ClusterWaveforms__waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as in
mean
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
array:
name: array
range: ClusterWaveforms__waveform_sd__Array
ClusterWaveforms__waveform_sd__Array:
name: ClusterWaveforms__waveform_sd__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
Clustering: Clustering:
name: Clustering name: Clustering
description: DEPRECATED Clustered spike data, whether from automatic clustering description: DEPRECATED Clustered spike data, whether from automatic clustering
@ -482,21 +389,30 @@ classes:
num: num:
name: num name: num
description: Cluster number of each event description: Cluster number of each event
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
peak_over_rms: peak_over_rms:
name: peak_over_rms name: peak_over_rms
description: Maximum ratio of waveform peak to RMS on any channel in the cluster description: Maximum ratio of waveform peak to RMS on any channel in the cluster
(provides a basic clustering metric). (provides a basic clustering metric).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_clusters
range: float32 range: float32
required: true required: true
times: times:
name: times name: times
description: Times of clustered events, in seconds. This may be a link to description: Times of clustered events, in seconds. This may be a link to
times field in associated FeatureExtraction module. times field in associated FeatureExtraction module.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.epoch name: core.nwb.epoch
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.epoch id: core.nwb.epoch
version: 2.3.0 version: 2.3.0
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.file name: core.nwb.file
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.file id: core.nwb.file
version: 2.3.0 version: 2.3.0
imports: imports:
@ -56,7 +63,10 @@ classes:
The file can be created after the experiment was run, so this may differ The file can be created after the experiment was run, so this may differ
from the experiment start time. Each modification to the nwb file adds a from the experiment start time. Each modification to the nwb file adds a
new entry to the array.' new entry to the array.'
multivalued: true multivalued: false
array:
dimensions:
- alias: num_modifications
range: isodatetime range: isodatetime
required: true required: true
identifier: identifier:
@ -198,9 +208,14 @@ classes:
having a particular scientific goal, trials (see trials subgroup) during having a particular scientific goal, trials (see trials subgroup) during
an experiment, or epochs (see epochs subgroup) deriving from analysis of an experiment, or epochs (see epochs subgroup) deriving from analysis of
data. data.
multivalued: false multivalued: true
range: NWBFile__intervals inlined: true
required: false inlined_as_list: false
any_of:
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
units: units:
name: units name: units
description: Data about sorted spike units. description: Data about sorted spike units.
@ -289,7 +304,10 @@ classes:
name: experimenter name: experimenter
description: Name of person(s) who performed the experiment. Can also specify description: Name of person(s) who performed the experiment. Can also specify
roles of different people involved. roles of different people involved.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_experimenters
range: text range: text
required: false required: false
institution: institution:
@ -301,7 +319,10 @@ classes:
keywords: keywords:
name: keywords name: keywords
description: Terms to search over. description: Terms to search over.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_keywords
range: text range: text
required: false required: false
lab: lab:
@ -333,7 +354,10 @@ classes:
related_publications: related_publications:
name: related_publications name: related_publications
description: Publication information. PMID, DOI, URL, etc. description: Publication information. PMID, DOI, URL, etc.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_publications
range: text range: text
required: false required: false
session_id: session_id:
@ -576,45 +600,6 @@ classes:
multivalued: false multivalued: false
range: SweepTable range: SweepTable
required: false required: false
NWBFile__intervals:
name: NWBFile__intervals
description: Experimental intervals, whether that be logically distinct sub-experiments
having a particular scientific goal, trials (see trials subgroup) during an
experiment, or epochs (see epochs subgroup) deriving from analysis of data.
attributes:
name:
name: name
ifabsent: string(intervals)
identifier: true
range: string
required: true
equals_string: intervals
epochs:
name: epochs
description: Divisions in time marking experimental stages or sub-divisions
of a single recording session.
multivalued: false
range: TimeIntervals
required: false
trials:
name: trials
description: Repeated experimental events that have a logical grouping.
multivalued: false
range: TimeIntervals
required: false
invalid_times:
name: invalid_times
description: Time intervals that should be removed from analysis.
multivalued: false
range: TimeIntervals
required: false
time_intervals:
name: time_intervals
description: Optional additional table(s) for describing other experimental
time intervals.
multivalued: true
range: TimeIntervals
required: false
LabMetaData: LabMetaData:
name: LabMetaData name: LabMetaData
description: Lab-specific meta-data. description: Lab-specific meta-data.

View file

@ -1,4 +1,11 @@
name: core.nwb.icephys name: core.nwb.icephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.icephys id: core.nwb.icephys
version: 2.3.0 version: 2.3.0
imports: imports:
@ -30,8 +37,8 @@ classes:
data: data:
name: data name: data
description: Recorded voltage or current. description: Recorded voltage or current.
multivalued: true multivalued: false
range: numeric range: PatchClampSeries__data
required: true required: true
gain: gain:
name: gain name: gain
@ -41,6 +48,29 @@ classes:
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
PatchClampSeries__data:
name: PatchClampSeries__data
description: Recorded voltage or current.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. Actual stored
values are not necessarily stored in these units. To access the data in
these units, multiply 'data' by 'conversion'.
range: text
array:
name: array
array:
dimensions:
- alias: num_times
range: numeric
CurrentClampSeries: CurrentClampSeries:
name: CurrentClampSeries name: CurrentClampSeries
description: Voltage data from an intracellular current-clamp recording. A corresponding description: Voltage data from an intracellular current-clamp recording. A corresponding

View file

@ -1,4 +1,11 @@
name: core.nwb.image name: core.nwb.image
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.image id: core.nwb.image
version: 2.3.0 version: 2.3.0
imports: imports:
@ -17,22 +24,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: GrayscaleImage__Array
tree_root: true tree_root: true
GrayscaleImage__Array:
name: GrayscaleImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
RGBImage: RGBImage:
name: RGBImage name: RGBImage
description: A color image. description: A color image.
@ -43,28 +35,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBImage__Array
tree_root: true tree_root: true
RGBImage__Array:
name: RGBImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RGBAImage: RGBAImage:
name: RGBAImage name: RGBAImage
description: A color image with transparency. description: A color image with transparency.
@ -75,28 +46,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBAImage__Array
tree_root: true tree_root: true
RGBAImage__Array:
name: RGBAImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b, a:
name: r, g, b, a
range: numeric
required: true
minimum_cardinality: 4
maximum_cardinality: 4
ImageSeries: ImageSeries:
name: ImageSeries name: ImageSeries
description: General image data that is common between acquisition and stimulus description: General image data that is common between acquisition and stimulus
@ -116,12 +66,27 @@ classes:
name: data name: data
description: Binary data representing images across frames. description: Binary data representing images across frames.
multivalued: false multivalued: false
range: ImageSeries__data range: numeric
required: false required: false
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: z
dimension: dimension:
name: dimension name: dimension
description: Number of pixels on x, y, (and z) axes. description: Number of pixels on x, y, (and z) axes.
multivalued: true multivalued: false
array:
dimensions:
- alias: rank
range: int32 range: int32
required: false required: false
external_file: external_file:
@ -131,8 +96,8 @@ classes:
in the file system as one or more image file(s). This field should NOT be in the file system as one or more image file(s). This field should NOT be
used if the image is stored in another NWB file and that file is linked used if the image is stored in another NWB file and that file is linked
to this file. to this file.
multivalued: true multivalued: false
range: text range: ImageSeries__external_file
required: false required: false
format: format:
name: format name: format
@ -144,40 +109,41 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
ImageSeries__data: ImageSeries__external_file:
name: ImageSeries__data name: ImageSeries__external_file
description: Binary data representing images across frames. description: Paths to one or more external file(s). The field is only present
if format='external'. This is only relevant if the image series is stored in
the file system as one or more image file(s). This field should NOT be used
if the image is stored in another NWB file and that file is linked to this file.
attributes: attributes:
name: name:
name: name name: name
ifabsent: string(data) ifabsent: string(external_file)
identifier: true identifier: true
range: string range: string
required: true required: true
equals_string: data equals_string: external_file
starting_frame:
name: starting_frame
description: Each external image may contain one or more consecutive frames
of the full ImageSeries. This attribute serves as an index to indicate which
frames each file contains, to faciliate random access. The 'starting_frame'
attribute, hence, contains a list of frame numbers within the full ImageSeries
of the first frame of each file listed in the parent 'external_file' dataset.
Zero-based indexing is used (hence, the first element will always be zero).
For example, if the 'external_file' dataset has three paths to files and
the first file has 5 frames, the second file has 10 frames, and the third
file has 20 frames, then this attribute will have values [0, 5, 15]. If
there is a single external file that holds all of the frames of the ImageSeries
(and so there is a single element in the 'external_file' dataset), then
this attribute should have value [0].
range: int32
array: array:
name: array name: array
range: ImageSeries__data__Array array:
ImageSeries__data__Array: dimensions:
name: ImageSeries__data__Array - alias: num_files
is_a: Arraylike range: text
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
z:
name: z
range: numeric
required: false
ImageMaskSeries: ImageMaskSeries:
name: ImageMaskSeries name: ImageMaskSeries
description: An alpha mask that is applied to a presented visual stimulus. The description: An alpha mask that is applied to a presented visual stimulus. The
@ -217,14 +183,36 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: OpticalSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width, height
exact_cardinality: 2
- array:
dimensions:
- alias: width, height, depth
exact_cardinality: 3
data: data:
name: data name: data
description: Images presented to subject, either grayscale or RGB description: Images presented to subject, either grayscale or RGB
multivalued: false multivalued: false
range: OpticalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
orientation: orientation:
name: orientation name: orientation
description: Description of image relative to some reference frame (e.g., description: Description of image relative to some reference frame (e.g.,
@ -233,72 +221,6 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
OpticalSeries__field_of_view:
name: OpticalSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: OpticalSeries__field_of_view__Array
OpticalSeries__field_of_view__Array:
name: OpticalSeries__field_of_view__Array
is_a: Arraylike
attributes:
width, height:
name: width, height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width, height, depth:
name: width, height, depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
OpticalSeries__data:
name: OpticalSeries__data
description: Images presented to subject, either grayscale or RGB
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: OpticalSeries__data__Array
OpticalSeries__data__Array:
name: OpticalSeries__data__Array
is_a: Arraylike
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
IndexSeries: IndexSeries:
name: IndexSeries name: IndexSeries
description: Stores indices to image frames stored in an ImageSeries. The purpose description: Stores indices to image frames stored in an ImageSeries. The purpose
@ -317,7 +239,10 @@ classes:
data: data:
name: data name: data
description: Index of the frame in the referenced ImageSeries. description: Index of the frame in the referenced ImageSeries.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int32 range: int32
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.language name: core.nwb.language
annotations:
is_namespace:
tag: is_namespace
value: 'False'
namespace:
tag: namespace
value: core
description: Adapter objects to mimic the behavior of elements in the nwb-schema-language description: Adapter objects to mimic the behavior of elements in the nwb-schema-language
id: nwb.language id: nwb.language
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.misc name: core.nwb.misc
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.misc id: core.nwb.misc
version: 2.3.0 version: 2.3.0
imports: imports:
@ -35,13 +42,19 @@ classes:
feature_units: feature_units:
name: feature_units name: feature_units
description: Units of each feature. description: Units of each feature.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: false required: false
features: features:
name: features name: features
description: Description of the features represented in TimeSeries::data. description: Description of the features represented in TimeSeries::data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -64,19 +77,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AbstractFeatureSeries__data__Array
AbstractFeatureSeries__data__Array:
name: AbstractFeatureSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
AnnotationSeries: AnnotationSeries:
name: AnnotationSeries name: AnnotationSeries
description: Stores user annotations made during an experiment. The data[] field description: Stores user annotations made during an experiment. The data[] field
@ -93,7 +102,10 @@ classes:
data: data:
name: data name: data
description: Annotations made during an experiment. description: Annotations made during an experiment.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -116,7 +128,10 @@ classes:
data: data:
name: data name: data
description: Use values >0 if interval started, <0 if interval ended. description: Use values >0 if interval started, <0 if interval ended.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int8 range: int8
required: true required: true
tree_root: true tree_root: true
@ -176,23 +191,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: DecompositionSeries__data__Array array:
DecompositionSeries__data__Array: dimensions:
name: DecompositionSeries__data__Array - alias: num_times
is_a: Arraylike - alias: num_channels
attributes: - alias: num_bands
num_times:
name: num_times
range: numeric range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: true
num_bands:
name: num_bands
range: numeric
required: true
DecompositionSeries__source_channels: DecompositionSeries__source_channels:
name: DecompositionSeries__source_channels name: DecompositionSeries__source_channels
description: DynamicTableRegion pointer to the channels that this decomposition description: DynamicTableRegion pointer to the channels that this decomposition
@ -229,33 +233,31 @@ classes:
description: Low and high limit of each band in Hz. If it is a Gaussian filter, description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center. use 2 SD on either side of the center.
multivalued: false multivalued: false
range: DecompositionSeries__bands__band_limits array:
dimensions:
- alias: num_bands
- alias: low, high
exact_cardinality: 2
range: float32
required: true required: true
band_mean: band_mean:
name: band_mean name: band_mean
description: The mean Gaussian filters, in Hz. description: The mean Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
band_stdev: band_stdev:
name: band_stdev name: band_stdev
description: The standard deviation of Gaussian filters, in Hz. description: The standard deviation of Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
DecompositionSeries__bands__band_limits:
name: DecompositionSeries__bands__band_limits
description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(band_limits)
identifier: true
range: string
required: true
equals_string: band_limits
Units: Units:
name: Units name: Units
description: Data about spiking units. Event times of observed units (e.g. cell, description: Data about spiking units. Event times of observed units (e.g. cell,
@ -289,7 +291,12 @@ classes:
name: obs_intervals name: obs_intervals
description: Observation intervals for each unit. description: Observation intervals for each unit.
multivalued: false multivalued: false
range: Units__obs_intervals array:
dimensions:
- alias: num_intervals
- alias: start|end
exact_cardinality: 2
range: float64
required: false required: false
electrodes_index: electrodes_index:
name: electrodes_index name: electrodes_index
@ -312,14 +319,34 @@ classes:
name: waveform_mean name: waveform_mean
description: Spike waveform mean for each spike unit. description: Spike waveform mean for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_mean range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Spike waveform standard deviation for each spike unit. description: Spike waveform standard deviation for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_sd range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveforms: waveforms:
name: waveforms name: waveforms
description: Individual waveforms for each spike on each electrode. This is description: Individual waveforms for each spike on each electrode. This is
@ -346,7 +373,11 @@ classes:
same order as the electrodes referenced in the 'electrodes' column of this same order as the electrodes referenced in the 'electrodes' column of this
table. The number of samples for each waveform must be the same. table. The number of samples for each waveform must be the same.
multivalued: false multivalued: false
range: Units__waveforms array:
dimensions:
- alias: num_waveforms
- alias: num_samples
range: numeric
required: false required: false
waveforms_index: waveforms_index:
name: waveforms_index name: waveforms_index
@ -407,18 +438,6 @@ classes:
range: string range: string
required: true required: true
equals_string: obs_intervals_index equals_string: obs_intervals_index
Units__obs_intervals:
name: Units__obs_intervals
description: Observation intervals for each unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(obs_intervals)
identifier: true
range: string
required: true
equals_string: obs_intervals
Units__electrodes_index: Units__electrodes_index:
name: Units__electrodes_index name: Units__electrodes_index
description: Index into electrodes. description: Index into electrodes.
@ -443,88 +462,6 @@ classes:
range: string range: string
required: true required: true
equals_string: electrodes equals_string: electrodes
Units__waveform_mean:
name: Units__waveform_mean
description: Spike waveform mean for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveform_sd:
name: Units__waveform_sd
description: Spike waveform standard deviation for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveforms:
name: Units__waveforms
description: Individual waveforms for each spike on each electrode. This is a
doubly indexed column. The 'waveforms_index' column indexes which waveforms
in this column belong to the same spike event for a given unit, where each waveform
was recorded from a different electrode. The 'waveforms_index_index' column
indexes the 'waveforms_index' column to indicate which spike events belong to
a given unit. For example, if the 'waveforms_index_index' column has values
[2, 5, 6], then the first 2 elements of the 'waveforms_index' column correspond
to the 2 spike events of the first unit, the next 3 elements of the 'waveforms_index'
column correspond to the 3 spike events of the second unit, and the next 1 element
of the 'waveforms_index' column corresponds to the 1 spike event of the third
unit. If the 'waveforms_index' column has values [3, 6, 8, 10, 12, 13], then
the first 3 elements of the 'waveforms' column contain the 3 spike waveforms
that were recorded from 3 different electrodes for the first spike time of the
first unit. See https://nwb-schema.readthedocs.io/en/stable/format_description.html#doubly-ragged-arrays
for a graphical representation of this example. When there is only one electrode
for each unit (i.e., each spike time is associated with a single waveform),
then the 'waveforms_index' column will have values 1, 2, ..., N, where N is
the number of spike events. The number of electrodes for each spike event should
be the same within a given unit. The 'electrodes' column should be used to indicate
which electrodes are associated with each unit, and the order of the waveforms
within a given unit x spike event should be in the same order as the electrodes
referenced in the 'electrodes' column of this table. The number of samples for
each waveform must be the same.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveforms)
identifier: true
range: string
required: true
equals_string: waveforms
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveforms_index: Units__waveforms_index:
name: Units__waveforms_index name: Units__waveforms_index
description: Index into the waveforms dataset. One value for every spike event. description: Index into the waveforms dataset. One value for every spike event.

View file

@ -1,4 +1,11 @@
name: core.nwb.ogen name: core.nwb.ogen
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ogen id: core.nwb.ogen
version: 2.3.0 version: 2.3.0
imports: imports:
@ -20,7 +27,10 @@ classes:
data: data:
name: data name: data
description: Applied power for optogenetic stimulus, in watts. description: Applied power for optogenetic stimulus, in watts.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: numeric range: numeric
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.ophys name: core.nwb.ophys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ophys id: core.nwb.ophys
version: 2.3.0 version: 2.3.0
imports: imports:
@ -33,39 +40,18 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: TwoPhotonSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width|height
exact_cardinality: 2
- array:
dimensions:
- alias: width|height|depth
exact_cardinality: 3
tree_root: true tree_root: true
TwoPhotonSeries__field_of_view:
name: TwoPhotonSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: TwoPhotonSeries__field_of_view__Array
TwoPhotonSeries__field_of_view__Array:
name: TwoPhotonSeries__field_of_view__Array
is_a: Arraylike
attributes:
width|height:
name: width|height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width|height|depth:
name: width|height|depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
RoiResponseSeries: RoiResponseSeries:
name: RoiResponseSeries name: RoiResponseSeries
description: ROI responses over an imaging plane. The first dimension represents description: ROI responses over an imaging plane. The first dimension represents
@ -81,8 +67,16 @@ classes:
name: data name: data
description: Signals from ROIs. description: Signals from ROIs.
multivalued: false multivalued: false
range: RoiResponseSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_ROIs
rois: rois:
name: rois name: rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -91,32 +85,6 @@ classes:
range: RoiResponseSeries__rois range: RoiResponseSeries__rois
required: true required: true
tree_root: true tree_root: true
RoiResponseSeries__data:
name: RoiResponseSeries__data
description: Signals from ROIs.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: RoiResponseSeries__data__Array
RoiResponseSeries__data__Array:
name: RoiResponseSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_ROIs:
name: num_ROIs
range: numeric
required: false
RoiResponseSeries__rois: RoiResponseSeries__rois:
name: RoiResponseSeries__rois name: RoiResponseSeries__rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -137,12 +105,13 @@ classes:
for image planes). for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
Fluorescence: Fluorescence:
name: Fluorescence name: Fluorescence
@ -151,12 +120,13 @@ classes:
for ROIs and for image planes). for ROIs and for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
ImageSegmentation: ImageSegmentation:
name: ImageSegmentation name: ImageSegmentation
@ -169,12 +139,13 @@ classes:
is required and ROI names should remain consistent between them. is required and ROI names should remain consistent between them.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: PlaneSegmentation any_of:
- range: PlaneSegmentation
tree_root: true tree_root: true
PlaneSegmentation: PlaneSegmentation:
name: PlaneSegmentation name: PlaneSegmentation
@ -191,8 +162,20 @@ classes:
description: ROI masks for each ROI. Each image mask is the size of the original description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero. imaging plane (or volume) and members of the ROI are finite non-zero.
multivalued: false multivalued: false
range: PlaneSegmentation__image_mask range: AnyType
required: false required: false
any_of:
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- alias: num_z
pixel_mask_index: pixel_mask_index:
name: pixel_mask_index name: pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -228,19 +211,6 @@ classes:
any_of: any_of:
- range: ImageSeries - range: ImageSeries
tree_root: true tree_root: true
PlaneSegmentation__image_mask:
name: PlaneSegmentation__image_mask
description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(image_mask)
identifier: true
range: string
required: true
equals_string: image_mask
PlaneSegmentation__pixel_mask_index: PlaneSegmentation__pixel_mask_index:
name: PlaneSegmentation__pixel_mask_index name: PlaneSegmentation__pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -270,12 +240,13 @@ classes:
description: An imaging plane and its metadata. description: An imaging plane and its metadata.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: OpticalChannel any_of:
- range: OpticalChannel
tree_root: true tree_root: true
OpticalChannel: OpticalChannel:
name: OpticalChannel name: OpticalChannel
@ -307,12 +278,13 @@ classes:
frame at each point in time is assumed to be 2-D (has only x & y dimensions).' frame at each point in time is assumed to be 2-D (has only x & y dimensions).'
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: CorrectedImageStack any_of:
- range: CorrectedImageStack
tree_root: true tree_root: true
CorrectedImageStack: CorrectedImageStack:
name: CorrectedImageStack name: CorrectedImageStack

View file

@ -1,4 +1,11 @@
name: core.nwb.retinotopy name: core.nwb.retinotopy
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.retinotopy id: core.nwb.retinotopy
version: 2.3.0 version: 2.3.0
imports: imports:
@ -55,7 +62,11 @@ classes:
description: Two-element array describing the contents of the two response description: Two-element array describing the contents of the two response
axis fields. Description should be something like ['altitude', 'azimuth'] axis fields. Description should be something like ['altitude', 'azimuth']
or '['radius', 'theta']. or '['radius', 'theta'].
multivalued: true multivalued: false
array:
dimensions:
- alias: axis_1, axis_2
exact_cardinality: 2
range: text range: text
required: true required: true
focal_depth_image: focal_depth_image:
@ -106,19 +117,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_phase_map__Array array:
ImagingRetinotopy__axis_1_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_1_power_map: ImagingRetinotopy__axis_1_power_map:
name: ImagingRetinotopy__axis_1_power_map name: ImagingRetinotopy__axis_1_power_map
description: Power response on the first measured axis. Response is scaled so description: Power response on the first measured axis. Response is scaled so
@ -146,19 +149,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_power_map__Array array:
ImagingRetinotopy__axis_1_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_phase_map: ImagingRetinotopy__axis_2_phase_map:
name: ImagingRetinotopy__axis_2_phase_map name: ImagingRetinotopy__axis_2_phase_map
description: Phase response to stimulus on the second measured axis. description: Phase response to stimulus on the second measured axis.
@ -185,19 +180,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_phase_map__Array array:
ImagingRetinotopy__axis_2_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_power_map: ImagingRetinotopy__axis_2_power_map:
name: ImagingRetinotopy__axis_2_power_map name: ImagingRetinotopy__axis_2_power_map
description: Power response on the second measured axis. Response is scaled so description: Power response on the second measured axis. Response is scaled so
@ -225,19 +212,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_power_map__Array array:
ImagingRetinotopy__axis_2_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__focal_depth_image: ImagingRetinotopy__focal_depth_image:
name: ImagingRetinotopy__focal_depth_image name: ImagingRetinotopy__focal_depth_image
description: 'Gray-scale image taken with same settings/parameters (e.g., focal description: 'Gray-scale image taken with same settings/parameters (e.g., focal
@ -274,19 +253,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__focal_depth_image__Array array:
ImagingRetinotopy__focal_depth_image__Array: dimensions:
name: ImagingRetinotopy__focal_depth_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true
ImagingRetinotopy__sign_map: ImagingRetinotopy__sign_map:
name: ImagingRetinotopy__sign_map name: ImagingRetinotopy__sign_map
description: Sine of the angle between the direction of the gradient in axis_1 description: Sine of the angle between the direction of the gradient in axis_1
@ -310,19 +281,11 @@ classes:
range: float32 range: float32
array: array:
name: array name: array
range: ImagingRetinotopy__sign_map__Array array:
ImagingRetinotopy__sign_map__Array: dimensions:
name: ImagingRetinotopy__sign_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__vasculature_image: ImagingRetinotopy__vasculature_image:
name: ImagingRetinotopy__vasculature_image name: ImagingRetinotopy__vasculature_image
description: 'Gray-scale anatomical image of cortical surface. Array structure: description: 'Gray-scale anatomical image of cortical surface. Array structure:
@ -355,16 +318,8 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__vasculature_image__Array array:
ImagingRetinotopy__vasculature_image__Array: dimensions:
name: ImagingRetinotopy__vasculature_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true

View file

@ -1,8 +1,11 @@
name: core name: core
annotations: annotations:
is_namespace:
tag: is_namespace
value: true
namespace: namespace:
tag: namespace tag: namespace
value: 'True' value: core
description: NWB namespace description: NWB namespace
id: core id: core
version: 2.3.0 version: 2.3.0

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.4.0 version: 2.4.0
imports: imports:
@ -53,32 +60,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -144,7 +144,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -152,7 +155,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -160,7 +166,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -227,27 +236,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -294,13 +302,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.4.0 version: 2.4.0
imports: imports:
@ -59,19 +66,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -88,12 +91,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -101,12 +105,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -114,36 +119,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -154,22 +162,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.device name: core.nwb.device
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.device id: core.nwb.device
version: 2.4.0 version: 2.4.0
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.ecephys name: core.nwb.ecephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ecephys id: core.nwb.ecephys
version: 2.4.0 version: 2.4.0
imports: imports:
@ -35,8 +42,21 @@ classes:
name: data name: data
description: Recorded voltage data. description: Recorded voltage data.
multivalued: false multivalued: false
range: ElectricalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_channels
- array:
dimensions:
- alias: num_times
- alias: num_channels
- alias: num_samples
electrodes: electrodes:
name: electrodes name: electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -55,47 +75,13 @@ classes:
as native values generated by data acquisition systems. If this dataset as native values generated by data acquisition systems. If this dataset
is not present, then there is no channel-specific conversion factor, i.e. is not present, then there is no channel-specific conversion factor, i.e.
it is 1 for all channels. it is 1 for all channels.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_channels
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
ElectricalSeries__data:
name: ElectricalSeries__data
description: Recorded voltage data.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. This value
is fixed to 'volts'. Actual stored values are not necessarily stored in
these units. To access the data in these units, multiply 'data' by 'conversion'
and 'channel_conversion' (if present).
range: text
array:
name: array
range: ElectricalSeries__data__Array
ElectricalSeries__data__Array:
name: ElectricalSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
num_samples:
name: num_samples
range: numeric
required: false
ElectricalSeries__electrodes: ElectricalSeries__electrodes:
name: ElectricalSeries__electrodes name: ElectricalSeries__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -130,52 +116,31 @@ classes:
name: data name: data
description: Spike waveforms. description: Spike waveforms.
multivalued: false multivalued: false
range: SpikeEventSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_events
- alias: num_samples
- array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_samples
timestamps: timestamps:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
Timestamps are required for the events. Unlike for TimeSeries, timestamps Timestamps are required for the events. Unlike for TimeSeries, timestamps
are required for SpikeEventSeries and are thus re-specified here. are required for SpikeEventSeries and are thus re-specified here.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
SpikeEventSeries__data:
name: SpikeEventSeries__data
description: Spike waveforms.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Unit of measurement for waveforms, which is fixed to 'volts'.
range: text
array:
name: array
range: SpikeEventSeries__data__Array
SpikeEventSeries__data__Array:
name: SpikeEventSeries__data__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: numeric
required: true
num_samples:
name: num_samples
range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: false
FeatureExtraction: FeatureExtraction:
name: FeatureExtraction name: FeatureExtraction
description: Features, such as PC1 and PC2, that are extracted from signals stored description: Features, such as PC1 and PC2, that are extracted from signals stored
@ -191,19 +156,30 @@ classes:
name: description name: description
description: Description of features (eg, ''PC1'') for each of the extracted description: Description of features (eg, ''PC1'') for each of the extracted
features. features.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
features: features:
name: features name: features
description: Multi-dimensional array of features extracted from each event. description: Multi-dimensional array of features extracted from each event.
multivalued: false multivalued: false
range: FeatureExtraction__features array:
dimensions:
- alias: num_events
- alias: num_channels
- alias: num_features
range: float32
required: true required: true
times: times:
name: times name: times
description: Times of events that features correspond to (can be a link). description: Times of events that features correspond to (can be a link).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
electrodes: electrodes:
@ -214,36 +190,6 @@ classes:
range: FeatureExtraction__electrodes range: FeatureExtraction__electrodes
required: true required: true
tree_root: true tree_root: true
FeatureExtraction__features:
name: FeatureExtraction__features
description: Multi-dimensional array of features extracted from each event.
attributes:
name:
name: name
ifabsent: string(features)
identifier: true
range: string
required: true
equals_string: features
array:
name: array
range: FeatureExtraction__features__Array
FeatureExtraction__features__Array:
name: FeatureExtraction__features__Array
is_a: Arraylike
attributes:
num_events:
name: num_events
range: float32
required: true
num_channels:
name: num_channels
range: float32
required: true
num_features:
name: num_features
range: float32
required: true
FeatureExtraction__electrodes: FeatureExtraction__electrodes:
name: FeatureExtraction__electrodes name: FeatureExtraction__electrodes
description: DynamicTableRegion pointer to the electrodes that this time series description: DynamicTableRegion pointer to the electrodes that this time series
@ -280,13 +226,19 @@ classes:
corresponding to time of event. ''description'' should define what is meant corresponding to time of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing by time of event (e.g., .25 ms before action potential peak, zero-crossing
time, etc). The index points to each event from the raw data. time, etc). The index points to each event from the raw data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
times: times:
name: times name: times
description: Timestamps of events, in seconds. description: Timestamps of events, in seconds.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true
@ -297,12 +249,13 @@ classes:
during experiment acquisition. during experiment acquisition.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpikeEventSeries any_of:
- range: SpikeEventSeries
tree_root: true tree_root: true
FilteredEphys: FilteredEphys:
name: FilteredEphys name: FilteredEphys
@ -319,12 +272,13 @@ classes:
the ElectricalSeries 'filtering' attribute. the ElectricalSeries 'filtering' attribute.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
LFP: LFP:
name: LFP name: LFP
@ -333,12 +287,13 @@ classes:
properties should be noted in the ElectricalSeries 'filtering' attribute. properties should be noted in the ElectricalSeries 'filtering' attribute.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: ElectricalSeries any_of:
- range: ElectricalSeries
tree_root: true tree_root: true
ElectrodeGroup: ElectrodeGroup:
name: ElectrodeGroup name: ElectrodeGroup
@ -395,72 +350,24 @@ classes:
3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence
should be empty (e.g., zero- filled) should be empty (e.g., zero- filled)
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_mean array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as description: Stdev of waveforms for each cluster, using the same indices as
in mean in mean
multivalued: false multivalued: false
range: ClusterWaveforms__waveform_sd array:
dimensions:
- alias: num_clusters
- alias: num_samples
range: float32
required: true required: true
tree_root: true tree_root: true
ClusterWaveforms__waveform_mean:
name: ClusterWaveforms__waveform_mean
description: The mean waveform for each cluster, using the same indices for each
wave as cluster numbers in the associated Clustering module (i.e, cluster 3
is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should
be empty (e.g., zero- filled)
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
array:
name: array
range: ClusterWaveforms__waveform_mean__Array
ClusterWaveforms__waveform_mean__Array:
name: ClusterWaveforms__waveform_mean__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
ClusterWaveforms__waveform_sd:
name: ClusterWaveforms__waveform_sd
description: Stdev of waveforms for each cluster, using the same indices as in
mean
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
array:
name: array
range: ClusterWaveforms__waveform_sd__Array
ClusterWaveforms__waveform_sd__Array:
name: ClusterWaveforms__waveform_sd__Array
is_a: Arraylike
attributes:
num_clusters:
name: num_clusters
range: float32
required: true
num_samples:
name: num_samples
range: float32
required: true
Clustering: Clustering:
name: Clustering name: Clustering
description: DEPRECATED Clustered spike data, whether from automatic clustering description: DEPRECATED Clustered spike data, whether from automatic clustering
@ -482,21 +389,30 @@ classes:
num: num:
name: num name: num
description: Cluster number of each event description: Cluster number of each event
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: int32 range: int32
required: true required: true
peak_over_rms: peak_over_rms:
name: peak_over_rms name: peak_over_rms
description: Maximum ratio of waveform peak to RMS on any channel in the cluster description: Maximum ratio of waveform peak to RMS on any channel in the cluster
(provides a basic clustering metric). (provides a basic clustering metric).
multivalued: true multivalued: false
array:
dimensions:
- alias: num_clusters
range: float32 range: float32
required: true required: true
times: times:
name: times name: times
description: Times of clustered events, in seconds. This may be a link to description: Times of clustered events, in seconds. This may be a link to
times field in associated FeatureExtraction module. times field in associated FeatureExtraction module.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_events
range: float64 range: float64
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.epoch name: core.nwb.epoch
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.epoch id: core.nwb.epoch
version: 2.4.0 version: 2.4.0
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.file name: core.nwb.file
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.file id: core.nwb.file
version: 2.4.0 version: 2.4.0
imports: imports:
@ -56,7 +63,10 @@ classes:
The file can be created after the experiment was run, so this may differ The file can be created after the experiment was run, so this may differ
from the experiment start time. Each modification to the nwb file adds a from the experiment start time. Each modification to the nwb file adds a
new entry to the array.' new entry to the array.'
multivalued: true multivalued: false
array:
dimensions:
- alias: num_modifications
range: isodatetime range: isodatetime
required: true required: true
identifier: identifier:
@ -198,9 +208,14 @@ classes:
having a particular scientific goal, trials (see trials subgroup) during having a particular scientific goal, trials (see trials subgroup) during
an experiment, or epochs (see epochs subgroup) deriving from analysis of an experiment, or epochs (see epochs subgroup) deriving from analysis of
data. data.
multivalued: false multivalued: true
range: NWBFile__intervals inlined: true
required: false inlined_as_list: false
any_of:
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
- range: TimeIntervals
units: units:
name: units name: units
description: Data about sorted spike units. description: Data about sorted spike units.
@ -289,7 +304,10 @@ classes:
name: experimenter name: experimenter
description: Name of person(s) who performed the experiment. Can also specify description: Name of person(s) who performed the experiment. Can also specify
roles of different people involved. roles of different people involved.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_experimenters
range: text range: text
required: false required: false
institution: institution:
@ -301,7 +319,10 @@ classes:
keywords: keywords:
name: keywords name: keywords
description: Terms to search over. description: Terms to search over.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_keywords
range: text range: text
required: false required: false
lab: lab:
@ -333,7 +354,10 @@ classes:
related_publications: related_publications:
name: related_publications name: related_publications
description: Publication information. PMID, DOI, URL, etc. description: Publication information. PMID, DOI, URL, etc.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_publications
range: text range: text
required: false required: false
session_id: session_id:
@ -630,45 +654,6 @@ classes:
multivalued: false multivalued: false
range: ExperimentalConditionsTable range: ExperimentalConditionsTable
required: false required: false
NWBFile__intervals:
name: NWBFile__intervals
description: Experimental intervals, whether that be logically distinct sub-experiments
having a particular scientific goal, trials (see trials subgroup) during an
experiment, or epochs (see epochs subgroup) deriving from analysis of data.
attributes:
name:
name: name
ifabsent: string(intervals)
identifier: true
range: string
required: true
equals_string: intervals
epochs:
name: epochs
description: Divisions in time marking experimental stages or sub-divisions
of a single recording session.
multivalued: false
range: TimeIntervals
required: false
trials:
name: trials
description: Repeated experimental events that have a logical grouping.
multivalued: false
range: TimeIntervals
required: false
invalid_times:
name: invalid_times
description: Time intervals that should be removed from analysis.
multivalued: false
range: TimeIntervals
required: false
time_intervals:
name: time_intervals
description: Optional additional table(s) for describing other experimental
time intervals.
multivalued: true
range: TimeIntervals
required: false
LabMetaData: LabMetaData:
name: LabMetaData name: LabMetaData
description: Lab-specific meta-data. description: Lab-specific meta-data.

View file

@ -1,4 +1,11 @@
name: core.nwb.icephys name: core.nwb.icephys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.icephys id: core.nwb.icephys
version: 2.4.0 version: 2.4.0
imports: imports:
@ -30,8 +37,8 @@ classes:
data: data:
name: data name: data
description: Recorded voltage or current. description: Recorded voltage or current.
multivalued: true multivalued: false
range: numeric range: PatchClampSeries__data
required: true required: true
gain: gain:
name: gain name: gain
@ -41,6 +48,29 @@ classes:
range: float32 range: float32
required: false required: false
tree_root: true tree_root: true
PatchClampSeries__data:
name: PatchClampSeries__data
description: Recorded voltage or current.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
unit:
name: unit
description: Base unit of measurement for working with the data. Actual stored
values are not necessarily stored in these units. To access the data in
these units, multiply 'data' by 'conversion'.
range: text
array:
name: array
array:
dimensions:
- alias: num_times
range: numeric
CurrentClampSeries: CurrentClampSeries:
name: CurrentClampSeries name: CurrentClampSeries
description: Voltage data from an intracellular current-clamp recording. A corresponding description: Voltage data from an intracellular current-clamp recording. A corresponding

View file

@ -1,4 +1,11 @@
name: core.nwb.image name: core.nwb.image
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.image id: core.nwb.image
version: 2.4.0 version: 2.4.0
imports: imports:
@ -17,22 +24,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: GrayscaleImage__Array
tree_root: true tree_root: true
GrayscaleImage__Array:
name: GrayscaleImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
RGBImage: RGBImage:
name: RGBImage name: RGBImage
description: A color image. description: A color image.
@ -43,28 +35,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBImage__Array
tree_root: true tree_root: true
RGBImage__Array:
name: RGBImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: true
minimum_cardinality: 3
maximum_cardinality: 3
RGBAImage: RGBAImage:
name: RGBAImage name: RGBAImage
description: A color image with transparency. description: A color image with transparency.
@ -75,28 +46,7 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array:
name: array
range: RGBAImage__Array
tree_root: true tree_root: true
RGBAImage__Array:
name: RGBAImage__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b, a:
name: r, g, b, a
range: numeric
required: true
minimum_cardinality: 4
maximum_cardinality: 4
ImageSeries: ImageSeries:
name: ImageSeries name: ImageSeries
description: General image data that is common between acquisition and stimulus description: General image data that is common between acquisition and stimulus
@ -117,12 +67,27 @@ classes:
description: Binary data representing images across frames. If data are stored description: Binary data representing images across frames. If data are stored
in an external file, this should be an empty 3D array. in an external file, this should be an empty 3D array.
multivalued: false multivalued: false
range: ImageSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: z
dimension: dimension:
name: dimension name: dimension
description: Number of pixels on x, y, (and z) axes. description: Number of pixels on x, y, (and z) axes.
multivalued: true multivalued: false
array:
dimensions:
- alias: rank
range: int32 range: int32
required: false required: false
external_file: external_file:
@ -132,8 +97,8 @@ classes:
in the file system as one or more image file(s). This field should NOT be in the file system as one or more image file(s). This field should NOT be
used if the image is stored in another NWB file and that file is linked used if the image is stored in another NWB file and that file is linked
to this file. to this file.
multivalued: true multivalued: false
range: text range: ImageSeries__external_file
required: false required: false
format: format:
name: format name: format
@ -145,41 +110,41 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
ImageSeries__data: ImageSeries__external_file:
name: ImageSeries__data name: ImageSeries__external_file
description: Binary data representing images across frames. If data are stored description: Paths to one or more external file(s). The field is only present
in an external file, this should be an empty 3D array. if format='external'. This is only relevant if the image series is stored in
the file system as one or more image file(s). This field should NOT be used
if the image is stored in another NWB file and that file is linked to this file.
attributes: attributes:
name: name:
name: name name: name
ifabsent: string(data) ifabsent: string(external_file)
identifier: true identifier: true
range: string range: string
required: true required: true
equals_string: data equals_string: external_file
starting_frame:
name: starting_frame
description: Each external image may contain one or more consecutive frames
of the full ImageSeries. This attribute serves as an index to indicate which
frames each file contains, to faciliate random access. The 'starting_frame'
attribute, hence, contains a list of frame numbers within the full ImageSeries
of the first frame of each file listed in the parent 'external_file' dataset.
Zero-based indexing is used (hence, the first element will always be zero).
For example, if the 'external_file' dataset has three paths to files and
the first file has 5 frames, the second file has 10 frames, and the third
file has 20 frames, then this attribute will have values [0, 5, 15]. If
there is a single external file that holds all of the frames of the ImageSeries
(and so there is a single element in the 'external_file' dataset), then
this attribute should have value [0].
range: int32
array: array:
name: array name: array
range: ImageSeries__data__Array array:
ImageSeries__data__Array: dimensions:
name: ImageSeries__data__Array - alias: num_files
is_a: Arraylike range: text
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
z:
name: z
range: numeric
required: false
ImageMaskSeries: ImageMaskSeries:
name: ImageMaskSeries name: ImageMaskSeries
description: An alpha mask that is applied to a presented visual stimulus. The description: An alpha mask that is applied to a presented visual stimulus. The
@ -219,14 +184,36 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: OpticalSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width, height
exact_cardinality: 2
- array:
dimensions:
- alias: width, height, depth
exact_cardinality: 3
data: data:
name: data name: data
description: Images presented to subject, either grayscale or RGB description: Images presented to subject, either grayscale or RGB
multivalued: false multivalued: false
range: OpticalSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- array:
dimensions:
- alias: frame
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
orientation: orientation:
name: orientation name: orientation
description: Description of image relative to some reference frame (e.g., description: Description of image relative to some reference frame (e.g.,
@ -235,72 +222,6 @@ classes:
range: text range: text
required: false required: false
tree_root: true tree_root: true
OpticalSeries__field_of_view:
name: OpticalSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: OpticalSeries__field_of_view__Array
OpticalSeries__field_of_view__Array:
name: OpticalSeries__field_of_view__Array
is_a: Arraylike
attributes:
width, height:
name: width, height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width, height, depth:
name: width, height, depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
OpticalSeries__data:
name: OpticalSeries__data
description: Images presented to subject, either grayscale or RGB
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: OpticalSeries__data__Array
OpticalSeries__data__Array:
name: OpticalSeries__data__Array
is_a: Arraylike
attributes:
frame:
name: frame
range: numeric
required: true
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
IndexSeries: IndexSeries:
name: IndexSeries name: IndexSeries
description: Stores indices to image frames stored in an ImageSeries. The purpose description: Stores indices to image frames stored in an ImageSeries. The purpose
@ -319,7 +240,10 @@ classes:
data: data:
name: data name: data
description: Index of the frame in the referenced ImageSeries. description: Index of the frame in the referenced ImageSeries.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int32 range: int32
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.language name: core.nwb.language
annotations:
is_namespace:
tag: is_namespace
value: 'False'
namespace:
tag: namespace
value: core
description: Adapter objects to mimic the behavior of elements in the nwb-schema-language description: Adapter objects to mimic the behavior of elements in the nwb-schema-language
id: nwb.language id: nwb.language
imports: imports:

View file

@ -1,4 +1,11 @@
name: core.nwb.misc name: core.nwb.misc
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.misc id: core.nwb.misc
version: 2.4.0 version: 2.4.0
imports: imports:
@ -35,13 +42,19 @@ classes:
feature_units: feature_units:
name: feature_units name: feature_units
description: Units of each feature. description: Units of each feature.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: false required: false
features: features:
name: features name: features
description: Description of the features represented in TimeSeries::data. description: Description of the features represented in TimeSeries::data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_features
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -64,19 +77,15 @@ classes:
range: text range: text
array: array:
name: array name: array
range: AbstractFeatureSeries__data__Array
AbstractFeatureSeries__data__Array:
name: AbstractFeatureSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
num_features: - array:
name: num_features dimensions:
range: numeric - alias: num_times
required: false - array:
dimensions:
- alias: num_times
- alias: num_features
AnnotationSeries: AnnotationSeries:
name: AnnotationSeries name: AnnotationSeries
description: Stores user annotations made during an experiment. The data[] field description: Stores user annotations made during an experiment. The data[] field
@ -93,7 +102,10 @@ classes:
data: data:
name: data name: data
description: Annotations made during an experiment. description: Annotations made during an experiment.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: text range: text
required: true required: true
tree_root: true tree_root: true
@ -116,7 +128,10 @@ classes:
data: data:
name: data name: data
description: Use values >0 if interval started, <0 if interval ended. description: Use values >0 if interval started, <0 if interval ended.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: int8 range: int8
required: true required: true
tree_root: true tree_root: true
@ -176,23 +191,12 @@ classes:
range: text range: text
array: array:
name: array name: array
range: DecompositionSeries__data__Array array:
DecompositionSeries__data__Array: dimensions:
name: DecompositionSeries__data__Array - alias: num_times
is_a: Arraylike - alias: num_channels
attributes: - alias: num_bands
num_times:
name: num_times
range: numeric range: numeric
required: true
num_channels:
name: num_channels
range: numeric
required: true
num_bands:
name: num_bands
range: numeric
required: true
DecompositionSeries__source_channels: DecompositionSeries__source_channels:
name: DecompositionSeries__source_channels name: DecompositionSeries__source_channels
description: DynamicTableRegion pointer to the channels that this decomposition description: DynamicTableRegion pointer to the channels that this decomposition
@ -229,33 +233,31 @@ classes:
description: Low and high limit of each band in Hz. If it is a Gaussian filter, description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center. use 2 SD on either side of the center.
multivalued: false multivalued: false
range: DecompositionSeries__bands__band_limits array:
dimensions:
- alias: num_bands
- alias: low, high
exact_cardinality: 2
range: float32
required: true required: true
band_mean: band_mean:
name: band_mean name: band_mean
description: The mean Gaussian filters, in Hz. description: The mean Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
band_stdev: band_stdev:
name: band_stdev name: band_stdev
description: The standard deviation of Gaussian filters, in Hz. description: The standard deviation of Gaussian filters, in Hz.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_bands
range: float32 range: float32
required: true required: true
DecompositionSeries__bands__band_limits:
name: DecompositionSeries__bands__band_limits
description: Low and high limit of each band in Hz. If it is a Gaussian filter,
use 2 SD on either side of the center.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(band_limits)
identifier: true
range: string
required: true
equals_string: band_limits
Units: Units:
name: Units name: Units
description: Data about spiking units. Event times of observed units (e.g. cell, description: Data about spiking units. Event times of observed units (e.g. cell,
@ -289,7 +291,12 @@ classes:
name: obs_intervals name: obs_intervals
description: Observation intervals for each unit. description: Observation intervals for each unit.
multivalued: false multivalued: false
range: Units__obs_intervals array:
dimensions:
- alias: num_intervals
- alias: start|end
exact_cardinality: 2
range: float64
required: false required: false
electrodes_index: electrodes_index:
name: electrodes_index name: electrodes_index
@ -312,14 +319,34 @@ classes:
name: waveform_mean name: waveform_mean
description: Spike waveform mean for each spike unit. description: Spike waveform mean for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_mean range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveform_sd: waveform_sd:
name: waveform_sd name: waveform_sd
description: Spike waveform standard deviation for each spike unit. description: Spike waveform standard deviation for each spike unit.
multivalued: false multivalued: false
range: Units__waveform_sd range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: num_units
- alias: num_samples
- array:
dimensions:
- alias: num_units
- alias: num_samples
- alias: num_electrodes
waveforms: waveforms:
name: waveforms name: waveforms
description: Individual waveforms for each spike on each electrode. This is description: Individual waveforms for each spike on each electrode. This is
@ -346,7 +373,11 @@ classes:
same order as the electrodes referenced in the 'electrodes' column of this same order as the electrodes referenced in the 'electrodes' column of this
table. The number of samples for each waveform must be the same. table. The number of samples for each waveform must be the same.
multivalued: false multivalued: false
range: Units__waveforms array:
dimensions:
- alias: num_waveforms
- alias: num_samples
range: numeric
required: false required: false
waveforms_index: waveforms_index:
name: waveforms_index name: waveforms_index
@ -407,18 +438,6 @@ classes:
range: string range: string
required: true required: true
equals_string: obs_intervals_index equals_string: obs_intervals_index
Units__obs_intervals:
name: Units__obs_intervals
description: Observation intervals for each unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(obs_intervals)
identifier: true
range: string
required: true
equals_string: obs_intervals
Units__electrodes_index: Units__electrodes_index:
name: Units__electrodes_index name: Units__electrodes_index
description: Index into electrodes. description: Index into electrodes.
@ -443,88 +462,6 @@ classes:
range: string range: string
required: true required: true
equals_string: electrodes equals_string: electrodes
Units__waveform_mean:
name: Units__waveform_mean
description: Spike waveform mean for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_mean)
identifier: true
range: string
required: true
equals_string: waveform_mean
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveform_sd:
name: Units__waveform_sd
description: Spike waveform standard deviation for each spike unit.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveform_sd)
identifier: true
range: string
required: true
equals_string: waveform_sd
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveforms:
name: Units__waveforms
description: Individual waveforms for each spike on each electrode. This is a
doubly indexed column. The 'waveforms_index' column indexes which waveforms
in this column belong to the same spike event for a given unit, where each waveform
was recorded from a different electrode. The 'waveforms_index_index' column
indexes the 'waveforms_index' column to indicate which spike events belong to
a given unit. For example, if the 'waveforms_index_index' column has values
[2, 5, 6], then the first 2 elements of the 'waveforms_index' column correspond
to the 2 spike events of the first unit, the next 3 elements of the 'waveforms_index'
column correspond to the 3 spike events of the second unit, and the next 1 element
of the 'waveforms_index' column corresponds to the 1 spike event of the third
unit. If the 'waveforms_index' column has values [3, 6, 8, 10, 12, 13], then
the first 3 elements of the 'waveforms' column contain the 3 spike waveforms
that were recorded from 3 different electrodes for the first spike time of the
first unit. See https://nwb-schema.readthedocs.io/en/stable/format_description.html#doubly-ragged-arrays
for a graphical representation of this example. When there is only one electrode
for each unit (i.e., each spike time is associated with a single waveform),
then the 'waveforms_index' column will have values 1, 2, ..., N, where N is
the number of spike events. The number of electrodes for each spike event should
be the same within a given unit. The 'electrodes' column should be used to indicate
which electrodes are associated with each unit, and the order of the waveforms
within a given unit x spike event should be in the same order as the electrodes
referenced in the 'electrodes' column of this table. The number of samples for
each waveform must be the same.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(waveforms)
identifier: true
range: string
required: true
equals_string: waveforms
sampling_rate:
name: sampling_rate
description: Sampling rate, in hertz.
range: float32
unit:
name: unit
description: Unit of measurement. This value is fixed to 'volts'.
range: text
Units__waveforms_index: Units__waveforms_index:
name: Units__waveforms_index name: Units__waveforms_index
description: Index into the waveforms dataset. One value for every spike event. description: Index into the waveforms dataset. One value for every spike event.

View file

@ -1,4 +1,11 @@
name: core.nwb.ogen name: core.nwb.ogen
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ogen id: core.nwb.ogen
version: 2.4.0 version: 2.4.0
imports: imports:
@ -20,7 +27,10 @@ classes:
data: data:
name: data name: data
description: Applied power for optogenetic stimulus, in watts. description: Applied power for optogenetic stimulus, in watts.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: numeric range: numeric
required: true required: true
tree_root: true tree_root: true

View file

@ -1,4 +1,11 @@
name: core.nwb.ophys name: core.nwb.ophys
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.ophys id: core.nwb.ophys
version: 2.4.0 version: 2.4.0
imports: imports:
@ -33,39 +40,18 @@ classes:
name: field_of_view name: field_of_view
description: Width, height and depth of image, or imaged area, in meters. description: Width, height and depth of image, or imaged area, in meters.
multivalued: false multivalued: false
range: TwoPhotonSeries__field_of_view range: float32
required: false required: false
any_of:
- array:
dimensions:
- alias: width|height
exact_cardinality: 2
- array:
dimensions:
- alias: width|height|depth
exact_cardinality: 3
tree_root: true tree_root: true
TwoPhotonSeries__field_of_view:
name: TwoPhotonSeries__field_of_view
description: Width, height and depth of image, or imaged area, in meters.
attributes:
name:
name: name
ifabsent: string(field_of_view)
identifier: true
range: string
required: true
equals_string: field_of_view
array:
name: array
range: TwoPhotonSeries__field_of_view__Array
TwoPhotonSeries__field_of_view__Array:
name: TwoPhotonSeries__field_of_view__Array
is_a: Arraylike
attributes:
width|height:
name: width|height
range: float32
required: false
minimum_cardinality: 2
maximum_cardinality: 2
width|height|depth:
name: width|height|depth
range: float32
required: false
minimum_cardinality: 3
maximum_cardinality: 3
RoiResponseSeries: RoiResponseSeries:
name: RoiResponseSeries name: RoiResponseSeries
description: ROI responses over an imaging plane. The first dimension represents description: ROI responses over an imaging plane. The first dimension represents
@ -81,8 +67,16 @@ classes:
name: data name: data
description: Signals from ROIs. description: Signals from ROIs.
multivalued: false multivalued: false
range: RoiResponseSeries__data range: numeric
required: true required: true
any_of:
- array:
dimensions:
- alias: num_times
- array:
dimensions:
- alias: num_times
- alias: num_ROIs
rois: rois:
name: rois name: rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -91,32 +85,6 @@ classes:
range: RoiResponseSeries__rois range: RoiResponseSeries__rois
required: true required: true
tree_root: true tree_root: true
RoiResponseSeries__data:
name: RoiResponseSeries__data
description: Signals from ROIs.
attributes:
name:
name: name
ifabsent: string(data)
identifier: true
range: string
required: true
equals_string: data
array:
name: array
range: RoiResponseSeries__data__Array
RoiResponseSeries__data__Array:
name: RoiResponseSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric
required: true
num_ROIs:
name: num_ROIs
range: numeric
required: false
RoiResponseSeries__rois: RoiResponseSeries__rois:
name: RoiResponseSeries__rois name: RoiResponseSeries__rois
description: DynamicTableRegion referencing into an ROITable containing information description: DynamicTableRegion referencing into an ROITable containing information
@ -137,12 +105,13 @@ classes:
for image planes). for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
Fluorescence: Fluorescence:
name: Fluorescence name: Fluorescence
@ -151,12 +120,13 @@ classes:
for ROIs and for image planes). for ROIs and for image planes).
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: RoiResponseSeries any_of:
- range: RoiResponseSeries
tree_root: true tree_root: true
ImageSegmentation: ImageSegmentation:
name: ImageSegmentation name: ImageSegmentation
@ -169,12 +139,13 @@ classes:
is required and ROI names should remain consistent between them. is required and ROI names should remain consistent between them.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: PlaneSegmentation any_of:
- range: PlaneSegmentation
tree_root: true tree_root: true
PlaneSegmentation: PlaneSegmentation:
name: PlaneSegmentation name: PlaneSegmentation
@ -191,8 +162,20 @@ classes:
description: ROI masks for each ROI. Each image mask is the size of the original description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero. imaging plane (or volume) and members of the ROI are finite non-zero.
multivalued: false multivalued: false
range: PlaneSegmentation__image_mask range: AnyType
required: false required: false
any_of:
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- array:
dimensions:
- alias: num_roi
- alias: num_x
- alias: num_y
- alias: num_z
pixel_mask_index: pixel_mask_index:
name: pixel_mask_index name: pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -228,19 +211,6 @@ classes:
any_of: any_of:
- range: ImageSeries - range: ImageSeries
tree_root: true tree_root: true
PlaneSegmentation__image_mask:
name: PlaneSegmentation__image_mask
description: ROI masks for each ROI. Each image mask is the size of the original
imaging plane (or volume) and members of the ROI are finite non-zero.
is_a: VectorData
attributes:
name:
name: name
ifabsent: string(image_mask)
identifier: true
range: string
required: true
equals_string: image_mask
PlaneSegmentation__pixel_mask_index: PlaneSegmentation__pixel_mask_index:
name: PlaneSegmentation__pixel_mask_index name: PlaneSegmentation__pixel_mask_index
description: Index into pixel_mask. description: Index into pixel_mask.
@ -270,12 +240,13 @@ classes:
description: An imaging plane and its metadata. description: An imaging plane and its metadata.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: OpticalChannel any_of:
- range: OpticalChannel
tree_root: true tree_root: true
OpticalChannel: OpticalChannel:
name: OpticalChannel name: OpticalChannel
@ -307,12 +278,13 @@ classes:
frame at each point in time is assumed to be 2-D (has only x & y dimensions).' frame at each point in time is assumed to be 2-D (has only x & y dimensions).'
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: CorrectedImageStack any_of:
- range: CorrectedImageStack
tree_root: true tree_root: true
CorrectedImageStack: CorrectedImageStack:
name: CorrectedImageStack name: CorrectedImageStack

View file

@ -1,4 +1,11 @@
name: core.nwb.retinotopy name: core.nwb.retinotopy
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.retinotopy id: core.nwb.retinotopy
version: 2.4.0 version: 2.4.0
imports: imports:
@ -55,7 +62,11 @@ classes:
description: Two-element array describing the contents of the two response description: Two-element array describing the contents of the two response
axis fields. Description should be something like ['altitude', 'azimuth'] axis fields. Description should be something like ['altitude', 'azimuth']
or '['radius', 'theta']. or '['radius', 'theta'].
multivalued: true multivalued: false
array:
dimensions:
- alias: axis_1, axis_2
exact_cardinality: 2
range: text range: text
required: true required: true
focal_depth_image: focal_depth_image:
@ -106,19 +117,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_phase_map__Array array:
ImagingRetinotopy__axis_1_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_1_power_map: ImagingRetinotopy__axis_1_power_map:
name: ImagingRetinotopy__axis_1_power_map name: ImagingRetinotopy__axis_1_power_map
description: Power response on the first measured axis. Response is scaled so description: Power response on the first measured axis. Response is scaled so
@ -146,19 +149,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_1_power_map__Array array:
ImagingRetinotopy__axis_1_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_1_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_phase_map: ImagingRetinotopy__axis_2_phase_map:
name: ImagingRetinotopy__axis_2_phase_map name: ImagingRetinotopy__axis_2_phase_map
description: Phase response to stimulus on the second measured axis. description: Phase response to stimulus on the second measured axis.
@ -185,19 +180,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_phase_map__Array array:
ImagingRetinotopy__axis_2_phase_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_phase_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__axis_2_power_map: ImagingRetinotopy__axis_2_power_map:
name: ImagingRetinotopy__axis_2_power_map name: ImagingRetinotopy__axis_2_power_map
description: Power response on the second measured axis. Response is scaled so description: Power response on the second measured axis. Response is scaled so
@ -225,19 +212,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__axis_2_power_map__Array array:
ImagingRetinotopy__axis_2_power_map__Array: dimensions:
name: ImagingRetinotopy__axis_2_power_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__focal_depth_image: ImagingRetinotopy__focal_depth_image:
name: ImagingRetinotopy__focal_depth_image name: ImagingRetinotopy__focal_depth_image
description: 'Gray-scale image taken with same settings/parameters (e.g., focal description: 'Gray-scale image taken with same settings/parameters (e.g., focal
@ -274,19 +253,11 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__focal_depth_image__Array array:
ImagingRetinotopy__focal_depth_image__Array: dimensions:
name: ImagingRetinotopy__focal_depth_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true
ImagingRetinotopy__sign_map: ImagingRetinotopy__sign_map:
name: ImagingRetinotopy__sign_map name: ImagingRetinotopy__sign_map
description: Sine of the angle between the direction of the gradient in axis_1 description: Sine of the angle between the direction of the gradient in axis_1
@ -310,19 +281,11 @@ classes:
range: float32 range: float32
array: array:
name: array name: array
range: ImagingRetinotopy__sign_map__Array array:
ImagingRetinotopy__sign_map__Array: dimensions:
name: ImagingRetinotopy__sign_map__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: float32 range: float32
required: true
num_cols:
name: num_cols
range: float32
required: true
ImagingRetinotopy__vasculature_image: ImagingRetinotopy__vasculature_image:
name: ImagingRetinotopy__vasculature_image name: ImagingRetinotopy__vasculature_image
description: 'Gray-scale anatomical image of cortical surface. Array structure: description: 'Gray-scale anatomical image of cortical surface. Array structure:
@ -355,16 +318,8 @@ classes:
range: text range: text
array: array:
name: array name: array
range: ImagingRetinotopy__vasculature_image__Array array:
ImagingRetinotopy__vasculature_image__Array: dimensions:
name: ImagingRetinotopy__vasculature_image__Array - alias: num_rows
is_a: Arraylike - alias: num_cols
attributes:
num_rows:
name: num_rows
range: uint16 range: uint16
required: true
num_cols:
name: num_cols
range: uint16
required: true

View file

@ -1,8 +1,11 @@
name: core name: core
annotations: annotations:
is_namespace:
tag: is_namespace
value: true
namespace: namespace:
tag: namespace tag: namespace
value: 'True' value: core
description: NWB namespace description: NWB namespace
id: core id: core
version: 2.4.0 version: 2.4.0

View file

@ -1,4 +1,11 @@
name: core.nwb.base name: core.nwb.base
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.base id: core.nwb.base
version: 2.5.0 version: 2.5.0
imports: imports:
@ -53,32 +60,25 @@ classes:
range: text range: text
array: array:
name: array name: array
range: Image__Array range: numeric
any_of:
- array:
dimensions:
- alias: x
- alias: y
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b
exact_cardinality: 3
- array:
dimensions:
- alias: x
- alias: y
- alias: r, g, b, a
exact_cardinality: 4
tree_root: true tree_root: true
Image__Array:
name: Image__Array
is_a: Arraylike
attributes:
x:
name: x
range: numeric
required: true
y:
name: y
range: numeric
required: true
r, g, b:
name: r, g, b
range: numeric
required: false
minimum_cardinality: 3
maximum_cardinality: 3
r, g, b, a:
name: r, g, b, a
range: numeric
required: false
minimum_cardinality: 4
maximum_cardinality: 4
ImageReferences: ImageReferences:
name: ImageReferences name: ImageReferences
description: Ordered dataset of references to Image objects. description: Ordered dataset of references to Image objects.
@ -89,18 +89,13 @@ classes:
identifier: true identifier: true
range: string range: string
required: true required: true
array: image:
name: array name: image
range: ImageReferences__Array description: Ordered dataset of references to Image objects.
tree_root: true multivalued: true
ImageReferences__Array:
name: ImageReferences__Array
is_a: Arraylike
attributes:
num_images:
name: num_images
range: Image range: Image
required: true required: true
tree_root: true
NWBContainer: NWBContainer:
name: NWBContainer name: NWBContainer
description: An abstract data type for a generic container storing collections description: An abstract data type for a generic container storing collections
@ -166,7 +161,10 @@ classes:
name: timestamps name: timestamps
description: Timestamps for samples stored in data, in seconds, relative to description: Timestamps for samples stored in data, in seconds, relative to
the common experiment master-clock stored in NWBFile.timestamps_reference_time. the common experiment master-clock stored in NWBFile.timestamps_reference_time.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: float64 range: float64
required: false required: false
control: control:
@ -174,7 +172,10 @@ classes:
description: Numerical labels that apply to each time point in data for the description: Numerical labels that apply to each time point in data for the
purpose of querying and slicing data by these values. If present, the length purpose of querying and slicing data by these values. If present, the length
of this array should be the same size as the first dimension of data. of this array should be the same size as the first dimension of data.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_times
range: uint8 range: uint8
required: false required: false
control_description: control_description:
@ -182,7 +183,10 @@ classes:
description: Description of each control value. Must be present if control description: Description of each control value. Must be present if control
is present. If present, control_description[0] should describe time points is present. If present, control_description[0] should describe time points
where control == 0. where control == 0.
multivalued: true multivalued: false
array:
dimensions:
- alias: num_control_values
range: text range: text
required: false required: false
sync: sync:
@ -257,27 +261,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: TimeSeries__data__Array
TimeSeries__data__Array:
name: TimeSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: AnyType range: AnyType
required: true any_of:
num_DIM2: - array:
name: num_DIM2 dimensions:
range: AnyType - alias: num_times
required: false - array:
num_DIM3: dimensions:
name: num_DIM3 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - array:
num_DIM4: dimensions:
name: num_DIM4 - alias: num_times
range: AnyType - alias: num_DIM2
required: false - alias: num_DIM3
- array:
dimensions:
- alias: num_times
- alias: num_DIM2
- alias: num_DIM3
- alias: num_DIM4
TimeSeries__starting_time: TimeSeries__starting_time:
name: TimeSeries__starting_time name: TimeSeries__starting_time
description: Timestamp of the first sample in seconds. When timestamps are uniformly description: Timestamp of the first sample in seconds. When timestamps are uniformly
@ -324,13 +327,14 @@ classes:
description: A collection of processed data. description: A collection of processed data.
is_a: NWBContainer is_a: NWBContainer
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: NWBDataInterface any_of:
- range: DynamicTable - range: NWBDataInterface
- range: DynamicTable
tree_root: true tree_root: true
Images: Images:
name: Images name: Images

View file

@ -1,4 +1,11 @@
name: core.nwb.behavior name: core.nwb.behavior
annotations:
is_namespace:
tag: is_namespace
value: false
namespace:
tag: namespace
value: core
id: core.nwb.behavior id: core.nwb.behavior
version: 2.5.0 version: 2.5.0
imports: imports:
@ -60,33 +67,26 @@ classes:
range: text range: text
array: array:
name: array name: array
range: SpatialSeries__data__Array
SpatialSeries__data__Array:
name: SpatialSeries__data__Array
is_a: Arraylike
attributes:
num_times:
name: num_times
range: numeric range: numeric
required: true any_of:
x: - array:
name: x dimensions:
range: numeric - alias: num_times
required: false - array:
minimum_cardinality: 1 dimensions:
maximum_cardinality: 1 - alias: num_times
x,y: - alias: x
name: x,y exact_cardinality: 1
range: numeric - array:
required: false dimensions:
minimum_cardinality: 2 - alias: num_times
maximum_cardinality: 2 - alias: x,y
x,y,z: exact_cardinality: 2
name: x,y,z - array:
range: numeric dimensions:
required: false - alias: num_times
minimum_cardinality: 3 - alias: x,y,z
maximum_cardinality: 3 exact_cardinality: 3
BehavioralEpochs: BehavioralEpochs:
name: BehavioralEpochs name: BehavioralEpochs
description: TimeSeries for storing behavioral epochs. The objective of this description: TimeSeries for storing behavioral epochs. The objective of this
@ -103,12 +103,13 @@ classes:
events. BehavioralTimeSeries is for continuous data. events. BehavioralTimeSeries is for continuous data.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: IntervalSeries any_of:
- range: IntervalSeries
tree_root: true tree_root: true
BehavioralEvents: BehavioralEvents:
name: BehavioralEvents name: BehavioralEvents
@ -116,12 +117,13 @@ classes:
for more details. for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
BehavioralTimeSeries: BehavioralTimeSeries:
name: BehavioralTimeSeries name: BehavioralTimeSeries
@ -129,36 +131,39 @@ classes:
of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details. of <a href="#BehavioralEpochs">BehavioralEpochs</a> for more details.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
PupilTracking: PupilTracking:
name: PupilTracking name: PupilTracking
description: Eye-tracking data, representing pupil size. description: Eye-tracking data, representing pupil size.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: TimeSeries any_of:
- range: TimeSeries
tree_root: true tree_root: true
EyeTracking: EyeTracking:
name: EyeTracking name: EyeTracking
description: Eye-tracking data, representing direction of gaze. description: Eye-tracking data, representing direction of gaze.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
CompassDirection: CompassDirection:
name: CompassDirection name: CompassDirection
@ -169,22 +174,24 @@ classes:
be radians or degrees. be radians or degrees.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true
Position: Position:
name: Position name: Position
description: Position data, whether along the x, x/y or x/y/z axis. description: Position data, whether along the x, x/y or x/y/z axis.
is_a: NWBDataInterface is_a: NWBDataInterface
attributes: attributes:
- name: children children:
multivalued: true name: children
inlined: true multivalued: true
inlined_as_list: false inlined: true
any_of: inlined_as_list: false
- range: SpatialSeries any_of:
- range: SpatialSeries
tree_root: true tree_root: true

Some files were not shown because too many files have changed in this diff Show more