Description

Read an acquisition's file (C3D, TRC, ...)

Syntax:: [h, byteOrder, storageFormat] = btkReadAcquisition(filename)

Parameters

filename Path of the file to load.

Return values

h	Handle pointing to a C++ btk::Acquisition object.
byteOrder	String containing the byte order of the file (see note #1).
storageFormat	String containing the storage format used in the file (see note #2).

Detailed description:

This function returns an handle h of a biomechanical acquisition stored in file filename. This handle is returned as a double and can be only used with the btk* function. The release of the memory associated with the handle h can be done automatically by Matlab when you use the command clear all, or you can use the function btkCloseAcquisition. The use of the function btkCloseAcquisition is greatly advised when you are doing batch processing as Matlab does not manage the C++ memory and an "Out of memory" error could be thrown.

For more informations about the file formats read by BTK, check the Read and written files in BTK page.

Note #1: The possible values for the byte order are:

OrderNotApplicable: in the case the file is an ASCII file ;
IEEE_LittleEndian: Native format for the INTEL-PC processor ;
VAX_LittleEndian: Native format for the DEC processor ;
IEEE_BigEndian: Native format for the MIPS/PPC processor.

Note #2: The possible values for the storage format are:

StorageNotApplicable: in the case the file is an ASCII file.
Float: Values are stored on 4 bytes as a real.
Integer: Values are stored on 2 bytes as integer and are scaled.

See Also: btkCloseAcquisition, btkWriteAcquisition