Scripting API

btkSetAnalogDescription

Module BTKAnalogModifier

Description#

Modifies the analog's description and returns a list of the updated analog channels.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
idxInteger containing the index of the analog channel to modify.
labelString containing the label of the analog channel to modify.
newdescString with the new description.

Returned Values#

analogsUpdated list of analog channels. Its format is the same than using the function
analogsInfoUpdated informations related to the analog channels. Its format is the same than using the function

Detailed Description#

  • btkSetAnalogDescription(h, idx, newdesc) modifies the description of the analog channel specified by the index idx.
  • btkSetAnalogDescription(h, label, newdesc) modifies the description of the analog channel specified by the label label.

Notes#

See also#

btkGetAnalog, btkSetAnalogGain, btkSetAnalogLabel, btkSetAnalogOffset, btkSetAnalogScale, btkSetAnalogUnit, btkSetAnalogValues

Syntax#

[analogs, analogsInfo] = btkSetAnalogDescription(h, idx, newdesc)
[analogs, analogsInfo] = btkSetAnalogDescription(h, label, newdesc)

Examples#