Documentation/Wrapping/Matlab/btk/@Common/btkGetAnalogs.m
function [analogs analogsInfo] = btkGetAnalogs(h) %#ok
%BTKGETANALOGS Extract analogs from a biomechanical acquisition
% 
%  ANALOGS = BTKGETANALOGS(H) returns a structure of analogs.  Each 
%  fieldname in ANALOGS corresponds to an adapted analog channel's label compatible
%  with Matlab fieldname's rules (no accent, first character must be a letter, only
%  [A-Z,a-z,_] characters accepted).
%
%  The biomechanical acquisition handle H is represented as a double and 
%  can be only used with the btk* functions.
%
%  [ANALOGS ANALOGSINFO] = BTKGETANALOGS(H) returns analogs' informations  
%  in ANALOGSINFO.  The structure ANALOGSINFO has the followig fields:
%    - ANALOGSINFO.LABEL
%    - ANALOGSINFO.DESCRIPTION
%    - ANALOGSINFO.GAIN
%    - ANALOGSINFO.OFFSET
%    - ANALOGSINFO.SCALE
%    - ANALOGSINFO.FREQUENCY
%    - ANALOGSINFO.UNITS
%  ANALOGSINFO.LABEL and ANALOGSINFO.DESCRIPTION contains the (true) label and
%  description of the analog channels.  ANALOGSINFO.GAIN, ANALOGSINFO.OFFSET and
%  ANALOGSINFO.SCALE contains the required parameters to convert the digital measure
%  into its analog variant. ANALOGSINFO.FREQUENCY contains the analogs' frequency. 
%  ANALOGSINFO.UNITS contains the unit of each analog channel.  
%  Each fieldname in ANALOGSINFO.LABEL, ANALOGSINFO.DESCRIPTION, and ANALOGSINFO.UNITS
%  corresponds to adapted analog channel's label. 

%  Author: A. Barré
%  Copyright 2009-2014 Biomechanical ToolKit (BTK).

% The following comment, MATLAB compiler pragma, is necessary to avoid 
% compiling this M-file instead of linking against the MEX-file.  Don't remove.
%# mex

error(generatemsgid('NotSupported'),'MEX file for BTKGETANALOGS not found');

% [EOF] btkGetAnalogs.m

