Scripting API

btkSetAnalogScale

Module BTKAnalogModifier

Description#

Modifies analog's scale and returns updated analogs.

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.
newscaleReal with the new scale factor to convert between numerical to analog value.

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#

  • btkSetAnalogScale(h, idx, newscale) modifies the scale factor of the analog channel specified by the index idx.
  • btkSetAnalogScale(h, label, newscale) modifies the scale factor of the analog channel specified by the label label.

Notes#

See also#

btkGetAnalog, btkSetAnalogDescription, btkSetAnalogGain, btkSetAnalogLabel, btkSetAnalogOffset, btkSetAnalogUnit, btkSetAnalogValues

Syntax#

(analogs, analogsInfo) = btkSetAnalogScale(h, idx, newscale)
(analogs, analogsInfo) = btkSetAnalogScale(h, label, newscale)

Examples#