Scripting API

btkNewAcquisition

Module BTKAcquisitionModifier

Description#

Creates a new and initialized acquisition.

Parameters#

pnNumber of points.
fnNumber of frames.
anNumber of analog channels.
rNumber of analog samples per video frame.

Returned Values#

hHandle pointing to the newly created C++ btk::Acquisition object.

Detailed Description#

btkNewAcquisition() returns an uninitialized and empty acquisition. The use of the function btkSetFrameNumber, btkSetPointNumber, btkSetAnalogNumber is then required to set properly the information of the acquistion. It is impossible to set directly data if the acquisition is uninitialized. The members of the acquisition are initialized to:
  • First frame equals to 1: use btkSetFirstFrame to modify it.
  • Points' frequency equals to 0: btkSetFrequency to modify it.
  • Points' units set to "mm", "deg", "N", "Nmm", "W", "" for markers, angles, forces, moments, powers and scalars respectively: use btkSetPointsUnit to modify them.
  • Analogs' frequency equals to 0. Updated when the points' frequency is.
  • Analog channel resolution sets to 12 bits: use btkSetAnalogResolution to modify it.
  • Number of analog samples per video frame set to 1.
btkNewAcquisition(pn) returns an uninitialized acquisition with pn points and 0 frame. The use of the function btkSetFrameNumber is then required to set properly the number of frames. It is impossible to set directly data if the acquisition is uninitialized. There is no analog channels. The points created are labeled with the string "uname*" and their index (e.g. uname_1, uname_2, ...). They are also tagged with the type "Marker". To change the type of theses points, use btkSetPointType or btkSetPointType.

Notes#

See also#

Syntax#

h = btkNewAcquisition()
h = btkNewAcquisition(pn)
h = btkNewAcquisition(pn, fn)
h = btkNewAcquisition(pn, fn, an)
h = btkNewAcquisition(pn, fn, an, r)

Examples#