Scripting API

btkSetAnalogGain

Module BTKAnalogModifier

Description#

Modifies analog's gain 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.
newgainInteger wit the new gain (see the detailed description to know the possible gain).

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#

  • btkSetAnalogGain(h, idx, newgain) modifies the gain of the analog channel specified by the index idx.
  • btkSetAnalogGain(h, label, newgain) modifies the gain of the analog channel specified by the label label.
The available values for the new gain are:
  • 0 : unknown gain
  • 1 : +/- 10 volts
  • 2 : +/- 5 volts
  • 3 : +/- 2.5 volts
  • 4 : +/- 1.25 volts
  • 5 : +/- 1 volt

Notes#

See also#

btkGetAnalog, btkSetAnalogDescription, btkSetAnalogLabel, btkSetAnalogOffset, btkSetAnalogScale, btkSetAnalogUnit, btkSetAnalogValues

Syntax#

(analogs, analogsInfo) = btkSetAnalogGain(h, idx, newgain)
(analogs, analogsInfo) = btkSetAnalogGain(h, label, newgain)

Examples#