Method ao/setToffset


  SETTOFFSET sets the 'toffset' property of the ao with tsdata
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: SETTOFFSET sets the 'toffset' property of the ao with tsdata
 
  CALL:        objs.setToffset(val);
               objs.setToffset(plist('toffset', val));
               objs = objs.setToffset(val);
 
  INPUTS:      objs: Can be a vector, matrix, list, or a mix of them.
               val:  In seconds
                  1. Single value e.g. [2]
                       Each AO in objs get this value.
                  2. Single value in a cell-array e.g. {12.1}
                       Each AO in objs get this value.
                  3. cell-array with the same number of values as in objs
                     e.g. {7, 5, 12.2} and 3 AOs in objs
                       Each AO in objs get its corresponding value from the
                       cell-array
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
setToffset
TOFFSET NaN none Time offset from t0 to the first data sample in seconds.

Example

plist('TOFFSET', [NaN])

back to top back to top

Some information of the method ao/setToffset are listed below:
Class name ao
Method name setToffset
Category Helper
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 1
Max input args -1
Min output args 1
Max output args -1
Can be used as modifier 1
Supported numeric types {'double'}




©LTP Team