Scripting API

btkSetPointType

Module BTKPointModifier

Description#

Modifies point's type and returns updated points.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
indexInteger containing the index of the point to modify.
labelString containing the label of the point to modify.
newtypeString with the new type (see the detailed description for the available types).

Returned Values#

pointsUpdated list of points. Its format is the same than using the function
pointsInfoUpdated informations related to the points. Its format is the same than using the function

Detailed Description#

  • btkSetPointType(h, idx, newtype) modifies the type of the point specified by the index idx.
  • btkSetPointType(h, label, newtype) modifies the type of the point specified by the label label.
The type must be a string corresponding to one of the following type:
  • marker ;
  • angle ;
  • force ;
  • moment ;
  • power ;

Notes#

See also#

btkSetPointDescription, btkSetPointLabel, btkSetPointsUnit

Syntax#

(points, pointsInfo) = btkSetPointType(h, index, newtype)
(points, pointsInfo) = btkSetPointType(h, label, newtype)

Examples#