aqnwb 0.4.0
Loading...
Searching...
No Matches
AQNWB::NWB Namespace Reference

Namespace for all classes related to the NWB data standard. More...

Classes

class  AnnotationSeries
 TimeSeries storing text-based records about the experiment. More...
class  Container
 Abstract data type for a group storing collections of data and metadata. More...
class  Data
 An abstract data type for a dataset. More...
class  DataTyped
 A typed data container for a dataset. More...
class  Device
 Metadata about a data acquisition device, e.g., recording system, electrode, microscope. More...
class  DurationVectorData
 A 1-D VectorData that stores durations in seconds. More...
class  DynamicTable
 Represents a group containing multiple datasets that are aligned on the first dimension. More...
class  ElectricalSeries
 General purpose time series. More...
class  ElectrodeGroup
 The ElectrodeGroup class represents a physical grouping of electrodes, e.g. a shank of an array. More...
class  ElectrodesTable
 Represents a table containing electrode metadata. More...
class  ElementIdentifiers
 A list of unique identifiers for values within a dataset, e.g. rows of a DynamicTable. More...
class  EventsTable
 A column-based table to store information about events, one event per row. Use EventsTable when each row is anchored at a single timestamp and duration is absent, optional, or mixed across rows. Additional columns may be added to store metadata about each event, such as the duration of the event. Examples include TTL pulses, licks, rewards, stimulus onsets, and detected ripples. Each EventsTable should hold events of a single type, so that all rows share the same set of per-event metadata columns. Events of different types (e.g., licks and stimulus presentations) should be stored in separate EventsTable instances. More...
class  MeaningsTable
 A table to store information about the meanings of values in a referenced VectorData object. All possible values of the referenced VectorData object should be present in the 'value' column of this table, even if the value is not observed in the data. Additional columns may be added to store additional metadata about each value. The name of the MeaningsTable should correspond to the name of the referenced VectorData object with a "_meanings" suffix. e.g., if the referenced VectorData object is named "stimulus_type", the corresponding MeaningsTable should be named "stimulus_type_meanings". More...
class  NWBContainer
 An abstract data type for a generic container storing collections of data and metadata. Base type for all data and metadata containers. More...
class  NWBData
 An abstract data type for a dataset. More...
class  NWBDataInterface
 An abstract data type for a generic container storing collections of data, as opposed to metadata. More...
class  NWBDataTyped
 A typed data container for a dataset. More...
class  NWBFile
 The NWBFile class provides an interface for setting up and managing the NWB file. More...
class  ProcessingModule
 A collection of processed data. More...
class  RegisteredType
 Base class for types defined in the NWB schema. More...
class  SpikeEventSeries
 Stores snapshots/snippets of recorded spike events (i.e., threshold crossings). More...
class  Subject
 Information about the animal or person from which the data was measured. More...
class  TimeIntervals
 A container for aggregating epoch data and the TimeSeries that each epoch applies to. More...
class  TimeSeries
 General purpose time series. More...
class  TimestampVectorData
 A 1-D VectorData that stores timestamps in seconds from the session start time. Timestamps are not required to be sorted in time. More...
class  VectorData
 An n-dimensional dataset representing a column of a DynamicTable. More...
class  VectorDataTyped
 A typed n-dimensional dataset representing a column of a DynamicTable. More...
class  VectorIndex
 Used with VectorData to encode a ragged array. An array of indices into the first dimension of the target VectorData, and forming a map between the rows of a DynamicTable and the indices of the VectorData. The name of the VectorIndex is expected to be the name of the target VectorData object followed by "_index". More...

Typedefs

using CellValue = AQNWB::Types::CellValue

Variables

constexpr auto AttributeField = AQNWB::Types::StorageObjectType::Attribute
 Alias for AQNWB::Types::StorageObjectType::Attribute.
constexpr auto DatasetField = AQNWB::Types::StorageObjectType::Dataset
 Alias for AQNWB::Types::StorageObjectType::Dataset.

Detailed Description

Namespace for all classes related to the NWB data standard.

Typedef Documentation

◆ CellValue

Variable Documentation

◆ AttributeField

auto AQNWB::NWB::AttributeField = AQNWB::Types::StorageObjectType::Attribute
constexpr

Alias for AQNWB::Types::StorageObjectType::Attribute.

◆ DatasetField

auto AQNWB::NWB::DatasetField = AQNWB::Types::StorageObjectType::Dataset
constexpr

Alias for AQNWB::Types::StorageObjectType::Dataset.