NwbFile - MATLAB File Help
NwbFile
  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 Any objects representing acquired data 
analysis Custom analysis results 
file_create_date A record of the date the file was created and of subsequent modifications. COMMENT: - 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 place-holder than can be extended so that lab-specific meta-data can be placed in /general 
general_data_collection Notes about data collection and analysis.COMMENT: Can be from Methods 
general_devices One of possibly many. Information about device and device description. 
general_experiment_description General description of the experiment.COMMENT: Can be from Methods 
general_experimenter Name of person who performed the experiment.COMMENT: More than one person OK. Can specify roles of different people involved. 
general_extracellular_ephys One of possibly many groups, one for each electrode group. 
general_extracellular_ephys_electrodes A table of all electrodes (i.e. channels) used for recording. 
general_institution Institution(s) where experiment was performed 
general_intracellular_ephys One of possibly many. COMMENT: Name should be informative. 
general_intracellular_ephys_filtering Description of filtering used. COMMENT: 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_sweep_table The table which groups different PatchClampSeries together. 
general_keywords Terms to search over 
general_lab Lab where experiment was performed 
general_notes Notes about the experiment. COMMENT: Things particular to this experiment 
general_optogenetics One of possibly many groups describing an optogenetic stimulation site. COMMENT: Name is arbitrary but should be meaningful. Name is referenced by OptogeneticSeries. 
general_optophysiology One of possibly many groups describing an imaging plane. COMMENT: Name is arbitrary but should be meaningful. It is referenced by TwoPhotonSeries and also ImageSegmentation and DfOverF interfaces. 
general_pharmacology Description of drugs used, including how and when they were administered. COMMENT: Anesthesia(s), painkiller(s), etc., plus dosage, concentration, etc. 
general_protocol Experimental protocol, if applicable. COMMENT: E.g., include IACUC protocol. 
general_related_publications Publication information. COMMENT: PMID, DOI, URL, etc. If multiple, concatenate together and describe which is which. such as PMID, DOI, URL, etc 
general_session_id Lab-specific ID for the session.COMMENT: Only 1 session_id per file, with all time aligned to experiment start time. 
general_slices Description of slices, including information about preparation thickness, orientation, temperature and bath solution 
general_source_script Script file used to create this NWB file. 
general_source_script_file_name Name of script file 
general_specifications Dataset for storing contents of a specification file for either the core format or an extension. Name should match name of file.` 
general_stimulus Notes about stimuli, such as how and where presented. COMMENT: Can be from Methods. 
general_subject Information about the animal or person from which the data was measured. 
general_surgery Narrative description about surgery/surgeries, including date(s) and who performed surgery. COMMENT: Much can be copied from Methods. 
general_virus Information about virus(es) used in experiments, including virus ID, source, date made, injection location, volume, etc. 
help Short description of what this type of NWBContainer contains. 
identifier A unique text identifier for the file. COMMENT: Eg, 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 an optional additional table for describing other experimental time intervals 
intervals_epochs divisions in time marking experimental stages or sub-divisions of a single recording session 
intervals_invalid_times time intervals that should be removed from analysis 
intervals_trials repeated experimental events that have a logical grouping 
nwb_version File version string. COMMENT: Eg, NWB-1.0.0. This will be the name of the format with trailing major, minor and patch numbers. 
processing Intermediate analysis of acquired data 
session_description One or two sentences describing the experiment and data in the file. 
session_start_time Date and time of the experiment/session start. COMMENT: - 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 TimeSeries objects containing data of presented stimuli 
stimulus_templates TimeSeries objects containing template data of presented stimuli 
timestamps_reference_time Date and time corresponding to time zero of all timestamps. COMMENT: - 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 (ie, time zero). 
units Data about units 
Method Summary
  addlistener Add listener for event. 
  delete Delete a handle object. 
  eq == (EQ) Test handle equality. 
  export find reference properties 
  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. 
  loadAll  
  lt < (LT) Less than relation for handles. 
  ne ~= (NE) Not equal relation for handles. 
  notify Notify listeners of event. 
  resolve  
  validate_acquisition  
  validate_analysis  
  validate_file_create_date  
  validate_general  
  validate_general_data_collection  
  validate_general_devices  
  validate_general_experiment_description  
  validate_general_experimenter  
  validate_general_extracellular_ephys  
  validate_general_extracellular_ephys_electrodes  
  validate_general_institution  
  validate_general_intracellular_ephys  
  validate_general_intracellular_ephys_filtering  
  validate_general_intracellular_ephys_sweep_table  
  validate_general_keywords  
  validate_general_lab  
  validate_general_notes  
  validate_general_optogenetics  
  validate_general_optophysiology  
  validate_general_pharmacology  
  validate_general_protocol  
  validate_general_related_publications  
  validate_general_session_id  
  validate_general_slices  
  validate_general_source_script  
  validate_general_source_script_file_name  
  validate_general_specifications  
  validate_general_stimulus  
  validate_general_subject  
  validate_general_surgery  
  validate_general_virus  
  validate_help  
  validate_identifier  
  validate_intervals  
  validate_intervals_epochs  
  validate_intervals_invalid_times  
  validate_intervals_trials  
  validate_processing  
  validate_session_description  
  validate_session_start_time  
  validate_stimulus_presentation  
  validate_stimulus_templates  
  validate_timestamps_reference_time  
  validate_units  
Event Summary