BTK Matlab Wrapper  0.3dev.0
Matlab bindings for the Biomechanical ToolKit library (BTK)
btkMergeAcquisitions Class Reference

Description

Merge or contatenate the given acquisitions.

Syntax:
h = btkMergeAcquisitions(h1, h2, ...)
Parameters
h1Handle pointing to a C++ btk::Acquisition object.
h2Handle pointing to a C++ btk::Acquisition object.
...Others handle
Return values
hNew handle pointing to a C++ btk::Acquisition object containing the data of the inputs.
Detailed description:
The release of the memory associated with the handle h can be done automatically by Matlab when you use the command clear all, or you can use the function btkDeleteAcquisition. The use of the function btkDeleteAcquisition is greatly advised when you are doing batch processing as Matlab does not manage the C++ memory and an "Out of memory" error could be thrown.

The difference between the merging or the concatenating depends of the acquisitions' informations.

If the acquisitions are exactly the same (same label for points and analog channels) and the first frame of the n+1th acquistion corresponds to the last frame of the nth acquistion, then the acquisitions are merged, otherwise, the data are concatenated. Merged acquisitions means that the output will have the same number of points, analog channels, events than each output but the number of frames corresponds to the sum of the inputs' frame number.

Rules to merge/concatenate acquisitions are:
  • Must have the same acquisition frequency (or 0) if there are points.
  • Must have the same number of analog samples per point frame (if there are points and analog channels).
  • Must have the same analog resolution if there are .
  • Must have the same units.
  • Must have the same global frame orientation (check POINT:X_SCREEN and POINT:Y_SCREEN)
  • The first input which has a non-zero acquisition frequency is used.
  • The first input which has analog channels is used to set the analog resolution of the output.

Actions during the merging/concatenation:
  • If the first frame of the nth acquisition correspond to the last frame + 1 of the nth-1 acquisition, AND the points / analog channels correspond exactly, then acquisitions are truncated.
  • If the first frame of two inputs are not the same, the final acquisition is adapted to contain the number of frames plus the difference between the first frame of each input.
  • If points have the same label (and the first frames doesn't correspond), then, the second and more are incremented (i.e. from Heel to Heel_2).
  • Idem for the analog channels.
  • Events with the same label, context, id and time are merged.
  • Metadata (if number of inputs greater than 1):
    • Only metdata defined by the user are inserted (i.e. POINT, ANALOG, EVENTS, etc. are not inserted as they are only used in a C3D file.).
    • If metadata are equivalent or equal, then they are merged, else the metadata is appended with a suffix (i.e. from STATIC_CALIBRATION:USED to STATIC_CALIBRATION:USED_2)