|
BTK Python wrapper
0.3dev.0
Python bindings for the Biomechanical ToolKit library (BTK)
|
Store data which cannot be embedded within timeseries (calibration matrix, subject informations, ...). More...
Public Member Functions | |
| def | __eq__ |
| def | __ne__ |
| def | AppendChild |
| def | Begin |
| def | ClearChildren |
| def | Clone |
| def | End |
| def | ExtractChildInfo |
| def | FindChild |
| def | GetChild |
| def | GetChildNumber |
| def | GetDescription |
| def | GetInfo |
| def | GetLabel |
| def | GetTimestamp |
| def | GetUnlockState |
| def | HasChildren |
| def | HasInfo |
| def | HasMetaDataAsParent |
| def | InsertChild |
| def | RemoveChild |
| def | SetChild |
| def | SetDescription |
| def | SetInfo |
| def | SetLabel |
| def | SetUnlockState |
| def | TakeChild |
| def | Update |
Store data which cannot be embedded within timeseries (calibration matrix, subject informations, ...).
Store data which cannot be embedded within timeseries data (calibration matrix, subject informations, ...). Each object can store children metadata. Theoretically, the number of sub-level is infinite. However, the main common use of the metadata is to use 2 levels. This use was introduced in the C3D format. The values in a metadata are stored in a MetaDataInfo object and are accessible using the method GetInfo(). The unlock member accessible using the methods GetUnlock() and SetUnlock() doesn't affect the setting of the values, but is used only to inform the user/developer.
| def btk.btkMetaData.__eq__ | ( | self, | args | ) |
__eq__(self, rRHS) -> bool
| def btk.btkMetaData.__ne__ | ( | self, | args | ) |
__ne__(self, rRHS) -> bool
| def btk.btkMetaData.AppendChild | ( | self, | args | ) |
AppendChild(self, arg2) -> bool Append the child entry. If entry has a label which already exists in the parent's list, then it is not inserted. Returns True if child has been inserted or False.
| def btk.btkMetaData.Begin | ( | self | ) |
Begin(self) -> btkMetaDataIterator Returns an iterator to the beginning of the list of children.
| def btk.btkMetaData.ClearChildren | ( | self | ) |
ClearChildren(self) Removes every children.
| def btk.btkMetaData.Clone | ( | self | ) |
Clone(self) -> btkMetaData Deep copy of the object
| def btk.btkMetaData.End | ( | self | ) |
End(self) -> btkMetaDataIterator Returns an iterator just past the last child.
| def btk.btkMetaData.ExtractChildInfo | ( | self, | args | ) |
ExtractChildInfo(self, label, format, numdims, noPossibleEmptyValue = True) -> btkMetaDataInfo ExtractChildInfo(self, label, format, numdims, noPossibleEmptyValue = True) -> btkMetaDataInfo Check if a child exists with the given label and correspond to the given format plus the number of dimensions with or without values (noPossibleEmptyValue). The informations of the metadata are extracted if all the checks are ok. Otherwise, the methods return an empty pointer.
| def btk.btkMetaData.FindChild | ( | self, | args | ) |
FindChild(self, label) -> btkMetaDataIterator Finds the children which has the given label and return it as an iterator.
| def btk.btkMetaData.GetChild | ( | self, | args | ) |
GetChild(self, index) -> btkMetaData GetChild(self, index) -> btkMetaData Gets the entry for the given index or label. An exception is thrown is the given input doesn't correspond to any entry.
| def btk.btkMetaData.GetChildNumber | ( | self | ) |
GetChildNumber(self) -> int Returns the number of children
| def btk.btkMetaData.GetDescription | ( | self | ) |
GetDescription(self) -> std::string const &
| def btk.btkMetaData.GetInfo | ( | self | ) |
GetInfo(self) -> btkMetaDataInfo Gets the btkMetaDataInfo associated to the entry.
| def btk.btkMetaData.GetLabel | ( | self | ) |
GetLabel(self) -> std::string const &
| def btk.btkMetaData.GetTimestamp | ( | self | ) |
GetTimestamp(self) -> unsigned long Returns the timestamp of the object.
| def btk.btkMetaData.GetUnlockState | ( | self | ) |
GetUnlockState(self) -> bool const Gets the unlock state of the entry.
| def btk.btkMetaData.HasChildren | ( | self | ) |
HasChildren(self) -> bool Checks if the entry has children
| def btk.btkMetaData.HasInfo | ( | self | ) |
HasInfo(self) -> bool Checks if a btkMetaDataInfo is associated with the entry.
| def btk.btkMetaData.HasMetaDataAsParent | ( | self | ) |
HasMetaDataAsParent(self) -> bool Checks if this object has a MetaData object as parents.
| def btk.btkMetaData.InsertChild | ( | self, | args | ) |
InsertChild(self, btkMetaDataIterator, btkMetaData) -> bool InsertChild(self, int, btkMetaData) -> bool Insert the child entry for the given location. If the entry has a label which already exists in the parent's list, then it is not inserted. Returns True if child has been inserted or False.
| def btk.btkMetaData.RemoveChild | ( | self, | args | ) |
RemoveChild(self, btkMetaDataIterator) -> btkMetaDataIterator RemoveChild(self, int) RemoveChild(self, arg2) Removes the child entry which has the given index, label or corresponding iterator.
| def btk.btkMetaData.SetChild | ( | self, | args | ) |
SetChild(self, int, btkMetaData) Sets the child entry for the given index
| def btk.btkMetaData.SetDescription | ( | self, | args | ) |
SetDescription(self, string)
| def btk.btkMetaData.SetInfo | ( | self, | args | ) |
SetInfo(self, arg2) Sets the btkMetaDataInfo associated to the entry.
| def btk.btkMetaData.SetLabel | ( | self, | args | ) |
SetLabel(self, string) Sets the label of the entry. If label already exist in the parent's list, then an exception is thrown.
| def btk.btkMetaData.SetUnlockState | ( | self, | args | ) |
SetUnlockState(self, arg2) Sets the unlock state of the entry.
| def btk.btkMetaData.TakeChild | ( | self, | args | ) |
TakeChild(self, btkMetaDataIterator) -> btkMetaData TakeChild(self, int) -> btkMetaData TakeChild(self, string) -> btkMetaData Removes the child entry which has the given index, label or corresponding iterator. If there is no child with the specified label, then an empty pointer is returned.
| def btk.btkMetaData.Update | ( | self | ) |
Update(self) Updates the ProcessObject associated with this DataObject.
1.8.5