NwbFile - MATLAB File Help
  NwbFile Root object representing data read from an NWB file.
  Requires that core and extension NWB types have been generated
  and reside in a 'types' package on the matlab path.
  Example. Construct an object from scratch for export:
     nwb = NwbFile;
     nwb.epochs = types.core.Epochs;
     nwbExport(nwb, 'epoch.nwb');
See also
Class Details
Superclasses types.core.NWBFile
Sealed false
Construct on load false
Constructor Summary
NwbFile Root object representing data read from an NWB file. 
Property Summary
acquisition OPTIONAL (NWBDataInterface) Acquired, raw data. 
analysis OPTIONAL (NWBContainer) Custom analysis results. 
file_create_date REQUIRED ((isodatetime) ) A record of the date the file was created and of subsequent modifications. The date is stored in UTC with local timezone offset as ISO 8601 extended formatted strings: 2018-09-28T14:43:54.123+02:00. Dates stored in UTC end in "Z" with no timezone offset. Date accuracy is up to milliseconds. The file can be created after the experiment was run, so this may differ from the experiment start time. Each modification to the nwb file adds a new entry to the array. 
general OPTIONAL (LabMetaData) Place-holder than can be extended so that lab-specific meta-data can be placed in /general. 
general_data_collection OPTIONAL ((char) ) Notes about data collection and analysis. 
general_devices OPTIONAL (Device) Data acquisition devices. 
general_experiment_description OPTIONAL ((char) ) General description of the experiment. 
general_experimenter OPTIONAL ((char) ) Name of person(s) who performed the experiment. Can also specify roles of different people involved. 
general_extracellular_ephys OPTIONAL (ElectrodeGroup) Physical group of electrodes. 
general_extracellular_ephys_electrodes OPTIONAL (DynamicTable) A table of all electrodes (i.e. channels) used for recording. 
general_institution OPTIONAL ((char) ) Institution(s) where experiment was performed. 
general_intracellular_ephys OPTIONAL (IntracellularElectrode) An intracellular electrode. 
general_intracellular_ephys_experimental_conditions OPTIONAL (ExperimentalConditionsTable) A table for grouping different intracellular recording repetitions together that belong to the same experimental experimental_conditions. 
general_intracellular_ephys_filtering OPTIONAL ((char) ) [DEPRECATED] Use IntracellularElectrode.filtering instead. Description of filtering used. Includes filtering type and parameters, frequency fall-off, etc. If this changes between TimeSeries, filter description should be stored as a text attribute for each TimeSeries. 
general_intracellular_ephys_intracellular_recordings OPTIONAL (IntracellularRecordingsTable) A table to group together a stimulus and response from a single electrode and a single simultaneous recording. Each row in the table represents a single recording consisting typically of a stimulus and a corresponding response. In some cases, however, only a stimulus or a response are recorded as as part of an experiment. In this case both, the stimulus and response will point to the same TimeSeries while the idx_start and count of the invalid column will be set to -1, thus, indicating that no values have been recorded for the stimulus or response, respectively. Note, a recording MUST contain at least a stimulus or a response. Typically the stimulus and response are PatchClampSeries. However, the use of AD/DA channels that are not associated to an electrode is also common in intracellular electrophysiology, in which case other TimeSeries may be used. 
general_intracellular_ephys_repetitions OPTIONAL (RepetitionsTable) A table for grouping different sequential intracellular recordings together. With each SequentialRecording typically representing a particular type of stimulus, the RepetitionsTable table is typically used to group sets of stimuli applied in sequence. 
general_intracellular_ephys_sequential_recordings OPTIONAL (SequentialRecordingsTable) A table for grouping different sequential recordings from the SimultaneousRecordingsTable table together. This is typically used to group together sequential recordings where the a sequence of stimuli of the same type with varying parameters have been presented in a sequence. 
general_intracellular_ephys_simultaneous_recordings OPTIONAL (SimultaneousRecordingsTable) A table for grouping different intracellular recordings from the IntracellularRecordingsTable table together that were recorded simultaneously from different electrodes 
general_intracellular_ephys_sweep_table OPTIONAL (SweepTable) [DEPRECATED] Table used to group different PatchClampSeries. SweepTable is being replaced by IntracellularRecordingsTable and SimultaneousRecordingsTable tabels. Additional SequentialRecordingsTable, RepetitionsTable and ExperimentalConditions tables provide enhanced support for experiment metadata. 
general_keywords OPTIONAL ((char) ) Terms to search over. 
general_lab OPTIONAL ((char) ) Laboratory where experiment was performed. 
general_notes OPTIONAL ((char) ) Notes about the experiment. 
general_optogenetics OPTIONAL (OptogeneticStimulusSite) An optogenetic stimulation site. 
general_optophysiology OPTIONAL (ImagingPlane) An imaging plane. 
general_pharmacology OPTIONAL ((char) ) Description of drugs used, including how and when they were administered. Anesthesia(s), painkiller(s), etc., plus dosage, concentration, etc. 
general_protocol OPTIONAL ((char) ) Experimental protocol, if applicable. e.g., include IACUC protocol number. 
general_related_publications OPTIONAL ((char) ) Publication information. PMID, DOI, URL, etc. 
general_session_id OPTIONAL ((char) ) Lab-specific ID for the session. 
general_slices OPTIONAL ((char) ) Description of slices, including information about preparation thickness, orientation, temperature, and bath solution. 
general_source_script OPTIONAL ((char) ) Script file or link to public source code used to create this NWB file. 
general_source_script_file_name REQUIRED (char) Name of script file. 
general_stimulus OPTIONAL ((char) ) Notes about stimuli, such as how and where they were presented. 
general_subject OPTIONAL (Subject) Information about the animal or person from which the data was measured. 
general_surgery OPTIONAL ((char) ) Narrative description about surgery/surgeries, including date(s) and who performed surgery. 
general_virus OPTIONAL ((char) ) Information about virus(es) used in experiments, including virus ID, source, date made, injection location, volume, etc. 
identifier REQUIRED ((char) ) A unique text identifier for the file. For example, concatenated lab name, file creation date/time and experimentalist, or a hash of these and/or other values. The goal is that the string should be unique to all other files. 
intervals OPTIONAL (TimeIntervals) Optional additional table(s) for describing other experimental time intervals. 
intervals_epochs OPTIONAL (TimeIntervals) Divisions in time marking experimental stages or sub-divisions of a single recording session. 
intervals_invalid_times OPTIONAL (TimeIntervals) Time intervals that should be removed from analysis. 
intervals_trials OPTIONAL (TimeIntervals) Repeated experimental events that have a logical grouping. 
nwb_version OPTIONAL (char) File version string. Use semantic versioning, e.g. 1.2.1. This will be the name of the format with trailing major, minor and patch numbers. 
processing OPTIONAL (ProcessingModule) Intermediate analysis of acquired data. 
scratch OPTIONAL (ScratchData) Any one-off datasets 
session_description REQUIRED ((char) ) A description of the experimental session and data in the file. 
session_start_time REQUIRED ((isodatetime) ) Date and time of the experiment/session start. The date is stored in UTC with local timezone offset as ISO 8601 extended formatted string: 2018-09-28T14:43:54.123+02:00. Dates stored in UTC end in "Z" with no timezone offset. Date accuracy is up to milliseconds. 
stimulus_presentation OPTIONAL (TimeSeries) TimeSeries objects containing data of presented stimuli. 
stimulus_templates OPTIONAL (TimeSeries) TimeSeries objects containing template data of presented stimuli. 
timestamps_reference_time REQUIRED ((isodatetime) ) Date and time corresponding to time zero of all timestamps. The date is stored in UTC with local timezone offset as ISO 8601 extended formatted string: 2018-09-28T14:43:54.123+02:00. Dates stored in UTC end in "Z" with no timezone offset. Date accuracy is up to milliseconds. All times stored in the file use this time as reference (i.e., time zero). 
units OPTIONAL (Units) Data about sorted spike units. 
Method Summary
  addlistener Add listener for event. 
  delete Delete a handle object. 
  eq == (EQ) Test handle equality. 
  export add to file create date 
  findobj Find objects matching specified conditions. 
  findprop Find property of MATLAB handle object. 
  ge >= (GE) Greater than or equal relation for handles. 
  gt > (GT) Greater than relation for handles. 
Sealed   isvalid Test handle validity. 
  le <= (LE) Less than or equal relation for handles. 
  listener Add listener for event without binding the listener to the source object. 
  lt < (LT) Less than relation for handles. 
  ne ~= (NE) Not equal relation for handles. 
  notify Notify listeners of event. 
  searchFor Searches this NwbFile object for a given typename 
Event Summary