btk::DelsysEMGFileIO Class Reference

Interface to read Delsys EMG files. More...

#include <btkDelsysEMGFileIO.h>

Inheritance diagram for btk::DelsysEMGFileIO:

Public Types
typedef btkSharedPtr< const DelsysEMGFileIO >	ConstPointer
typedef btkSharedPtr < DelsysEMGFileIO >	Pointer
Public Types inherited from btk::AcquisitionFileIO
enum	ByteOrder { OrderNotApplicable = 0, IEEE_LittleEndian, VAX_LittleEndian, IEEE_BigEndian }
typedef btkSharedPtr< const AcquisitionFileIO >	ConstPointer
enum	FileType { TypeNotApplicable, ASCII, Binary }
enum	InternalsUpdateOption {   UpdateNotApplicable = 0, NoUpdate = UpdateNotApplicable, DataBasedUpdate = 1, MetaDataBasedUpdate = 2,   FileFormatOption = 512 }
typedef btkSharedPtr < AcquisitionFileIO >	Pointer
enum	StorageFormat { StorageNotApplicable = 0, Float = -1, Integer = 1 }

Public Member Functions
virtual bool	CanReadFile (const std::string &filename)
int	GetFileVersion () const
virtual void	Read (const std::string &filename, Acquisition::Pointer output)
Public Member Functions inherited from btk::AcquisitionFileIO
virtual bool	CanWriteFile (const std::string &filename)=0
ByteOrder	GetByteOrder () const
std::string	GetByteOrderAsString () const
FileType	GetFileType () const
int	GetInternalsUpdateOptions () const
StorageFormat	GetStorageFormat () const
std::string	GetStorageFormatAsString () const
virtual const Extensions &	GetSupportedExtensions () const =0
bool	HasInternalsUpdateOption (int option) const
void	SetByteOrder (ByteOrder b)
void	SetInternalsUpdateOptions (int options)
void	SetStorageFormat (StorageFormat s)
virtual void	Write (const std::string &filename, Acquisition::Pointer input)=0

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from btk::AcquisitionFileIO
static bool	HasReadOperation ()
static bool	HasWriteOperation ()

Protected Member Functions
	DelsysEMGFileIO ()
Protected Member Functions inherited from btk::AcquisitionFileIO
	AcquisitionFileIO (FileType f=TypeNotApplicable, ByteOrder b=OrderNotApplicable, StorageFormat s=StorageNotApplicable, int internalsUpdate=UpdateNotApplicable)
void	SetFileType (FileType f)
virtual	~AcquisitionFileIO ()

Additional Inherited Members
Protected Attributes inherited from btk::AcquisitionFileIO
ByteOrder	m_ByteOrder
FileType	m_FileType
int	m_InternalsUpdate
StorageFormat	m_StorageFormat

Detailed Description

Interface to read Delsys EMG files.

The Delsys EMG file format is used in Delsys systems and saved by the software EMGWorks. All the known file format (1-4) are implemented. The exported acquisition contains raw EMG signals.

This parser is based on the source code of the Delsys company which give us the rights to use it. The implementation is an adaption of the Matlab file 'loademg3.m'.

Member Typedef Documentation

btk::DelsysEMGFileIO::ConstPointer

Smart pointer associated with a const DelsysEMGFileIO object.

btk::DelsysEMGFileIO::Pointer

Smart pointer associated with a DelsysEMGFileIO object.

Constructor & Destructor Documentation

btk::DelsysEMGFileIO::DelsysEMGFileIO ( )

protected

Constructor.

Member Function Documentation

bool btk::DelsysEMGFileIO::CanReadFile ( const std::string &  filename )

virtual

Check if the beginning of the file starts with the string "DEMG".

Implements btk::AcquisitionFileIO.

int btk::DelsysEMGFileIO::GetFileVersion ( ) const

inline

Returns the file format version of the read file.

static DelsysEMGFileIO::Pointer btk::DelsysEMGFileIO::New ( )

inlinestatic

Create a DelsysEMGFileIO object an return it as a smart pointer.

void btk::DelsysEMGFileIO::Read ( const std::string &  filename, Acquisition::Pointer  output  )

virtual

Read the file designated by filename and fill output.

Implements btk::AcquisitionFileIO.