BTK  0.3dev.0
Open-source library to visualize/process biomechanical data
Classes | Typedefs | Functions | Variables
btk Namespace Reference

The "btk" namespace contains all Biomechanical ToolKit (BTK) classes. More...

Classes

class  Acquisition
 Contains the data related to a biomechanical acquisition. More...
 
class  AcquisitionFileIO
 Interface to read/write acquisition's files. More...
 
class  AcquisitionFileIOFactory
 Manage all the acquisition file IOs and detect if a file is readable or writable. More...
 
class  AcquisitionFileIOHandle
 Store properties of a acquisition file IO. More...
 
class  AcquisitionFileIORegister
 Interface to add dynamicaly an acquisition file I/O in the factory. More...
 
class  AcquisitionFileReader
 Reader for files which contain acquisition data (C3D, TRC, ...). More...
 
class  AcquisitionFileReaderException
 Exception class for the AcquisitionFileReader class. More...
 
class  AcquisitionFileWriter
 Writer of acquisition data into acquisition file (C3D, TRC, ...). More...
 
class  AcquisitionFileWriterException
 Exception class for the AcquisitionFileWriter class. More...
 
class  AcquisitionUnitConverter
 Convert the units of the given input for points and analog channels. More...
 
class  AMTIForcePlatformFileIO
 Interface to read/write AMTIForcePlatform files. More...
 
class  AMTIForcePlatformFileIOException
 Exception class for the AMTIForcePlatformFileIO class. More...
 
class  Analog
 Analog channel data along the time. More...
 
class  AnalogOffsetRemover
 Remove a possible analog offset to the selected analog channels. More...
 
class  ANBFileIO
 Interface to read/write ANB files. More...
 
class  ANBFileIOException
 Exception class for the ANBFileIO class. More...
 
class  ANCFileIO
 Interface to read/write ANC files. More...
 
class  ANCFileIOException
 Exception class for the ANCFileIO class. More...
 
class  ANGFileIO
 Interface to read/write ANG files. More...
 
class  ANGFileIOException
 Exception class for the ANGFileIO class. More...
 
class  ASCIIFileWriter
 Writer of acquisition data into ASCII/Text file. More...
 
class  ASCIIFileWriterException
 Exception class for the ASCIIFileWriter class. More...
 
class  BinaryFileStream
 An abstract class which read/write binary file in VAX and IEEE floating format with the corresponding byte order. More...
 
class  BSFFileIO
 Interface to read/write BSF files. More...
 
class  BSFFileIOException
 Exception class for the BSFFileIO class. More...
 
class  C3DFileIO
 Interface to read/write C3D files. More...
 
class  C3DFileIOException
 Exception class for the C3DFileIO class. More...
 
class  CALForcePlateFileIO
 Interface to read/write CAL files containing calibration of force platform. More...
 
class  CALForcePlateFileIOException
 Exception class for the CALForcePlateFileIO class. More...
 
class  CLBFileIO
 Interface to read/write CLB files. More...
 
class  CLBFileIOException
 Exception class for the CLBFileIO class. More...
 
class  Collection
 List of objects. More...
 
class  CollectionAssembly
 Group together a set of collections of the same type. More...
 
class  ConversionError
 Bad conversion exception class. More...
 
class  DataObject
 Input and output entry for processes in pipelines. More...
 
class  DataObjectLabeled
 DataObject with a label and a description. More...
 
class  DelsysEMGFileIO
 Interface to read Delsys EMG files. More...
 
class  DelsysEMGFileIOException
 Exception class for the DelsysEMGFileIO class. More...
 
class  DomainError
 Logic error exception. More...
 
class  DownsampleFilter
 Downsample data stored in the given input. More...
 
class  EMFFileIO
 Interface to read/write EMF files. More...
 
class  EMFFileIOException
 Exception class for the EMFFileIO class. More...
 
class  EMxFileIO
 Interface to read/write EMx files. More...
 
class  EMxFileIOException
 Exception class for the EMxFileIO class. More...
 
class  Event
 Label a specific time/frame during an acquisition. More...
 
class  Exception
 General class for exception. More...
 
class  ForcePlatform
 Base class for all type of force platform. More...
 
class  ForcePlatformsExtractor
 Extracts force platform data from a btk::Acquisition object. More...
 
class  ForcePlatformType
 Convenient class to represent a concrete force platform. More...
 
class  ForcePlatformWrenchFilter
 Calcule the wrench of the center of the force platform data, expressed in the global frame (by default). More...
 
class  GroundReactionWrenchFilter
 Transform force platform data into ground reaction wrenches. More...
 
class  GRxFileIO
 Interface to read/write GRx files. More...
 
class  GRxFileIOException
 Exception class for the GRxFileIO class. More...
 
class  IEEEBigEndianBinaryFileStream
 Class to read and write binary file encoded from a IEEE (BE) to a VAX (LE) and IEEE (LE, BE) processor. More...
 
class  IEEELittleEndianBinaryFileStream
 Class to read and write binary file encoded from a IEEE (LE) to a VAX (LE) and IEEE (LE, BE) processor. More...
 
class  IMU
 Container of analog channels representing an inertial measurement unit (IMU). More...
 
class  IMUsExtractor
 Extracts inertial measurement units (IMUs) from a btk::Acquisition object. More...
 
class  IMUType
 Convenient class to represents a concrete IMU. More...
 
class  KistlerDATFileIO
 Interface to read Kistler DAT files. More...
 
class  KistlerDATFileIOException
 Exception class for the KistlerDATFileIO class. More...
 
class  Logger
 Log mechanism to display debug message, warnings and errors. More...
 
class  LogicError
 Logic error exception. More...
 
class  MDFFileIO
 Interface to read MDF/MDR files (Codamotion). More...
 
class  MDFFileIOException
 Exception class for the MDFFileIO class. More...
 
class  Measure
 Measure with d dimensions along the time. More...
 
class  MeasureData
 Template class to store data for any kind of measurement. More...
 
class  MeasureFrameExtractor
 Extracts a frame from a collection of btk::Measure objects. More...
 
struct  MeasureTraits
 Trait used to determine the type of data and the number of components used for a measure. More...
 
struct  MeasureTraits< Analog >
 
struct  MeasureTraits< Point >
 
class  MergeAcquisitionFilter
 Merges or concatenates two or more btk::Acquisition objects into a single new one. More...
 
class  MetaData
 Store data which cannot be embedded within timeseries data (calibration matrix, subject informations, ...). More...
 
class  MetaDataInfo
 Container class to store data of a MetaData object. More...
 
class  mmfilebuf
 File buffer using the the memory mapped mechanism. More...
 
class  mmfstream
 Provides an interface to read/write data from files as input/output streams. More...
 
class  MOMFileIO
 Interface to read/write MOM files. More...
 
class  MOMFileIOException
 Exception class for the MOMFileIO class. More...
 
class  MotionAnalysisBinaryFileIO
 Acquisition IO abstract class used for the Motion Analysis ANB/TRB file format. More...
 
class  MotionAnalysisBinaryFileIOException
 Exception class for the MotionAnalysisBinaryFileIO class. More...
 
class  MultiSTLFileWriter
 Writer of acquisition data into multiple STL binary file format. More...
 
class  MultiSTLFileWriterException
 Exception class for the MultiSTLFileWriter class. More...
 
class  NativeBinaryFileStream
 Native binary file stream chosen by the used compiler. More...
 
class  NullPtr
 To simplify the API when testing a shared pointer to know if it is null or not. More...
 
class  Object
 Base for all objects which need to keep track of modified time. More...
 
class  OutOfRangeException
 Out of range exception. More...
 
class  Point
 Coordinates of a point in a 3D space along the time. More...
 
class  ProcessObject
 Interface to create a filter/process in a pipeline. More...
 
class  PWRFileIO
 Interface to read/write PWR files. More...
 
class  PWRFileIOException
 Exception class for the PWRFileIO class. More...
 
class  RAxFileIO
 Interface to read/write RAx files. More...
 
class  RAxFileIOException
 Exception class for the RAxFileIO class. More...
 
class  RICFileIO
 Interface to read/write RIC files. More...
 
class  RICFileIOException
 Exception class for the RICFileIO class. More...
 
class  RuntimeError
 Runtime error exception. More...
 
class  SeparateKnownVirtualMarkersFilter
 Separate a collection of points in five categories to be able to distinguish real markers from the others. More...
 
class  SpecializedPointsExtractor
 Extracts only the points corresponding to the given type (without cloning the extracted points). More...
 
class  SubAcquisitionFilter
 Extract a subpart of the acquisition. More...
 
class  TDFFileIO
 Interface to read/write ANG files. More...
 
class  TDFFileIOException
 Exception class for the TDFFileIO class. More...
 
class  TRBFileIO
 Interface to read/write TRB files. More...
 
class  TRBFileIOException
 Exception class for the TRBFileIO class. More...
 
class  TRCFileIO
 Interface to read/write TRC files. More...
 
class  TRCFileIOException
 Exception class for the TRCFileIO class. More...
 
class  TriangleMesh
 Read-only class representing a triangle mesh based on markers's IDs and links between them. More...
 
class  VAXLittleEndianBinaryFileStream
 Class to read and write binary file encoded from a VAX (LE) processor to a VAX (LE) and IEEE (LE, BE) processor. More...
 
class  VerticalGroundReactionForceGaitEventDetector
 Detect heel strike and toe-off events during gait from vertical ground reaction wrench. More...
 
class  Wrench
 Represents a wrench as position, force and moment varying during the time. More...
 
class  WrenchDirectionAngleFilter
 Calculate the direction angle of the force vector for each wrench. More...
 
class  XLSOrthoTrakFileIO
 Class to read XLSOrthoTrak files. More...
 
class  XLSOrthoTrakFileIOException
 Exception class for the XLSOrthoTrakFileIO class. More...
 
class  XMOVEFileIO
 Interface to read XMOVE/MDR files (Codamotion). More...
 
class  XMOVEFileIOException
 Exception class for the XMOVEFileIO class. More...
 

Typedefs

typedef Collection< AnalogAnalogCollection
 
typedef RawFileStream::failure BinaryFileStreamFailure
 
typedef Collection< EventEventCollection
 
typedef Collection< ForcePlatformForcePlatformCollection
 
typedef ForcePlatformType< 1, 6, 6 > ForcePlatformType1
 
typedef ForcePlatformType< 2, 6, 6 > ForcePlatformType2
 
typedef ForcePlatformType< 3, 8, 8 > ForcePlatformType3
 
typedef ForcePlatformType< 4, 6, 6 > ForcePlatformType4
 
typedef ForcePlatformType< 5, 8, 6 > ForcePlatformType5
 
typedef ForcePlatformType< 6, 12, 12 > ForcePlatformType6
 
typedef Collection< IMUIMUCollection
 
typedef IMUType< 1 > IMUType1
 
typedef IMUType< 2 > IMUType2
 
typedef Collection< PointPointCollection
 
typedef btk::mmfstream RawFileStream
 
typedef Collection< WrenchWrenchCollection
 

Functions

template<class T >
void DownsampleData (int ratio, btkSharedPtr< T > input, btkSharedPtr< T > output)
 
template<>
void DownsampleData< Wrench > (int ratio, Wrench::Pointer input, Wrench::Pointer output)
 
template<>
void DownsampleData< WrenchCollection > (int ratio, WrenchCollection::Pointer input, WrenchCollection::Pointer output)
 
template<typename T >
void FromString (const std::string &source, T &target)
 
template<typename T >
void FromString (const std::vector< std::string > &source, std::vector< T > &target)
 
template<typename T >
FromString (const std::string &source)
 
template<typename T >
void MetaDataCollapseChildrenValues (std::vector< T > &target, MetaData::ConstPointer parent, const std::string &baselabel, int targetFinalSize=-1, const T &blankReplacement=T())
 
MetaData::Pointer MetaDataCreateChild (MetaData::Pointer parent, const std::string &label)
 
template<typename T >
void MetaDataCreateChild (MetaData::Pointer parent, const std::string &label, const T &val)
 
template<typename T >
void MetaDataCreateChild (MetaData::Pointer parent, const std::string &label, const std::vector< T > &val)
 
template<typename T >
void MetaDataCreateChild (MetaData::Pointer parent, const std::string &label, const std::vector< T > &val, int numCol)
 
template<typename T >
bool operator!= (btkSharedPtr< T > const &lhs, btkNullPtr< T > const &rhs)
 
template<typename T >
bool operator!= (btkSharedPtr< const T > const &lhs, btkNullPtr< T > const &rhs)
 
template<typename T >
bool operator!= (btkNullPtr< T > const &lhs, btkSharedPtr< T > const &rhs)
 
template<typename T >
bool operator!= (btkNullPtr< T > const &lhs, btkSharedPtr< const T > rhs)
 
template<typename T >
bool operator!= (btkSharedPtr< T > const &lhs, btkNullPtr< T >(*rhs)())
 
template<typename T >
bool operator!= (btkSharedPtr< const T > const &lhs, btkNullPtr< T >(*rhs)())
 
template<typename T >
bool operator!= (btkNullPtr< T >(*lhs)(), btkSharedPtr< T > const &rhs)
 
template<typename T >
bool operator!= (typename T::NullPointer(*lhs)(), btkSharedPtr< T > const &rhs)
 
template<typename T >
bool operator!= (btkNullPtr< T >(*lhs)(), btkSharedPtr< const T > const &rhs)
 
template<typename T >
bool operator!= (typename T::NullPointer(*lhs)(), btkSharedPtr< const T > const &rhs)
 
template<typename T >
bool operator== (btkSharedPtr< T > const &lhs, btkNullPtr< T > const &rhs)
 
template<typename T >
bool operator== (btkSharedPtr< const T > const &lhs, btkNullPtr< T > const &rhs)
 
template<typename T >
bool operator== (btkNullPtr< T > const &lhs, btkSharedPtr< T > const &rhs)
 
template<typename T >
bool operator== (btkNullPtr< T > const &lhs, btkSharedPtr< const T > rhs)
 
bool operator== (const Event &rLHS, const Event &rRHS)
 
template<typename T >
bool operator== (btkSharedPtr< T > const &lhs, btkNullPtr< T >(*rhs)())
 
template<typename T >
bool operator== (btkSharedPtr< const T > const &lhs, btkNullPtr< T >(*rhs)())
 
template<typename T >
bool operator== (btkNullPtr< T >(*lhs)(), btkSharedPtr< T > const &rhs)
 
template<typename T >
bool operator== (typename T::NullPointer(*lhs)(), btkSharedPtr< T > const &rhs)
 
template<typename T >
bool operator== (btkNullPtr< T >(*lhs)(), btkSharedPtr< const T > rhs)
 
template<typename T >
bool operator== (typename T::NullPointer(*lhs)(), btkSharedPtr< const T > rhs)
 
bool operator== (const MetaData &rLHS, const MetaData &rRHS)
 
bool operator== (const MetaDataInfo &rLHS, const MetaDataInfo &rRHS)
 
template<typename S >
std::string ToString (const S &source)
 
template<typename S >
void ToString (const std::vector< S > &source, std::vector< std::string > &target)
 
template<>
std::string ToString< bool > (const bool &toConvert)
 
template<>
std::string ToString< double > (const double &toConvert)
 
template<>
std::string ToString< float > (const float &toConvert)
 
template<>
std::string ToString< int8_t > (const int8_t &toConvert)
 
template<>
std::string ToString< long double > (const long double &toConvert)
 
template<>
std::string ToString< std::string > (const std::string &toConvert)
 

Variables

 BTK_ACQUISITON_FILE_IO_FACTORY_INIT
 

Detailed Description

The "btk" namespace contains all Biomechanical ToolKit (BTK) classes.

The Biomechanical ToolKit Copyright (c) 2009-2013, Arnaud Barré All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the following
  disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the following
  disclaimer in the documentation and/or other materials
  provided with the distribution.
* Neither the name(s) of the copyright holders nor the names
  of its contributors may be used to endorse or promote products
  derived from this software without specific prior written
  permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Typedef Documentation

Exception for the BinaryFileStream class and inherited classes.

Raw file stream used by the btk::BinaryFileStream class. Depending your configuration, this raw stream will correspond to btk::mmfstream (default) or std::fstream. The class btk::mmfstream uses the memory mapped file mechanism.

Warning
It is not adviced to used this class directly. Even if you can potentially speedup data's reading by accessing directly to the buffer, it is also a large source of error and crash (buffer overlfow, etc.)

Function Documentation

template<class T >
void btk::DownsampleData ( int  ratio,
btkSharedPtr< T >  input,
btkSharedPtr< T >  output 
)
inline

Generic method to downsample data. Does nothing.

template<>
void btk::DownsampleData< Wrench > ( int  ratio,
Wrench::Pointer  input,
Wrench::Pointer  output 
)
inline

Specialized version to downsample wrench.

template<>
void btk::DownsampleData< WrenchCollection > ( int  ratio,
WrenchCollection::Pointer  input,
WrenchCollection::Pointer  output 
)
inline

Specialized version to downsample collection of wrenches.

template<typename T >
void btk::FromString ( const std::string &  source,
T &  target 
)
inline

General method to convert the string source to the wanted target.

template<typename T >
void btk::FromString ( const std::vector< std::string > &  source,
std::vector< T > &  target 
)
inline

Convenient method to convert a vector of string to the vector of wanted type T.

template<typename T >
T btk::FromString ( const std::string &  source)
inline

Convenient method to convert the string source to the wanted type T.

template<typename T >
bool btk::operator!= ( typename T::NullPointer(*)()  lhs,
btkSharedPtr< T > const &  rhs 
)
inline

Overload operator to fix a possible compilation error depending of the compiler used.

template<typename T >
bool btk::operator!= ( typename T::NullPointer(*)()  lhs,
btkSharedPtr< const T > const &  rhs 
)
inline

Overload operator to fix a possible compilation error depending of the compiler used.

bool btk::operator== ( const Event &  rLHS,
const Event &  rRHS 
)

Equality operator.

template<typename T >
bool btk::operator== ( typename T::NullPointer(*)()  lhs,
btkSharedPtr< T > const &  rhs 
)
inline

Overload operator to fix a possible compilation error depending of the compiler used.

template<typename T >
bool btk::operator== ( typename T::NullPointer(*)()  lhs,
btkSharedPtr< const T >  rhs 
)
inline

Overload operator to fix a possible compilation error depending of the compiler used.

bool btk::operator== ( const MetaData &  rLHS,
const MetaData &  rRHS 
)

Equality operator. Doesn't check the parent's value.

bool btk::operator== ( const MetaDataInfo &  rLHS,
const MetaDataInfo &  rRHS 
)

Equality operator.

template<typename S >
std::string btk::ToString ( const S &  source)
inline

Stringify the source.

template<typename S >
void btk::ToString ( const std::vector< S > &  source,
std::vector< std::string > &  target 
)
inline

Conveniant method to stringify the vector source to a vector of string.

template<>
std::string btk::ToString< bool > ( const bool &  toConvert)
inline

Explicit method to stringify a boolean.

template<>
std::string btk::ToString< double > ( const double &  toConvert)
inline

Explicit method to stringify a double. The precision of the stringification is std::numeric_limits<double>::digits10.

template<>
std::string btk::ToString< float > ( const float &  toConvert)
inline

Explicit method to stringify a float. The precision of the stringification is std::numeric_limits<float>::digits10.

template<>
std::string btk::ToString< int8_t > ( const int8_t &  toConvert)
inline

Explicit method to stringify an int8_t (string the decimal number and not the hex value).

template<>
std::string btk::ToString< long double > ( const long double &  toConvert)
inline

Explicit method to stringify a long double. The precision of the stringification is std::numeric_limits<long double>::digits10.

template<>
std::string btk::ToString< std::string > ( const std::string &  toConvert)
inline

Explicit method to stringify a string This method only return toConvert.

Variable Documentation

btk::BTK_ACQUISITON_FILE_IO_FACTORY_INIT

List of all the acquisition file IO supported in BTK.