types.core.ImageMaskSeries - MATLAB File Help
types.core.ImageMaskSeries
  ImageMaskSeries An alpha mask that is applied to a presented visual stimulus. The data[] array contains an array of mask values that are applied to the displayed image. Mask values are stored as RGBA. Mask can vary with time. The timestamps array indicates the starting time of a mask, and that mask pattern continues until it's explicitly changed.
Class Details
Superclasses types.core.ImageSeries
Sealed false
Construct on load false
Constructor Summary
ImageMaskSeries Constructor for ImageMaskSeries 
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 element in data[]. COMMENT: Optional field. If present, the control array should have the same number of elements as data[]. 
control_description Description of each control value. COMMENT: Array length should be as long as the highest number in control minus one, generating an zero-based indexed array for control values. 
data Data values. Can also store binary data (eg, image frames) COMMENT: This field may be a link to data stored in an external file, especially in the case of raw data. 
data_conversion Scalar to multiply each element in data to convert it to the specified unit 
data_resolution Smallest meaningful difference between values in data, stored in the specified by unit. COMMENT: 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 The base unit of measure used to store data. This should be in the SI unit. COMMENT: This is the SI unit (when appropriate) of the stored data, such as Volts. If the actual data is stored in millivolts, the field 'conversion' below describes how to convert the data to the specified SI unit. 
description Description of TimeSeries 
dimension Number of pixels on x, y, (and z) axes. 
external_file Path or URL to one or more external file(s). Field only present if format=external. NOTE: this is only relevant if the image 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 HDF5 file and that file is HDF5 linked to this file. 
external_file_starting_frame Each entry is the frame number (within the full ImageSeries) of the first frame in the corresponding external_file entry. This serves as an index to what frames each file contains, allowing random access.Zero-based indexing is used. (The first element will always be zero). 
format Format of image. If this is 'external' then the field external_file contains the path or URL information to that file. For tiff, png, jpg, etc, the binary representation of the image is stored in data. If the format is raw then the fields bit_per_pixel and dimension are used. For raw images, only a single channel is stored (eg, red). 
help Short description of what this type of NWBContainer contains. 
masked_imageseries Link to ImageSeries that mask is applied to. 
starting_time The timestamp of the first sample. COMMENT: When timestamps are uniformly spaced, the timestamp of the first sample can be specified and all subsequent ones calculated from the sampling rate. 
starting_time_rate Sampling rate, in Hz COMMENT: Rate information is stored in Hz 
starting_time_unit Value is 'Seconds' 
timestamps Timestamps for samples stored in data.COMMENT: Timestamps here have all been corrected to the common experiment master-clock. Time is stored as seconds and all timestamps are relative to experiment start time. 
timestamps_interval Value is '1' 
timestamps_unit Value is '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_external_file  
  validate_external_file_starting_frame  
  validate_format  
  validate_help  
  validate_masked_imageseries  
  validate_starting_time  
  validate_starting_time_rate  
  validate_timestamps  
Event Summary