name: core.nwb.base id: core.nwb.base imports: - hdmf-common.base - hdmf-common.table - nwb.language - core.nwb.base.include - core.nwb.base default_prefix: core.nwb.base/ classes: NWBData: name: NWBData description: An abstract data type for a dataset. is_a: Data 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 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: 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 ImageReferences: name: ImageReferences description: Ordered dataset of references to Image objects. is_a: NWBData attributes: array: name: array range: ImageReferences__Array 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 NWBDataInterface: name: NWBDataInterface description: An abstract data type for a generic container storing collections of data, as opposed to metadata. is_a: NWBContainer TimeSeries: name: TimeSeries description: General purpose time series. is_a: NWBDataInterface attributes: 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: false range: TimeSeries__timestamps 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: false range: TimeSeries__control 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: false range: TimeSeries__control_description 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 ProcessingModule: name: ProcessingModule description: A collection of processed data. is_a: NWBContainer attributes: description: name: description description: Description of this collection of processed data. range: text NWBDataInterface: name: NWBDataInterface description: Data objects stored in this collection. multivalued: true range: NWBDataInterface required: false DynamicTable: name: DynamicTable description: Tables stored in this collection. multivalued: true range: DynamicTable required: false 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: 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