Scripting API

btkGetPoint

Module BTKAcquisitionAccessor

Description#

Extracts one point from the given acquisition based on an index or a string.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
idxInteger containing the index of the point to extract.
labelString containing the label of the point to extract.

Returned Values#

valuesMatrix of reals (n,3) with X,Y,Z components.
infostructure with some informations related to the extracted point.
  • info.label: True label of the point ;
  • info.description: Description of the point ;
  • info.frequency: Point's frequency ;
  • info.units: Unit associated with the point.

Detailed Description#

Notes#

See also#

btkSetPointValues, btkGetAnalog, btkSetPointType, btkSetPointsUnit, btkSetPointNumber

Syntax#

[values, info] = btkGetPoint(h, idx)
[values, info] = btkGetPoint(h, label)

Examples#