BTK Python wrapper  0.3dev.0
Python bindings for the Biomechanical ToolKit library (BTK)
Public Member Functions | List of all members
btk.btkAcquisitionFileReader Class Reference

Reader for files which contain acquisition data (C3D, TRC, ...). More...

Public Member Functions

def GetAcquisitionIO
 
def GetDisableFilenameExceptionState
 
def GetFilename
 
def GetInputNumber
 
def GetOutput
 
def GetOutputNumber
 
def GetTimestamp
 
def GetValidInputNumber
 
def ResetState
 
def SetAcquisitionIO
 
def SetDisableFilenameExceptionState
 
def SetFilename
 
def Update
 

Detailed Description

Reader for files which contain acquisition data (C3D, TRC, ...).

Reader for files which contain acquisition data (C3D, TRC, ...).

This class uses a btkAcquisitionFileIO object to read the data from the file corresponding to the given filename.
You have two ways to set this object.
First, you can set it manually by using the method btkAcquisitionFileReader::SetAcquisitionIO(),
Second, the correct object can be detected automatically, by checking in each registered btkAcquisitionFileIO if it can read or not the file.

The use of the manual setting should be only used if you want to read a file with a selected file format. To go back to the automatic mode 
from the manual mode, you only have to use the method btkAcquisitionFileReader::SetAcquisitionIO() without any argument.

Member Function Documentation

def btk.btkAcquisitionFileReader.GetAcquisitionIO (   self )
GetAcquisitionIO(self) -> btkAcquisitionFileIO

Returns the btkAcquisitionIO used to read the given file.
def btk.btkAcquisitionFileReader.GetDisableFilenameExceptionState (   self )
GetDisableFilenameExceptionState(self) -> bool

Returns state of the disabling of the exception for missing filename.
def btk.btkAcquisitionFileReader.GetFilename (   self )
GetFilename(self) -> std::string const &

Gets the filename of the file to read.
def btk.btkAcquisitionFileReader.GetInputNumber (   self )
GetInputNumber(self) -> int

Returns the number of inputs.
def btk.btkAcquisitionFileReader.GetOutput (   self )
GetOutput(self) -> btkAcquisition

Returns the btkAcquisition read from the btkAcquisitionIO helper class.
def btk.btkAcquisitionFileReader.GetOutputNumber (   self )
GetOutputNumber(self) -> int

Returns the number of outputs.
def btk.btkAcquisitionFileReader.GetTimestamp (   self )
GetTimestamp(self) -> unsigned long

Returns the timestamp of the object.
def btk.btkAcquisitionFileReader.GetValidInputNumber (   self )
GetValidInputNumber(self) -> int

Returns the number of inputs which are valid (i.e. not null).
def btk.btkAcquisitionFileReader.ResetState (   self )
ResetState(self)

Reset the state of the process. Usefull when an exception was thrown during the generation of the data.
def btk.btkAcquisitionFileReader.SetAcquisitionIO (   self,   args  )
SetAcquisitionIO(self, io=btkAcquisitionFileIO())
SetAcquisitionIO(self)

Set the btkAcquisitionIO helper class. This method forces the btkAcquisitionIO to be used to read a particular file.
The btkAcquisitionIO is ofently created via the object factory mechanism that determines whether a particular btkAcquisitionIO can read a certain file.
def btk.btkAcquisitionFileReader.SetDisableFilenameExceptionState (   self,   args  )
SetDisableFilenameExceptionState(self, bool)

Enable/disable exception for the missing of the filename.
def btk.btkAcquisitionFileReader.SetFilename (   self,   args  )
SetFilename(self, string)

Specifies the file to read. This is forwarded to the IO instance.
def btk.btkAcquisitionFileReader.Update (   self )
Update(self)

Update the pipeline and then all the data inside. Recursive method which
 1) determines the processes to update
 2) generate the data by using the GenerateData() method.