Scripting API

btkGetPoints

Module BTKAcquisitionAccessor

Description#

Extracts points from the given acquisition.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.

Returned Values#

pointsdictionnary with the point' values. Each fieldname corresponds to an point's label (see note #1).
pointsInfodictionnary with the informations related to the points.
  • pointsInfo["firstframe"]: Index of the first frame ;
  • pointsInfo["frequency"]: Point's frequency ;
  • pointsInfo["units"]: dictionnary with the unit (string) of each point ;
  • pointsInfo["label"]: dictionnary with the true label of each point ;
  • pointsInfo["description"]: dictionnary with the description of each point ;

Detailed Description#

Notes#

Note #1: Check the page dictionnaryFieldnameFormat to understand how the fieldnames are formated.

See also#

btkGetAngles, btkGetForces, btkGetMarkers, btkGetMoments, btkGetPowers

Syntax#

(points, pointsInfo) = btkGetPoints(h)

Examples#