|
BTK Python wrapper
0.3dev.0
Python bindings for the Biomechanical ToolKit library (BTK)
|
Interface to read/write acquisition's files. More...
Public Member Functions | |
| def | CanReadFile |
| def | CanWriteFile |
| def | GetByteOrder |
| def | GetByteOrderAsString |
| def | GetFileType |
| def | GetInternalsUpdateOptions |
| def | GetStorageFormat |
| def | GetStorageFormatAsString |
| def | HasInternalsUpdateOption |
| def | Read |
| def | SetByteOrder |
| def | SetInternalsUpdateOptions |
| def | SetStorageFormat |
| def | Write |
Static Public Attributes | |
| ASCII = _btk.btkAcquisitionFileIO_ASCII | |
| Binary = _btk.btkAcquisitionFileIO_Binary | |
| DataBasedUpdate = _btk.btkAcquisitionFileIO_DataBasedUpdate | |
| FileFormatOption = _btk.btkAcquisitionFileIO_FileFormatOption | |
| Float = _btk.btkAcquisitionFileIO_Float | |
| IEEE_BigEndian = _btk.btkAcquisitionFileIO_IEEE_BigEndian | |
| IEEE_LittleEndian = _btk.btkAcquisitionFileIO_IEEE_LittleEndian | |
| Integer = _btk.btkAcquisitionFileIO_Integer | |
| MetaDataBasedUpdate = _btk.btkAcquisitionFileIO_MetaDataBasedUpdate | |
| NoUpdate = _btk.btkAcquisitionFileIO_NoUpdate | |
| OrderNotApplicable = _btk.btkAcquisitionFileIO_OrderNotApplicable | |
| StorageNotApplicable = _btk.btkAcquisitionFileIO_StorageNotApplicable | |
| TypeNotApplicable = _btk.btkAcquisitionFileIO_TypeNotApplicable | |
| UpdateNotApplicable = _btk.btkAcquisitionFileIO_UpdateNotApplicable | |
| VAX_LittleEndian = _btk.btkAcquisitionFileIO_VAX_LittleEndian | |
Interface to read/write acquisition's files.
Interface to read/write acquisition's files, cannot be instanced.
| def btk.btkAcquisitionFileIO.CanReadFile | ( | self, | args | ) |
CanReadFile(self, filename) -> bool Checks if the given filename can be read by this AcquisitionFileIO. This methods should try to read the file header instead to check the file's suffix.
| def btk.btkAcquisitionFileIO.CanWriteFile | ( | self, | args | ) |
CanWriteFile(self, filename) -> bool Checks if the given filename can be write by this AcquisitionFileIO. This method should try to determine if the file's suffix corresponds to one of the supported file's suffixes by this btkAcquisitionFileIO.
| def btk.btkAcquisitionFileIO.GetByteOrder | ( | self | ) |
GetByteOrder(self) -> btkAcquisitionFileIO_impl::ByteOrder Gets the byte order of the file (only for binary file).
| def btk.btkAcquisitionFileIO.GetByteOrderAsString | ( | self | ) |
GetByteOrderAsString(self) -> std::string Gets the byte order as a string.
| def btk.btkAcquisitionFileIO.GetFileType | ( | self | ) |
GetFileType(self) -> btkAcquisitionFileIO_impl::FileType Gets the type of the file.
| def btk.btkAcquisitionFileIO.GetInternalsUpdateOptions | ( | self | ) |
GetInternalsUpdateOptions(self) -> int Returns the option(s) used to update internals.
| def btk.btkAcquisitionFileIO.GetStorageFormat | ( | self | ) |
GetStorageFormat(self) -> btkAcquisitionFileIO_impl::StorageFormat Return the format used to store points and analog channels.
| def btk.btkAcquisitionFileIO.GetStorageFormatAsString | ( | self | ) |
GetStorageFormatAsString(self) -> std::string Gets the storage format as a string.
| def btk.btkAcquisitionFileIO.HasInternalsUpdateOption | ( | self, | args | ) |
HasInternalsUpdateOption(self, option) -> bool Returns true if the given @a option is used or false if not.
| def btk.btkAcquisitionFileIO.Read | ( | self, | args | ) |
Read(self, filename, output) Read the file designated by the given filename and fill the given btkAcquisition
| def btk.btkAcquisitionFileIO.SetByteOrder | ( | self, | args | ) |
SetByteOrder(self, b) Sets the byte order of the file.
| def btk.btkAcquisitionFileIO.SetInternalsUpdateOptions | ( | self, | args | ) |
SetInternalsUpdateOptions(self, options) Sets the option(s) used to update internals.
| def btk.btkAcquisitionFileIO.SetStorageFormat | ( | self, | args | ) |
SetStorageFormat(self, s) Set the format used to store points and analog channels.
| def btk.btkAcquisitionFileIO.Write | ( | self, | args | ) |
Write(self, filename, input) Write the file designated by the given filename with the content of the given btkAcquisition.
|
static |
Enum value for ASCII file.
|
static |
Enum value for binary file.
|
static |
Internals are updated using acquisition data (points, analog channels, events).
|
static |
Extension for specific file format extension. It is important to distinguish each new option by adding 2-based integer (i.e. 1, 2, 4, 8, 16, etc.).
|
static |
Acquisition's data are stored as float values.
|
static |
Enum value for a byte order in big endian with a IEEE float representation.
|
static |
Enum value for a byte order in little endian with a IEEE float representation.
|
static |
Acquisition's data are stored as integer values.
|
static |
Internals are updated using acquisition metadata.
|
static |
Same as AcquisitionFileIO::UpdateNotApplicable.
|
static |
Enum value used to indicate the byte order is not yet known.
|
static |
Acquisition's data have no storage format.
|
static |
Enum value used to indicate the type of the file is not yet known.
|
static |
No update is done and existing internals are used.
|
static |
Enum value for a byte order in little endian with a VAX float representation.
1.8.5