pybvh 0.1.0__tar.gz

pybvh-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 yho67
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pybvh-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+prune bvh_data
+prune tutorials
+prune tests
+exclude *.ipynb
+exclude *.DS_Store

pybvh-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: pybvh
+Version: 0.1.0
+Summary: BVH reader/writer and kinematics utilities
+Author-email: Victor Schneider <victor.schneider67@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/VictorS-67/pybvh
+Project-URL: Repository, https://github.com/VictorS-67/pybvh
+Project-URL: Issues, https://github.com/VictorS-67/pybvh/issues
+Keywords: bvh,motion capture,kinematics,animation
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.21
+Requires-Dist: matplotlib>=3.7
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.5; extra == "pandas"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pandas>=1.5; extra == "dev"
+Dynamic: license-file
+
+## UPDATE : 
+- 2025-03-26: Added a bone size scaling method.
+- 2025-02-28: Added the possibility to use another skeleton than the one in the bvh file itself. Separated the tutorial into multiple files, for readability, and updated the content.
+- 2025-01-25: Change the parameter "local" in the functions to get spatial coordinates and to plot the bvh. The new parameter is "centered", with three modes:
+    - "skeleton": equivalent to previous local = True, root pos always 0, 0, 0:
+    - "world": equivalent to previous local = False, root at coordinates as in saved in bvh frames
+    - "first": the first frame root position is 0, 0, 0. From there, the skeleton moves in the space normally.
+
+# pybvh
+Python library to work with bvh files
+
+The main point of this library is a Bvh class, which contains all the necesseray information found in a bvh file.
+Through the use of this object, it is easy to read and write a bvh file, but also to convert it to a Pandas Dataframe, and conversely to transform a Dataframe into a bvh object.
+
+See the jupyter file 'tutorial' for example of use.
+
+## Installation
+- Stable release from PyPI: `pip install pybvh`
+- With pandas helpers (optional): `pip install "pybvh[pandas]"`
+
+## Notes about data and notebooks
+- Example BVH files and tutorial notebooks are **not** bundled in the PyPI package to keep the wheel slim.
+- You can find the sample BVH data and notebooks in the GitHub repository under `bvh_data/` and `tutorials/`.
+
+### Curent functionality
+- Bvh class
+    - parameters : 
+        - bvhobject.nodes: a list of all the nodes in the Hierarchy. The nodes are BvhRoot, BvhJoint or BvhNode objects for respectively the root, the joints and the end sites.
+        - bvhobject.frames: the rotational data as a 2D numpy array.
+        - bvhobject.frame_frequency: the frames frequency as can be found in a bvh file.
+        - bvhobject.frame_template: the organized name of each column of the bvhobject.frames.
+        - bvhobject.frame_count: the number of frames (=the number of lines of the bvhobject.frames parameter).
+        - bvhobject.root: the root of the Hierarchy, aka bvhobject.nodes[0].
+    - methods :
+        - to_bvh_file(filepath, verbose=True): save a bvh object to a bvh file at the location filepath (str or Path object).
+        - get_spatial_coord(frame_num=-1, centered="world"): get the spatial coordinates of every joints for all frames or only one.
+        - get_df_constructor(mode = 'euler', centered="world"): get a list of dictionnary that can be transmitted to a pd.Dataframe() constructor to directly obtain a Dataframe. Can construct a DataFrame with euler angles or spatial coordinates.
+        - hierarchy_info_as_dict(): get a dictionnary describing the organisation of the Hierarchy in the bvh object.
+        - change_skeleton(new_skeleton, inplace=False): copy the nodes offset from the 'new_skeleton' bvh object.
+        - scale_skeleton(scale, inplace=False): scale the nodes offset.
+
+- read_bvh_file(filepath) : read a .bvh file at the filepath location (str or Path object), and create a Bvh object
+
+- df_to_bvh(hier, df) : df is a pandas DataFrame, containing joints rotational data. hier is either a dictionnary describing the hierarchy, or a list of nodes. Will create a bvh object based on those two arguments.
+
+- plot.plot_frame(bvh_object, frame) : plot a matplotlib projection3d that shows the frame passed as a parameter.
+
+
+### TODO:
+- making direct changes to rot_channels and pos_channels impossible/regulated. Needs to go through a class method, so that we can also change the frames columns order (and value!) at the same time.
+- class method to transform euler angle directly (different Euler angle order, transformation to rotation matrix etc.)
+- change docstrings to Numpy/Scipy standard

pybvh-0.1.0/README.md

@@ -0,0 +1,52 @@
+## UPDATE : 
+- 2025-03-26: Added a bone size scaling method.
+- 2025-02-28: Added the possibility to use another skeleton than the one in the bvh file itself. Separated the tutorial into multiple files, for readability, and updated the content.
+- 2025-01-25: Change the parameter "local" in the functions to get spatial coordinates and to plot the bvh. The new parameter is "centered", with three modes:
+    - "skeleton": equivalent to previous local = True, root pos always 0, 0, 0:
+    - "world": equivalent to previous local = False, root at coordinates as in saved in bvh frames
+    - "first": the first frame root position is 0, 0, 0. From there, the skeleton moves in the space normally.
+
+# pybvh
+Python library to work with bvh files
+
+The main point of this library is a Bvh class, which contains all the necesseray information found in a bvh file.
+Through the use of this object, it is easy to read and write a bvh file, but also to convert it to a Pandas Dataframe, and conversely to transform a Dataframe into a bvh object.
+
+See the jupyter file 'tutorial' for example of use.
+
+## Installation
+- Stable release from PyPI: `pip install pybvh`
+- With pandas helpers (optional): `pip install "pybvh[pandas]"`
+
+## Notes about data and notebooks
+- Example BVH files and tutorial notebooks are **not** bundled in the PyPI package to keep the wheel slim.
+- You can find the sample BVH data and notebooks in the GitHub repository under `bvh_data/` and `tutorials/`.
+
+### Curent functionality
+- Bvh class
+    - parameters : 
+        - bvhobject.nodes: a list of all the nodes in the Hierarchy. The nodes are BvhRoot, BvhJoint or BvhNode objects for respectively the root, the joints and the end sites.
+        - bvhobject.frames: the rotational data as a 2D numpy array.
+        - bvhobject.frame_frequency: the frames frequency as can be found in a bvh file.
+        - bvhobject.frame_template: the organized name of each column of the bvhobject.frames.
+        - bvhobject.frame_count: the number of frames (=the number of lines of the bvhobject.frames parameter).
+        - bvhobject.root: the root of the Hierarchy, aka bvhobject.nodes[0].
+    - methods :
+        - to_bvh_file(filepath, verbose=True): save a bvh object to a bvh file at the location filepath (str or Path object).
+        - get_spatial_coord(frame_num=-1, centered="world"): get the spatial coordinates of every joints for all frames or only one.
+        - get_df_constructor(mode = 'euler', centered="world"): get a list of dictionnary that can be transmitted to a pd.Dataframe() constructor to directly obtain a Dataframe. Can construct a DataFrame with euler angles or spatial coordinates.
+        - hierarchy_info_as_dict(): get a dictionnary describing the organisation of the Hierarchy in the bvh object.
+        - change_skeleton(new_skeleton, inplace=False): copy the nodes offset from the 'new_skeleton' bvh object.
+        - scale_skeleton(scale, inplace=False): scale the nodes offset.
+
+- read_bvh_file(filepath) : read a .bvh file at the filepath location (str or Path object), and create a Bvh object
+
+- df_to_bvh(hier, df) : df is a pandas DataFrame, containing joints rotational data. hier is either a dictionnary describing the hierarchy, or a list of nodes. Will create a bvh object based on those two arguments.
+
+- plot.plot_frame(bvh_object, frame) : plot a matplotlib projection3d that shows the frame passed as a parameter.
+
+
+### TODO:
+- making direct changes to rot_channels and pos_channels impossible/regulated. Needs to go through a class method, so that we can also change the frames columns order (and value!) at the same time.
+- class method to transform euler angle directly (different Euler angle order, transformation to rotation matrix etc.)
+- change docstrings to Numpy/Scipy standard

pybvh-0.1.0/pybvh/__init__.py

@@ -0,0 +1,9 @@
+__version__ = "0.1.0"
+
+from .bvh import Bvh
+from .read_bvh_file import read_bvh_file
+from .df_to_bvh import df_to_bvh
+from .spatial_coord import frame_to_spatial_coord, frames_to_spatial_coord
+
+from . import plot
+from . import rotations