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
  • 2.5. Tables and ragged arrays
  • 2.6. Doubly ragged arrays
  • 2.7. References to rows of a table

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. TimeSeriesReferenceVectorData
    • 2.1.3. BaseImage
    • 2.1.4. Image
    • 2.1.5. ExternalImage
    • 2.1.6. ImageReferences
    • 2.1.7. NWBContainer
    • 2.1.8. NWBDataInterface
    • 2.1.9. TimeSeries
    • 2.1.10. ProcessingModule
    • 2.1.11. Images
  • 2.2. Devices
    • 2.2.1. Device
    • 2.2.2. DeviceModel
  • 2.3. Epochs
    • 2.3.1. TimeIntervals
  • 2.4. Events
    • 2.4.1. TimestampVectorData
    • 2.4.2. DurationVectorData
    • 2.4.3. EventsTable
  • 2.5. Image data
    • 2.5.1. GrayscaleImage
    • 2.5.2. RGBImage
    • 2.5.3. RGBAImage
    • 2.5.4. ImageSeries
    • 2.5.5. ImageMaskSeries
    • 2.5.6. OpticalSeries
    • 2.5.7. IndexSeries
  • 2.6. NWB file
    • 2.6.1. ScratchData
    • 2.6.2. NWBFile
    • 2.6.3. LabMetaData
    • 2.6.4. Subject
  • 2.7. Miscellaneous neurodata_types.
    • 2.7.1. AbstractFeatureSeries
    • 2.7.2. AnnotationSeries
    • 2.7.3. IntervalSeries
    • 2.7.4. FrequencyBandsTable
    • 2.7.5. DecompositionSeries
    • 2.7.6. Units
  • 2.8. Behavior
    • 2.8.1. SpatialSeries
    • 2.8.2. BehavioralEpochs
    • 2.8.3. BehavioralEvents
    • 2.8.4. BehavioralTimeSeries
    • 2.8.5. PupilTracking
    • 2.8.6. EyeTracking
    • 2.8.7. CompassDirection
    • 2.8.8. Position
  • 2.9. Extracellular electrophysiology
    • 2.9.1. ElectricalSeries
    • 2.9.2. SpikeEventSeries
    • 2.9.3. FeatureExtraction
    • 2.9.4. EventDetection
    • 2.9.5. EventWaveform
    • 2.9.6. FilteredEphys
    • 2.9.7. LFP
    • 2.9.8. ElectrodeGroup
    • 2.9.9. ElectrodesTable
    • 2.9.10. ClusterWaveforms
    • 2.9.11. Clustering
  • 2.10. Intracellular electrophysiology
    • 2.10.1. PatchClampSeries
    • 2.10.2. CurrentClampSeries
    • 2.10.3. IZeroClampSeries
    • 2.10.4. CurrentClampStimulusSeries
    • 2.10.5. VoltageClampSeries
    • 2.10.6. VoltageClampStimulusSeries
    • 2.10.7. IntracellularElectrode
    • 2.10.8. SweepTable
    • 2.10.9. IntracellularElectrodesTable
    • 2.10.10. IntracellularStimuliTable
    • 2.10.11. IntracellularResponsesTable
    • 2.10.12. IntracellularRecordingsTable
    • 2.10.13. SimultaneousRecordingsTable
    • 2.10.14. SequentialRecordingsTable
    • 2.10.15. RepetitionsTable
    • 2.10.16. ExperimentalConditionsTable
  • 2.11. Optogenetics
    • 2.11.1. OptogeneticSeries
    • 2.11.2. OptogeneticStimulusSite
  • 2.12. Optical physiology
    • 2.12.1. OnePhotonSeries
    • 2.12.2. TwoPhotonSeries
    • 2.12.3. RoiResponseSeries
    • 2.12.4. DfOverF
    • 2.12.5. Fluorescence
    • 2.12.6. ImageSegmentation
    • 2.12.7. PlaneSegmentation
    • 2.12.8. ImagingPlane
    • 2.12.9. OpticalChannel
    • 2.12.10. MotionCorrection
    • 2.12.11. CorrectedImageStack
  • 2.13. Retinotopy
    • 2.13.1. ImagingRetinotopy
• 3. Schema Sources
  • 3.1. Namespace – NWB core
  • 3.2. Base data types
    • 3.2.1. NWBData
    • 3.2.2. TimeSeriesReferenceVectorData
    • 3.2.3. BaseImage
    • 3.2.4. Image
    • 3.2.5. ExternalImage
    • 3.2.6. ImageReferences
    • 3.2.7. NWBContainer
    • 3.2.8. NWBDataInterface
    • 3.2.9. TimeSeries
    • 3.2.10. ProcessingModule
    • 3.2.11. Images
  • 3.3. Devices
    • 3.3.1. Device
    • 3.3.2. DeviceModel
  • 3.4. Epochs
    • 3.4.1. TimeIntervals
  • 3.5. Events
    • 3.5.1. TimestampVectorData
    • 3.5.2. DurationVectorData
    • 3.5.3. EventsTable
  • 3.6. Image data
    • 3.6.1. GrayscaleImage
    • 3.6.2. RGBImage
    • 3.6.3. RGBAImage
    • 3.6.4. ImageSeries
    • 3.6.5. ImageMaskSeries
    • 3.6.6. OpticalSeries
    • 3.6.7. IndexSeries
  • 3.7. NWB file
    • 3.7.1. ScratchData
    • 3.7.2. NWBFile
    • 3.7.3. LabMetaData
    • 3.7.4. Subject
  • 3.8. Miscellaneous neurodata_types.
    • 3.8.1. AbstractFeatureSeries
    • 3.8.2. AnnotationSeries
    • 3.8.3. IntervalSeries
    • 3.8.4. FrequencyBandsTable
    • 3.8.5. DecompositionSeries
    • 3.8.6. Units
  • 3.9. Behavior
    • 3.9.1. SpatialSeries
    • 3.9.2. BehavioralEpochs
    • 3.9.3. BehavioralEvents
    • 3.9.4. BehavioralTimeSeries
    • 3.9.5. PupilTracking
    • 3.9.6. EyeTracking
    • 3.9.7. CompassDirection
    • 3.9.8. Position
  • 3.10. Extracellular electrophysiology
    • 3.10.1. ElectricalSeries
    • 3.10.2. SpikeEventSeries
    • 3.10.3. FeatureExtraction
    • 3.10.4. EventDetection
    • 3.10.5. EventWaveform
    • 3.10.6. FilteredEphys
    • 3.10.7. LFP
    • 3.10.8. ElectrodeGroup
    • 3.10.9. ElectrodesTable
    • 3.10.10. ClusterWaveforms
    • 3.10.11. Clustering
  • 3.11. Intracellular electrophysiology
    • 3.11.1. PatchClampSeries
    • 3.11.2. CurrentClampSeries
    • 3.11.3. IZeroClampSeries
    • 3.11.4. CurrentClampStimulusSeries
    • 3.11.5. VoltageClampSeries
    • 3.11.6. VoltageClampStimulusSeries
    • 3.11.7. IntracellularElectrode
    • 3.11.8. SweepTable
    • 3.11.9. IntracellularElectrodesTable
    • 3.11.10. IntracellularStimuliTable
    • 3.11.11. IntracellularResponsesTable
    • 3.11.12. IntracellularRecordingsTable
    • 3.11.13. SimultaneousRecordingsTable
    • 3.11.14. SequentialRecordingsTable
    • 3.11.15. RepetitionsTable
    • 3.11.16. ExperimentalConditionsTable
  • 3.12. Optogenetics
    • 3.12.1. OptogeneticSeries
    • 3.12.2. OptogeneticStimulusSite
  • 3.13. Optical physiology
    • 3.13.1. OnePhotonSeries
    • 3.13.2. TwoPhotonSeries
    • 3.13.3. RoiResponseSeries
    • 3.13.4. DfOverF
    • 3.13.5. Fluorescence
    • 3.13.6. ImageSegmentation
    • 3.13.7. PlaneSegmentation
    • 3.13.8. ImagingPlane
    • 3.13.9. OpticalChannel
    • 3.13.10. MotionCorrection
    • 3.13.11. CorrectedImageStack
  • 3.14. Retinotopy
    • 3.14.1. ImagingRetinotopy

History & Legal

• Making a Pull Request
• Merging PRs and Making Releases
• Making a Release Checklist
• The “dev” Branch and Releases
• Release Notes
  • 2.10.0 (Upcoming)
  • 2.9.0 (June 26, 2025)
  • 2.8.0 (November 24, 2024)
  • 2.7.0 (February 7, 2024)
  • 2.6.0 (January 17, 2023)
  • 2.5.0 (June 14, 2022)
  • 2.4.0 (Aug. 11, 2021)
  • 2.3.0 (May 12, 2021)
  • 2.2.5 (May 29, 2020)
  • 2.2.4 (April 14, 2020)
  • 2.2.3 (April 13, 2020)
  • 2.2.2 (March 2, 2020)
  • 2.2.1 (January 14, 2020)
  • 2.2.0 (January 6, 2020)
  • 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