Scripting API

btkGetAnalog

Module BTKAcquisitionAccessor

Description#

Extracts one analog channel from the given acquisition based on an index or a string.

Parameters#

hHandle pointing to a C++ btk::Acquisition object.
idxInteger containing the index of the analog channel to extract.
labelString containing the label of the analog channel to extract.

Returned Values#

valuesMatrix of reals (n,1) containing the analog data.
infostructure with the informations related to the analog channels.
  • info.label: True label of the extracted channel
  • info.description: Description of the extracted channel
  • info.gain: Gain (integer) for the extracted channel
  • info.offset: Numerical offset (integer) for the extracted channel
  • info.scale: Scaling factor (float) for the extracted channel
  • info.frequency: Analog's frequency
  • info.units: Unit (string) for the extracted channel

Detailed Description#

Notes#

See also#

btkSetAnalogDescription, btkSetAnalogLabel, btkSetAnalogOffset, btkSetAnalogScale, btkSetAnalogValues

Syntax#

[values, info] = btkGetAnalog(h, idx)
[values, info] = btkGetAnalog(h, label)

Examples#