Scripting API

btkSetPointDescription

Module BTKPointModifier

Description#

Modifies point's description 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.
newdescString with the new description.

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#

  • btkSetPointDescription(h, index, newdesc) modifies the description of the point specified by the index idx.
  • btkSetPointDescription(h, label, newdesc) modifies the description of the point specified by the label label.

Notes#

See also#

btkSetPointLabel, btkSetPointType, btkSetPointsUnit

Syntax#

(points, pointsInfo) = btkSetPointDescription(h, index, newdesc)
(points, pointsInfo) = btkSetPointDescription(h, label, newdesc)

Examples#