types.core.SpatialSeries - MATLAB File Help
types.core.SpatialSeries
  SpatialSeries Direction, e.g., of gaze or travel, or position. The TimeSeries::data field is a 2D array storing position or direction relative to some reference frame. Array structure: [num measurements] [num dimensions]. Each SpatialSeries has a text dataset reference_frame that indicates the zero-position, or the zero-axes for direction. For example, if representing gaze direction, 'straight-ahead' might be a specific pixel on the monitor, or some other point in space. For position data, the 0,0 point might be the top-left corner of an enclosure, as viewed from the tracking camera. The unit of data will indicate how to interpret SpatialSeries values.
Class Details
Superclasses types.core.TimeSeries
Sealed false
Construct on load false
Constructor Summary
SpatialSeries Constructor for SpatialSeries 
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 
help Short description of what this type of NWBContainer contains. 
reference_frame Description defining what exactly 'straight-ahead' means. 
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_help  
  validate_reference_frame  
  validate_starting_time  
  validate_starting_time_rate  
  validate_timestamps  
Event Summary