LTPDA Toolbox™ contents Method: ao/spikecleaning   Method: ao/spsd

Method ao/split

  SPLIT split an analysis object into the specified segments.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: SPLIT split an analysis object into the specified segments.
 
  CALL:        b = split(a, pl)
 
  INPUTS:      a  - input analysis object
               pl - input parameter list (see below for parameters)
 
  OUTPUTS:     b  - array of analysis objects
 
 
  EXAMPLES:    1.) split method by frequency. Get the values from 10-100 Hz
                   pl = plist('frequencies', [10 100]);
                   ao_new = split(a1, pl);
 
               2.) split method by time.
                   Get the values from 0.0 to 1.0 Seconds AND from 1.0 to 2.5 seconds
                   pl = plist('times', [0.0 1.0 1.0 2.5]);
                   ao_new = split(a1, pl);
 
               3.) split method by samples.
                   Get the samples from 1 to 50 AND from 150 to 200.
                   pl = plist('samples',     [1 50 150 200]);
                   ao_new = split(a1, pl);
 
               4.) split method by time length.
                   split the AO into pices with the same time length.
                   By default splits this type by time length rounded to
                   the nearest integer multiple of fs. (see 'round time'
                   parameter)
                   pl = plist('time length', 100);
                   ao_new = split(a1, pl);
 
               5.) split method by length.
                   split AO into segments of length N samples
                   pl = plist('length', 100);
                   ao_new = split(a1, pl);
 
               6.1) Select an interval with strings
                    --> t0 = time('14:00:00')
                    pl = plist('start_time', '14:00:01', ...
                               'end_time',   '14:00:02');
                    ao_new = split(a1, pl);
 
                    --> t0 = time('14:00:00')
                    pl = plist('start_time', '14:00:01', ...
                               'duration',   '00:00:02');
                    ao_new = split(a1, pl);
 
                    Select an interval with seconds
                    --> t0 = time(3)
                    pl = plist('start_time', 5, ...
                               'end_time',   7);
                    ao_new = split(a1, pl);
 
               6.2) Select an interval with time objects
                    --> t0 = time('14:00:00')
                    pl = plist('start_time', time('14:00:01'), ...
                               'end_time',   time('14:00:03'));
                    ao_new = split(a1, pl);
 
                    --> t0 = time(3)
                    pl = plist('start_time', time(5), ...
                               'duration',   time(2));
                    ao_new = split(a1, pl);
 
               6.3) Select an interval with a time span object
                    --> t0 = time('14:00:00')
                    ts = timespan('14:00:00', '14:00:05');
                    pl = plist('timespan', ts);
                    ao_new = split(a1, pl);
                    ao_new = split(a1, ts);
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Sets for this method …
Default
By Times
By Offsets
By Frequencies
By Samples
By Time Length
By Length
By Chunks
By Interval Start/End
By Interval Start/Duration
By Interval Timespan
By Matching

Default
no description
Key Default Value Options Description
split
TIMES [] none Split the ao into time segments.
An array of start/stop times to split by. The times should be relative
to the object reference time (t0).

Example
plist('TIMES', [[]])

back to top back to top

By Times
no description
Key Default Value Options Description
split
TIMES [] none Split the ao into time segments.
An array of start/stop times to split by. The times should be relative
to the object reference time (t0).

Example
plist('TIMES', [[]])

back to top back to top

By Offsets
no description
Key Default Value Options Description
split
OFFSETS [] none Split the ao into time segments.
An array of start/stop offsets to split by. Positive offsets are relative
to the first sample. A negative offset is taken from the end of the vector.
For example [10 -10] removes 10 seconds from the beginning and end of the vector. An end time of 0 indicates the end of the vector.

Example
plist('OFFSETS', [[]])

back to top back to top

By Frequencies
no description
Key Default Value Options Description
split
FREQUENCIES [] none An array of start/stop frequencies to split by.

Example
plist('FREQUENCIES', [[]])

back to top back to top

By Samples
no description
Key Default Value Options Description
split
SAMPLES [] none An array of start/stop samples to split by.

Example
plist('SAMPLES', [[]])

back to top back to top

By Time Length
no description
Key Default Value Options Description
split
TIME LENGTH [] none Split ao into segments of length N seconds.
ROUND TIME 1
  • 1
  • 0
 Rounds the time to multiple of fs (N*fs).
SELECT OBJECT [] none This parameter is usually used by the rebuild method. With this parameter can you define the index which object of the output objects you want to get back.

Example
plist('TIME LENGTH', [[]], 'ROUND TIME', [true], 'SELECT OBJECT', [[]])

back to top back to top

By Length
no description
Key Default Value Options Description
split
LENGTH [] none Split ao into segments of length N samples.

Example
plist('LENGTH', [[]])

back to top back to top

By Chunks
no description
Key Default Value Options Description
split
N, CHUNKS [] none Split into N contiguous pieces.
MATCH 1
  • 1
  • 0
 Define if the last chunk should keep any remaining data samples.

Example
plist('N', [[]], 'MATCH', [true])

back to top back to top

By Interval Start/End
no description
Key Default Value Options Description
split
START_TIME 1970-01-01 00:00:00.000 UTC none Start time can be either a string or a time object.
END_TIME 1970-01-01 00:00:00.000 UTC none End time can be either a string or a time object.

Example
plist('START_TIME', time(plist('MILLISECONDS', [0])) , 'END_TIME', time(plist('MILLISECONDS', [0])) )

back to top back to top

By Interval Start/Duration
no description
Key Default Value Options Description
split
START_TIME 1970-01-01 00:00:00.000 UTC none Start time can be either a string or a time object.
DURATION 1970-01-01 00:00:00.000 UTC none Duration can be either a string or a time object.

Example
plist('START_TIME', time(plist('MILLISECONDS', [0])) , 'DURATION', time(plist('MILLISECONDS', [0])) )

back to top back to top

By Interval Timespan
no description
Key Default Value Options Description
split
TIMESPAN (start: 1970-01-01 00:00:00.000 UTC end: 1970-01-01 00:00:00.000 UTC) none The start/end time are specified in the time span object.

Example
plist('TIMESPAN', [timespan()])

back to top back to top

By Matching
no description
Key Default Value Options Description
split
MATCH [] none Give an array of input AOs which will form the template for the output AOs. If time-series AOs are given, the data will be split according to the times in these AOs. Similarly, if frequency series AOs are given, the data will be split on the frequencies of these inputs.

Example
plist('MATCH', [[]])

back to top back to top

Some information of the method ao/split are listed below:
Class name ao
Method name split
Category Signal Processing
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 0
Supported numeric types {'double'}



Method: ao/spikecleaning  Method: ao/spikecleaning   Method: ao/spsd Method: ao/spsd

©LTP Team