Welcome to the NWB Format Specification

Introduction

• 1. Overview
  • 1.1. neurodata_type : Assigning types to specifications
  • 1.2. NWBContainer, NWBData, NWBDataInterface: Base neurodata_types for containers and datasets
  • 1.3. Time Series : A base neurodata_type for storing time series data
  • 1.4. Data Processing Modules: Organizing processed data
  • 1.5. Extending the format
  • 1.6. Common attributes
• 2. Comments and Definitions
  • 2.1. Notation
  • 2.2. Storing Time Values
  • 2.3. Links and data references
  • 2.4. Design notes

Format Specification

• 1. Format Overview
  • 1.1. Namespace – NWB core
  • 1.2. Type Hierarchy
• 2. Type Specifications
  • 2.1. Base data types
    • 2.1.1. NWBData
    • 2.1.2. Index
    • 2.1.3. VectorData
    • 2.1.4. VectorIndex
    • 2.1.5. ElementIdentifiers
    • 2.1.6. DynamicTableRegion
    • 2.1.7. Image
    • 2.1.8. NWBContainer
    • 2.1.9. NWBDataInterface
    • 2.1.10. TimeSeries
    • 2.1.11. ProcessingModule
    • 2.1.12. Images
    • 2.1.13. DynamicTable
  • 2.2. Epochs
    • 2.2.1. TimeIntervals
  • 2.3. Image data
    • 2.3.1. GrayscaleImage
    • 2.3.2. RGBImage
    • 2.3.3. RGBAImage
    • 2.3.4. ImageSeries
    • 2.3.5. ImageMaskSeries
    • 2.3.6. OpticalSeries
    • 2.3.7. IndexSeries
  • 2.4. NWB:N file
    • 2.4.1. NWBFile
    • 2.4.2. LabMetaData
    • 2.4.3. Device
    • 2.4.4. Subject
  • 2.5. Miscellaneous neurodata_types.
    • 2.5.1. AbstractFeatureSeries
    • 2.5.2. AnnotationSeries
    • 2.5.3. IntervalSeries
    • 2.5.4. DecompositionSeries
    • 2.5.5. Units
  • 2.6. Behavior
    • 2.6.1. SpatialSeries
    • 2.6.2. BehavioralEpochs
    • 2.6.3. BehavioralEvents
    • 2.6.4. BehavioralTimeSeries
    • 2.6.5. PupilTracking
    • 2.6.6. EyeTracking
    • 2.6.7. CompassDirection
    • 2.6.8. Position
  • 2.7. Extracellular electrophysiology
    • 2.7.1. ElectricalSeries
    • 2.7.2. SpikeEventSeries
    • 2.7.3. ClusterWaveforms
    • 2.7.4. Clustering
    • 2.7.5. FeatureExtraction
    • 2.7.6. EventDetection
    • 2.7.7. EventWaveform
    • 2.7.8. FilteredEphys
    • 2.7.9. LFP
    • 2.7.10. ElectrodeGroup
  • 2.8. Intracellular electrophysiology
    • 2.8.1. PatchClampSeries
    • 2.8.2. CurrentClampSeries
    • 2.8.3. IZeroClampSeries
    • 2.8.4. CurrentClampStimulusSeries
    • 2.8.5. VoltageClampSeries
    • 2.8.6. VoltageClampStimulusSeries
    • 2.8.7. IntracellularElectrode
    • 2.8.8. SweepTable
  • 2.9. Optogenetics
    • 2.9.1. OptogeneticSeries
    • 2.9.2. OptogeneticStimulusSite
  • 2.10. Optical physiology
    • 2.10.1. TwoPhotonSeries
    • 2.10.2. RoiResponseSeries
    • 2.10.3. DfOverF
    • 2.10.4. Fluorescence
    • 2.10.5. ImageSegmentation
    • 2.10.6. PlaneSegmentation
    • 2.10.7. ImagingPlane
    • 2.10.8. OpticalChannel
    • 2.10.9. MotionCorrection
    • 2.10.10. CorrectedImageStack
  • 2.11. Retinotopy
    • 2.11.1. ImagingRetinotopy
• 3. Schema Sources
  • 3.1. Namespace – NWB core
  • 3.2. Base data types
    • 3.2.1. NWBData
    • 3.2.2. Index
    • 3.2.3. VectorData
    • 3.2.4. VectorIndex
    • 3.2.5. ElementIdentifiers
    • 3.2.6. DynamicTableRegion
    • 3.2.7. Image
    • 3.2.8. NWBContainer
    • 3.2.9. NWBDataInterface
    • 3.2.10. TimeSeries
    • 3.2.11. ProcessingModule
    • 3.2.12. Images
    • 3.2.13. DynamicTable
  • 3.3. Epochs
    • 3.3.1. TimeIntervals
  • 3.4. Image data
    • 3.4.1. GrayscaleImage
    • 3.4.2. RGBImage
    • 3.4.3. RGBAImage
    • 3.4.4. ImageSeries
    • 3.4.5. ImageMaskSeries
    • 3.4.6. OpticalSeries
    • 3.4.7. IndexSeries
  • 3.5. NWB:N file
    • 3.5.1. NWBFile
    • 3.5.2. LabMetaData
    • 3.5.3. Device
    • 3.5.4. Subject
  • 3.6. Miscellaneous neurodata_types.
    • 3.6.1. AbstractFeatureSeries
    • 3.6.2. AnnotationSeries
    • 3.6.3. IntervalSeries
    • 3.6.4. DecompositionSeries
    • 3.6.5. Units
  • 3.7. Behavior
    • 3.7.1. SpatialSeries
    • 3.7.2. BehavioralEpochs
    • 3.7.3. BehavioralEvents
    • 3.7.4. BehavioralTimeSeries
    • 3.7.5. PupilTracking
    • 3.7.6. EyeTracking
    • 3.7.7. CompassDirection
    • 3.7.8. Position
  • 3.8. Extracellular electrophysiology
    • 3.8.1. ElectricalSeries
    • 3.8.2. SpikeEventSeries
    • 3.8.3. ClusterWaveforms
    • 3.8.4. Clustering
    • 3.8.5. FeatureExtraction
    • 3.8.6. EventDetection
    • 3.8.7. EventWaveform
    • 3.8.8. FilteredEphys
    • 3.8.9. LFP
    • 3.8.10. ElectrodeGroup
  • 3.9. Intracellular electrophysiology
    • 3.9.1. PatchClampSeries
    • 3.9.2. CurrentClampSeries
    • 3.9.3. IZeroClampSeries
    • 3.9.4. CurrentClampStimulusSeries
    • 3.9.5. VoltageClampSeries
    • 3.9.6. VoltageClampStimulusSeries
    • 3.9.7. IntracellularElectrode
    • 3.9.8. SweepTable
  • 3.10. Optogenetics
    • 3.10.1. OptogeneticSeries
    • 3.10.2. OptogeneticStimulusSite
  • 3.11. Optical physiology
    • 3.11.1. TwoPhotonSeries
    • 3.11.2. RoiResponseSeries
    • 3.11.3. DfOverF
    • 3.11.4. Fluorescence
    • 3.11.5. ImageSegmentation
    • 3.11.6. PlaneSegmentation
    • 3.11.7. ImagingPlane
    • 3.11.8. OpticalChannel
    • 3.11.9. MotionCorrection
    • 3.11.10. CorrectedImageStack
  • 3.12. Retinotopy
    • 3.12.1. ImagingRetinotopy

History & Legal

• Release Notes
  • 2.1.0 (September 2019)
  • 2.0.2 (June 2019)
  • 2.0.1 (March 2019)
  • 2.0.0 (January 2019)
  • 1.0.x (09/2015 - 04/2017)
• Credits
  • Acknowledgments
  • Authors
• Legal
  • Copyright
  • Licence