Scripting API

btkGetAnalogs

Module BTKAnalogAccessor

Description#

Extracts analog channels from the given biomechanical acquisition.

Parameters#

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

Returned Values#

analogsdictionnary with the analogs' values. Each field corresponds to an analog channel's label (see note #1).
analogsInfodictionnary with the informations related to the analog channels.
  • analogsInfo["label"]: dictionnary with the (true) label of each analog channels.
  • analogsInfo["description"]: dictionnary with the description of each analog channels.
  • analogsInfo["gain"]: dictionnary with the gain (integer) of each analog channels.
  • analogsInfo["offset"]: dictionnary with the numerical offset (integer) of each analog channels.
  • analogsInfo["scale"]: dictionnary with the scaling factor (float) of each analog channels.
  • analogsInfo["frequency"]: Analog's frequency
  • analogsInfo["units"]: dictionnary with the unit (string) of each analog channels.

Detailed Description#

Notes#

Note #1: Check the page dictionnaryFieldnameFormat to understand how the field's name are formated.

See also#

btkGetAnalogsValues

Syntax#

(analogs, analogsInfo) = btkGetAnalogs(h)

Examples#