types.core.OpticalSeries - MATLAB File Help
types.core.OpticalSeries
  OpticalSeries Image data that is presented or recorded. A stimulus template movie will be stored only as an image. When the image is presented as stimulus, additional data is required, such as field of view (e.g., how much of the visual field the image covers, or how what is the area of the target being imaged). If the OpticalSeries represents acquired imaging data, orientation is also important.
Class Details
Superclasses types.core.ImageSeries, types.untyped.GroupClass
Sealed false
Construct on load false
Constructor Summary
OpticalSeries Constructor for OpticalSeries 
Property Summary
comments Human-readable comments about the TimeSeries. This second descriptive field can be used to store additional information, or descriptive information if the primary description field is populated with a computer-readable string. 
control Numerical labels that apply to each time point in data for the purpose of querying and slicing data by these values. If present, the length of this array should be the same size as the first dimension of data. 
control_description Description of each control value. Must be present if control is present. If present, control_description[0] should describe time points where control == 0. 
data Data values. Data can be in 1-D, 2-D, 3-D, or 4-D. The first dimension should always represent time. This can also be used to store binary data (e.g., image frames). This can also be a link to data stored in an external file. 
data_conversion Scalar to multiply each element in data to convert it to the specified 'unit'. If the data are stored in acquisition system units or other units that require a conversion to be interpretable, multiply the data by 'conversion' to convert the data to the specified 'unit'. e.g. if the data acquisition system stores values in this object as signed 16-bit integers (int16 range -32,768 to 32,767) that correspond to a 5V range (-2.5V to 2.5V), and the data acquisition system gain is 8000X, then the 'conversion' multiplier to get from raw data acquisition values to recorded volts is 2.5/32768/8000 = 9.5367e-9. 
data_resolution Smallest meaningful difference between values in data, stored in the specified by unit, e.g., the change in value of the least significant bit, or a larger number if signal noise is known to be present. If unknown, use -1.0. 
data_unit Base unit of measurement for working with the data. Actual stored values are not necessarily stored in these units. To access the data in these units, multiply 'data' by 'conversion'. 
description Description of the time series. 
dimension Number of pixels on x, y, (and z) axes. 
distance Distance from camera/monitor to target/eye. 
external_file Paths to one or more external file(s). The field is only present if format='external'. This is only relevant if the image series is stored in the file system as one or more image file(s). This field should NOT be used if the image is stored in another NWB file and that file is linked to this file. 
external_file_starting_frame Each external image may contain one or more consecutive frames of the full ImageSeries. This attribute serves as an index to indicate which frames each file contains, to faciliate random access. The 'starting_frame' attribute, hence, contains a list of frame numbers within the full ImageSeries of the first frame of each file listed in the parent 'external_file' dataset. Zero-based indexing is used (hence, the first element will always be zero). For example, if the 'external_file' dataset has three paths to files and the first file has 5 frames, the second file has 10 frames, and the third file has 20 frames, then this attribute will have values [0, 5, 15]. If there is a single external file that holds all of the frames of the ImageSeries (and so there is a single element in the 'external_file' dataset), then this attribute should have value [0]. 
field_of_view Width, height and depth of image, or imaged area, in meters. 
format Format of image. If this is 'external', then the attribute 'external_file' contains the path information to the image files. If this is 'raw', then the raw (single-channel) binary data is stored in the 'data' dataset. If this attribute is not present, then the default format='raw' case is assumed. 
orientation Description of image relative to some reference frame (e.g., which way is up). Must also specify frame of reference. 
starting_time Timestamp of the first sample in seconds. When timestamps are uniformly spaced, the timestamp of the first sample can be specified and all subsequent ones calculated from the sampling rate attribute. 
starting_time_rate Sampling rate, in Hz. 
starting_time_unit Unit of measurement for time, which is fixed to 'seconds'. 
timestamps Timestamps for samples stored in data, in seconds, relative to the common experiment master-clock stored in NWBFile.timestamps_reference_time. 
timestamps_interval Value is '1' 
timestamps_unit Unit of measurement for timestamps, which is fixed to 'seconds'. 
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. 
  validate_comments  
  validate_control  
  validate_control_description  
  validate_data  
  validate_data_conversion  
  validate_data_resolution  
  validate_data_unit  
  validate_description  
  validate_dimension  
  validate_distance  
  validate_external_file  
  validate_external_file_starting_frame  
  validate_field_of_view  
  validate_format  
  validate_orientation  
  validate_starting_time  
  validate_starting_time_rate  
  validate_timestamps  
Event Summary