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

Container class to store data of a btkMetaData object. More...

Public Member Functions

def __eq__
 
def __ne__
 
def Clone
 
def GetDimension
 
def GetDimensions
 
def GetDimensionsProduct
 
def GetFormat
 
def GetFormatAsString
 
def GetValueNumber
 
def ResizeDimensions
 
def SetDimension
 
def SetDimensions
 
def SetFormat
 
def SetValue
 
def SetValues
 
def ToDouble
 
def ToInt
 
def ToString
 

Static Public Attributes

 Byte = _btk.btkMetaDataInfo_Byte
 
 Char = _btk.btkMetaDataInfo_Char
 
 Integer = _btk.btkMetaDataInfo_Integer
 
 Real = _btk.btkMetaDataInfo_Real
 

Detailed Description

Container class to store data of a btkMetaData object.

Container class to store data of a MetaData object.

You can store integer value(s), real or string. This class has also methods to convert the native type into other, like integer into string.

Even if the data extracted are set as native Python type, the internal type are different and set as:
 - btk.btkMetaDataInfo.Char: Type for the string;
 - btk.btkMetaDataInfo.Byte: Signed integer type stored only on 8 bit. Possible values between -127 and 128;
 - btk.btkMetaDataInfo.Integer: Signed integer type stored only on 16 bit. Possible values between -32767 and 32768;
 - btk.btkMetaDataInfo.Real: Float type. Precision limited to 1e-5.
 
Note: The format btk.btkMetaDataInfo.Byte cannot be set using the method SetValues() do the impossibility to differentiate an integer. You need to use explicitly the method SetFormat().

Member Function Documentation

def btk.btkMetaDataInfo.__eq__ (   self,   args  )
__eq__(self, rRHS) -> bool
def btk.btkMetaDataInfo.__ne__ (   self,   args  )
__ne__(self, rRHS) -> bool
def btk.btkMetaDataInfo.Clone (   self )
Clone(self) -> btkMetaDataInfo

Deep copy of the object
def btk.btkMetaDataInfo.GetDimension (   self,   args  )
GetDimension(self, idx) -> int
def btk.btkMetaDataInfo.GetDimensions (   self )
GetDimensions(self) -> btkIntArray
def btk.btkMetaDataInfo.GetDimensionsProduct (   self,
  start = 0 
)
GetDimensionsProduct(self, start=0) -> int
GetDimensionsProduct(self) -> int

Compute the product of the dimensions from the given start index.
def btk.btkMetaDataInfo.GetFormat (   self )
GetFormat(self) -> btkMetaDataInfo_impl::Format

Returns the internal format of the values.
def btk.btkMetaDataInfo.GetFormatAsString (   self )
GetFormatAsString(self) -> std::string

Returns the format of the values as a string.
def btk.btkMetaDataInfo.GetValueNumber (   self )
GetValueNumber(self) -> int
def btk.btkMetaDataInfo.ResizeDimensions (   self,   args  )
ResizeDimensions(self, nb)

Resize the dimensions and adapt the values and their structure. If the number of dimensions is greater, then the new dimensions are equal to 1. If the number of dimensions is lower, then the value are shrunken.
def btk.btkMetaDataInfo.SetDimension (   self,   args  )
SetDimension(self, idx, val)
def btk.btkMetaDataInfo.SetDimensions (   self,   args  )
SetDimensions(self, dims)
def btk.btkMetaDataInfo.SetFormat (   self,   args  )
SetFormat(self, btk.btkMetaDataInfo.Format)

Sets the format of the values and adapt the values. This method erases the values and set default values ('0' or a string with white spaces).
def btk.btkMetaDataInfo.SetValue (   self,   args  )
SetValue(self, idx, val)
SetValue(self, idx, val)
SetValue(self, idx, val)
def btk.btkMetaDataInfo.SetValues (   self,   args  )
SetValues(self, val)
SetValues(self, val)
SetValues(self, val)
SetValues(self, val)
SetValues(self, val)
SetValues(self, val)
SetValues(self, dims, val)
SetValues(self, dims, val)
SetValues(self, dims, val)
def btk.btkMetaDataInfo.ToDouble (   self,   args  )
ToDouble(self, idx) -> double
ToDouble(self) -> btkDoubleArray

Convert stored value(s) into double(s).
def btk.btkMetaDataInfo.ToInt (   self,   args  )
ToInt(self, idx) -> int
ToInt(self) -> btkIntArray

Convert stored value(s) into integer(s).
def btk.btkMetaDataInfo.ToString (   self,   args  )
ToString(self, idx) -> std::string const
ToString(self) -> btkStringArray

Convert stored value(s) into string(s).

Member Data Documentation

btk.btkMetaDataInfo.Byte = _btk.btkMetaDataInfo_Byte
static

Enum value which represents the signed 8-bit integers.

btk.btkMetaDataInfo.Char = _btk.btkMetaDataInfo_Char
static

Enum value which represents the string.

btk.btkMetaDataInfo.Integer = _btk.btkMetaDataInfo_Integer
static

Enum value which represents the the signed 16-bit integers.

btk.btkMetaDataInfo.Real = _btk.btkMetaDataInfo_Real
static

Enum value which represents the floats.