NWB version 1ΒΆ

The File Organization (version 1.0.5) is loosely described in the archived repository for the NWBv1 schema specification

The following tree describes the NWB layout version 1

#  specifications:
#  - version : 1.0.5 beta
#    url : https://htmlpreview.github.io/?https://raw.githubusercontent.com/NeurodataWithoutBorders/specification_nwbn_1_0_x/master/version_1.0.5_beta/nwb_file_format_specification_1.0.5_beta.html#File_organization

acquisition:
  timeseries: # empty if no acquired data is saved
  - data_XXXXX_ADY:
      stimulus_description : name of the stimset # custom entry
      data                 : 1D dataset with attributes unit, conversion and resolution
      electrode_name       : Name of the electrode headstage, more info in /general/intracellular_ephys/electrode_name
      gain                 : scaling factor
      num_samples          : Number of rows in data
      starting_time        : relative to /session_start_time with attributes rate and unit

      # For Voltage Clamp (Missing entries are mentioned in missing_fields):
      capacitance_fast :
      capacitance_slow :
      resistance_comp_bandwidth :
      resistance_comp_correction :
      resistance_comp_prediction :
      whole_cell_capacitance_comp :
      whole_cell_series_resistance_comp :

      # For Current Clamp (Missing entries are mentioned in missing_fields):
      bias_current :
      bridge_balance :
      capacitance_compensation :

      description    : Unused
      source         : Human readable description of the source of the data
      comment        : User comment for the sweep
      missing_fields : Entries missing for voltage clamp/current clamp data
      ancestry       : Class hierarchy defined by NWB spec, important members are
                       CurrentClampSeries, IZeroClampSeries and VoltageClampSeries
      neurodata_type : TimeSeries

stimulus:
  presentation: # empty if no acquired data is saved
  - data_XXXXX_DAY: # DA data as sent to the neuron, including delays, scaling, initial TP, etc.
      data           : 1D dataset
      electrode_name : Name of the electrode headstage, more info in /general/intracellular_ephys/electrode_name
      gain           :
      num_samples    : Number of rows in data
      starting_time  : relative to /session_start_time with attributes rate and unit
      description    : Unused
      source         : Human readable description of the source of the data
      ancestry       : Class hierarchy defined by NWB spec, important members are
                       CurrentClampStimulusSeries and VoltageClampStimulusSeries
      neurodata_type : TimeSeries
  template: unused

general:
  file_create_date    : text array with UTC modification timestamps
  identifier          : SHA256 hash, ensured to be unique
  nwb_version         : NWB specification version
  session_description : unused
  session_start_time  : ISO8601 timestamp in UTC timezone with sub-second precision defining when the recording session started
  generated_by: # custom entry
                Nx2 text data array describing the system which created the data. First column is the key, second the value.
  history: # custom entry
           Full Igor Pro history since measurement start (useful for debugging)

  # The following attributes are only available if explicitly set by the user:
  data_collection :
  experiment_description :
  experimenter :
  institution :
  lab :
  notes :
  pharmacology :
  protocol :
  related_publications :
  session_id :
  slices :
  stimulus :
  age :
  description :
  genotype :
  sex :
  species :
  subject_id :
  weight :
  surgery :
  virus :

  devices: # empty if no acquired data is saved
  - device_XXX: # Name of the DA_ephys device, something like "Harvard Bioscience ITC 18USB"
      intracellular_ephys:
        electrode_XXX: # XXX can be set by the user via writing into GetCellElectrodeNames()
        description : Holds the description of the electrode, something like "Headstage 1".
        device      : Device used to record the data
  labnotebook: # custom entry
  - XXXX: # Name of the device
      numericalKeys   : Numerical labnotebook
      numericalValues : Keys for numerical labnotebook
      textualKeys     : Keys for textual labnotebook
      textualValues   : Textual labnotebook
  testpulse: # custom entry
    - XXXX: # Name of the device
      TPStorage/TPStorage_X: testpulse property waves
      StoredTestPulses: Raw testpulses as 1D datasets
  user_comment:
  - XXXX: # Name of the device
      userComment: All user comments from this session
  stimsets: # custom entry
    XXXXXX_[DA/TTL]_Y_[SegWvType/WP/WPT]: The Wavebuilder parameter waves. These waves will not be available for
                                          "third party stimsets" created outside of MIES.
    XXXXXX_[DA/TTL]_Y: Name of the stimset, referenced from
                       stimulus_description if acquired data is present. Only present if
                       not all parameter waves could be found.
    referenced: All referenced custom waves are stored here in a file-system like group-structure.
                /general/stimsets/referenced/ relates to root in the igor Experiment.
  epochs:
    tags: unused