LTPDA Toolbox™

Method ao/join

  JOIN multiple AOs into a single AO.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: JOIN multiple AOs into a single AO.
               If any two AOs overlap, then the values from the first appear
               in the output AO. 
  
               Note: If the input AOs are of type 'tsdata', then they will
               be sorted in ascending order according the t0 of each
               object. Additionally, if the 'sort' plist key is set to
               true, then the output data will be sorted according to the
               x-values (not applicable for cdata AOs).
  
 
  CALL:        bs = join(a1,a2,a3,...,pl)
               bs = join(as,pl)
               bs = as.join(pl)
 
  INPUTS:      aN   - input analysis objects
               as   - input analysis objects array
               pl   - input parameter list
 
  OUTPUTS:     b    - output analysis object
 
  Parameters Description
 
  REMARK:      Input AOs should be of the same type; if not, only AOs of the
               type of the first input AO will be joined together to produce
               the output.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Method Details
Access	public
Defining Class	ao
Sealed	0
Static	0

Parameter Description

Sets for this method …
Default

Default
no description
Key	Default Value	Options	Description
join
ZEROFILL	0	0 1	Fills with zeros the gaps between the data points of the subsequent aos.
SAMET0	0	0 1	Does not recalculate t0 but uses the common one. Note: the t0 among different objects must be the same!
FSTOL	9.9999999999999995e-07	none	Relative tolerance between sampling frequency of different objects. Jitter in the sampling frequency by less than this amount will be neglected. If the difference is more than the set value, an error will occur.
SORT	1	1 0	Sort the output data by their x-values.

Example
plist('ZEROFILL', [false], 'SAMET0', [false], 'FSTOL', [9.9999999999999995e-07], 'SORT', [true])

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

Method: ao/index

Method: ao/len

Method ao/join

Parameter Description

Default

Example