Scripting API

btkGetPointsUnit

Module BTKPointAccessor

Description#

Returns requested points' unit.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
typeString with the type to modify (see the detailed description for the available types).

Returned Values#

unitString containing the unit for the requested point's type.

Detailed Description#

The type must be a string corresponding to one of the available type:
  • marker ;
  • angle ;
  • force ;
  • moment ;
  • power ;
By default an acquisition is set with these units:
  • marker: millimeter (mm) ;
  • angle: degres (deg) ;
  • force: newton (N) ;
  • moment: newton millimeter (Nmm) ;
  • power: watt (W) ;

Notes#

See also#

btkSetPointsUnit

Syntax#

unit = btkGetPointsUnit(h, type)

Examples#