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

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.
SORT TIMES 1
  • 1
  • 0
Sort the input objects by their T0s.
MERGE 0
  • 0
  • 1
Rather than join input tsdata sequentially the merge option combines overlapping data and then drops duplicates. Ignores fill zeros.
DUPTOL 0.0050000000000000001 none The time interval tolerance to consider two consecutive samples as duplicates. Only used when merge is set to true.
JOINAXIS 'x'
  • 'x'
  • 'y'
For the case of joining 3D data, choose the axis on which to perform the join.

Example

plist('ZEROFILL', [false], 'SAMET0', [false], 'FSTOL', [9.9999999999999995e-07], 'SORT', [true], 'SORT TIMES', [true], 'MERGE', [false], 'DUPTOL', [0.0050000000000000001], 'JOINAXIS', 'x')

back to top back to top

Some information of the method ao/join are listed below:
Class name ao
Method name join
Category Helper
Package name ltpda
Can be used as modifier 1
Supported numeric types {'double'}




©LTP Team