|
BTK Python wrapper
0.3dev.0
Python bindings for the Biomechanical ToolKit library (BTK)
|
Coordinates of a point in a 3D space along the time. More...
Public Member Functions | |
| def | Clone |
| def | GetData |
| def | GetDescription |
| def | GetFrameNumber |
| def | GetLabel |
| def | GetResidual |
| def | GetResiduals |
| def | GetTimestamp |
| def | GetType |
| def | GetValue |
| def | GetValues |
| def | SetData |
| def | SetDataSlice |
| def | SetDescription |
| def | SetFrameNumber |
| def | SetLabel |
| def | SetResidual |
| def | SetResiduals |
| def | SetType |
| def | SetValue |
| def | SetValues |
| def | Update |
Static Public Attributes | |
| Angle = _btk.btkPoint_Angle | |
| Force = _btk.btkPoint_Force | |
| Marker = _btk.btkPoint_Marker | |
| Moment = _btk.btkPoint_Moment | |
| Power = _btk.btkPoint_Power | |
| Reaction = _btk.btkPoint_Reaction | |
| Scalar = _btk.btkPoint_Scalar | |
Coordinates of a point in a 3D space along the time.
The coordinates of the point are generally measured by an acquisition system. For each frame, the 3D value has a residual. It can provide informations on the quality of these 3D data (residual associated with the reconstruction of the marker). This class is also used to represent angles, forces, moments, powers and scalars. To know/set the type of the point, you can use the methods GetType() and SetType(). The type has a limited range of possible values and are listed in the following enumeration: - btk.btkPoint.Marker: Set the point object as a marker; - btk.btkPoint.Angle: Set the point object as an angle; - btk.btkPoint.Force: Set the point object as a force; - btk.btkPoint.Moment: Set the point object as a moment; - btk.btkPoint.Power: Set the point object as a power; - btk.btkPoint.Scalar: Set the point object as a scalar along the time; - btk.btkPoint.Reaction: Special type to indicate the point corresponds to one part of a wrench (not really used); Note: In some case the values at specific frames are invalid (mainly due to marker's occlusion). To detect if the frame is invalid, you can check the residual which will be set to the value -1. It is the same thing if you want to set the frame as invalid. You can set the values of the frames to 0 and the associated residual to -1. Note: A residual with a value equal to 0 means that this frame has been post-processed (interpolation, filtering, etc.).
| def btk.btkPoint.Clone | ( | self | ) |
Clone(self) -> btkPoint Deep copy of the object.
| def btk.btkPoint.GetData | ( | self | ) |
GetData(self) -> btkPointData Return the data of this point
| def btk.btkPoint.GetDescription | ( | self | ) |
GetDescription(self) -> std::string const & Returns the point's description.
| def btk.btkPoint.GetFrameNumber | ( | self | ) |
GetFrameNumber(self) -> int const Returns the number of frames.
| def btk.btkPoint.GetLabel | ( | self | ) |
GetLabel(self) -> std::string const & Returns the point's label.
| def btk.btkPoint.GetResidual | ( | self, | args | ) |
GetResidual(self, idx) -> double Returns only one residual for the given frame.
| def btk.btkPoint.GetResiduals | ( | self | ) |
GetResiduals(self) -> array (NumPy) Returns the point's residuals.
| def btk.btkPoint.GetTimestamp | ( | self | ) |
GetTimestamp(self) -> unsigned long Returns the timestamp of the object.
| def btk.btkPoint.GetType | ( | self | ) |
GetType(self) -> btkPoint_impl::Type const Returns the point's type.
| def btk.btkPoint.GetValue | ( | self, | args | ) |
GetValue(self, row, col) -> double Returns only one value for the given component and frame.
| def btk.btkPoint.GetValues | ( | self | ) |
GetValues(self) -> array (NumPy) Returns the point's values. WARNING:You cannot set values using this method. Use the methods SetValues of SetValue for that.
| def btk.btkPoint.SetData | ( | self, | args | ) |
SetData(self, btkPointData, parenting = true) SetData(self, btkPointData, parenting = true) Sets the data of this point. By default, this object will take the parent of the data. Setting 'parenting' to false will unparent the old data, assign the new one, but doesn't set the point as its parent.
| def btk.btkPoint.SetDataSlice | ( | self, | args | ) |
SetDataSlice(self, arg2, arg3, arg4, arg5, res=0.0) SetDataSlice(self, arg2, arg3, arg4, arg5) Convenient method to easily set the coordinates x,y,z and the residual for the given frame. WARNING: This function is not safe. There is no checking to determine if the frame is out of range or not. It has the advantage to be faster.
| def btk.btkPoint.SetDescription | ( | self, | args | ) |
SetDescription(self, string) Sets the point's description.
| def btk.btkPoint.SetFrameNumber | ( | self, | args | ) |
SetFrameNumber(self, int) Sets the number of frames.
| def btk.btkPoint.SetLabel | ( | self, | args | ) |
SetLabel(self, string) Sets the point's label.
| def btk.btkPoint.SetResidual | ( | self, | args | ) |
SetResidual(self, int, double) Sets only one residual for the given frame.
| def btk.btkPoint.SetResiduals | ( | self, | args | ) |
SetResiduals(self, array) Sets the point's residuals.
| def btk.btkPoint.SetType | ( | self, | args | ) |
SetUnit(self, int) Sets the point's type.
| def btk.btkPoint.SetValue | ( | self, | args | ) |
SetValue(self, int, int, double) Sets only one value for the given component and frame.
| def btk.btkPoint.SetValues | ( | self, | args | ) |
SetValues(self, array) Sets the point's values.
| def btk.btkPoint.Update | ( | self | ) |
Update(self) Updates the ProcessObject associated with this DataObject.
|
static |
Enum value which set the point object as an angle.
|
static |
Enum value which set the point object as a force.
|
static |
Enum value which set the point object as a marker.
|
static |
Enum value which set the point object as a moment.
|
static |
Enum value which set the point object as a power.
|
static |
Special type to indicate the point corresponds to one part of a wrench (not really used);
|
static |
Enum value which set the point object as a scalar.
1.8.5