mirror of
https://github.com/p2p-ld/nwb-linkml.git
synced 2024-11-14 02:34:28 +00:00
222 lines
7.3 KiB
YAML
222 lines
7.3 KiB
YAML
name: core.nwb.base
|
|
id: core.nwb.base
|
|
imports:
|
|
- hdmf-common.base
|
|
- hdmf-common.table
|
|
- nwb.language
|
|
- core.nwb.base.include
|
|
- core.nwb.base
|
|
prefixes:
|
|
core.nwb.base:
|
|
prefix_prefix: core.nwb.base
|
|
prefix_reference: https://example.com/core.nwb.base/
|
|
default_prefix: core.nwb.base
|
|
classes:
|
|
NWBData:
|
|
name: NWBData
|
|
description: An abstract data type for a dataset.
|
|
is_a: Data
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
tree_root: true
|
|
TimeSeriesReferenceVectorData:
|
|
name: TimeSeriesReferenceVectorData
|
|
description: Column storing references to a TimeSeries (rows). For each TimeSeries
|
|
this VectorData column stores the start_index and count to indicate the range
|
|
in time to be selected as well as an object reference to the TimeSeries.
|
|
is_a: VectorData
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
tree_root: true
|
|
Image:
|
|
name: Image
|
|
description: An abstract data type for an image. Shape can be 2-D (x, y), or 3-D
|
|
where the third dimension can have three or four elements, e.g. (x, y, (r, g,
|
|
b)) or (x, y, (r, g, b, a)).
|
|
is_a: NWBData
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
resolution:
|
|
name: resolution
|
|
description: Pixel resolution of the image, in pixels per centimeter.
|
|
range: float32
|
|
description:
|
|
name: description
|
|
description: Description of the image.
|
|
range: text
|
|
array:
|
|
name: array
|
|
range: Image__Array
|
|
tree_root: true
|
|
ImageReferences:
|
|
name: ImageReferences
|
|
description: Ordered dataset of references to Image objects.
|
|
is_a: NWBData
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
array:
|
|
name: array
|
|
range: ImageReferences__Array
|
|
tree_root: true
|
|
NWBContainer:
|
|
name: NWBContainer
|
|
description: An abstract data type for a generic container storing collections
|
|
of data and metadata. Base type for all data and metadata containers.
|
|
is_a: Container
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
tree_root: true
|
|
NWBDataInterface:
|
|
name: NWBDataInterface
|
|
description: An abstract data type for a generic container storing collections
|
|
of data, as opposed to metadata.
|
|
is_a: NWBContainer
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
tree_root: true
|
|
TimeSeries:
|
|
name: TimeSeries
|
|
description: General purpose time series.
|
|
is_a: NWBDataInterface
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
description:
|
|
name: description
|
|
description: Description of the time series.
|
|
range: text
|
|
comments:
|
|
name: comments
|
|
description: Human-readable comments about the TimeSeries. This second descriptive
|
|
field can be used to store additional information, or descriptive information
|
|
if the primary description field is populated with a computer-readable string.
|
|
range: text
|
|
data:
|
|
name: data
|
|
description: Data values. Data can be in 1-D, 2-D, 3-D, or 4-D. The first
|
|
dimension should always represent time. This can also be used to store binary
|
|
data (e.g., image frames). This can also be a link to data stored in an
|
|
external file.
|
|
multivalued: false
|
|
range: TimeSeries__data
|
|
required: true
|
|
starting_time:
|
|
name: starting_time
|
|
description: Timestamp of the first sample in seconds. When timestamps are
|
|
uniformly spaced, the timestamp of the first sample can be specified and
|
|
all subsequent ones calculated from the sampling rate attribute.
|
|
multivalued: false
|
|
range: TimeSeries__starting_time
|
|
required: false
|
|
timestamps:
|
|
name: timestamps
|
|
description: Timestamps for samples stored in data, in seconds, relative to
|
|
the common experiment master-clock stored in NWBFile.timestamps_reference_time.
|
|
multivalued: true
|
|
range: float64
|
|
required: false
|
|
control:
|
|
name: control
|
|
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
|
|
of this array should be the same size as the first dimension of data.
|
|
multivalued: true
|
|
range: uint8
|
|
required: false
|
|
control_description:
|
|
name: control_description
|
|
description: Description of each control value. Must be present if control
|
|
is present. If present, control_description[0] should describe time points
|
|
where control == 0.
|
|
multivalued: true
|
|
range: text
|
|
required: false
|
|
sync:
|
|
name: sync
|
|
description: Lab-specific time and sync information as provided directly from
|
|
hardware devices and that is necessary for aligning all acquired time information
|
|
to a common timebase. The timestamp array stores time in the common timebase.
|
|
This group will usually only be populated in TimeSeries that are stored
|
|
external to the NWB file, in files storing raw data. Once timestamp data
|
|
is calculated, the contents of 'sync' are mostly for archival purposes.
|
|
multivalued: false
|
|
range: TimeSeries__sync
|
|
required: false
|
|
tree_root: true
|
|
ProcessingModule:
|
|
name: ProcessingModule
|
|
description: A collection of processed data.
|
|
is_a: NWBContainer
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
description:
|
|
name: description
|
|
description: Description of this collection of processed data.
|
|
range: text
|
|
nwb_data_interface:
|
|
name: nwb_data_interface
|
|
description: Data objects stored in this collection.
|
|
multivalued: true
|
|
range: NWBDataInterface
|
|
required: false
|
|
dynamic_table:
|
|
name: dynamic_table
|
|
description: Tables stored in this collection.
|
|
multivalued: true
|
|
range: DynamicTable
|
|
required: false
|
|
tree_root: true
|
|
Images:
|
|
name: Images
|
|
description: A collection of images with an optional way to specify the order
|
|
of the images using the "order_of_images" dataset. An order must be specified
|
|
if the images are referenced by index, e.g., from an IndexSeries.
|
|
is_a: NWBDataInterface
|
|
attributes:
|
|
name:
|
|
name: name
|
|
range: string
|
|
required: true
|
|
description:
|
|
name: description
|
|
description: Description of this collection of images.
|
|
range: text
|
|
Image:
|
|
name: Image
|
|
description: Images stored in this collection.
|
|
multivalued: true
|
|
range: Image
|
|
required: true
|
|
order_of_images:
|
|
name: order_of_images
|
|
description: Ordered dataset of references to Image objects stored in the
|
|
parent group. Each Image object in the Images group should be stored once
|
|
and only once, so the dataset should have the same length as the number
|
|
of images.
|
|
multivalued: false
|
|
range: Images__order_of_images
|
|
required: false
|
|
tree_root: true
|