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

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

Public Member Functions

def GetAcquisitionIO
 
def GetFilename
 
def GetInput
 
def GetInputNumber
 
def GetOutputNumber
 
def GetTimestamp
 
def GetValidInputNumber
 
def ResetState
 
def SetAcquisitionIO
 
def SetFilename
 
def SetInput
 
def Update
 

Detailed Description

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

Writer of acquisition data into acquisition file (C3D, TRC, ...).

Member Function Documentation

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

Returns the btkAcquisitionIO used to write the given acquisition
def btk.btkAcquisitionFileWriter.GetFilename (   self )
GetFilename(self) -> std::string const &

Gets the filename of the file to write.
def btk.btkAcquisitionFileWriter.GetInput (   self )
GetInput(self) -> btkAcquisition

Returns the btkAcquisition to write by a btkAcquisitionIO helper class
def btk.btkAcquisitionFileWriter.GetInputNumber (   self )
GetInputNumber(self) -> int

Returns the number of inputs.
def btk.btkAcquisitionFileWriter.GetOutputNumber (   self )
GetOutputNumber(self) -> int

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

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

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

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

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

Specifies the file to write. This is forwarded to the IO instance.
def btk.btkAcquisitionFileWriter.SetInput (   self,   args  )
SetInput(self, arg2)

Sets the btkAcquisition to write by a btkAcquisitionIO helper class
def btk.btkAcquisitionFileWriter.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.