Skip to main content

A set of computer vision tools for analyzing your climbing videos.

Project description

Climbing Analysis Toolbox

A set of computer vision tools for processing and analyzing your climbing videos. In my spare time, I also write about topics relevant to bouldering and computer vision here.

License: MIT Python 3.11

Getting Started

# Create an virtual environment
python -m venv PATH_TO_YOUR_VENV
source PATH_TO_YOUR_VENV

Prerequisites

# The following third-party dependency is needed for video warping (or scene matching)
python -m pip install git+https://github.com/alexstoken/image-matching-models.git
python -m pip install --upgrade cruxes # Install the latest version of this toolbox
# https://pypi.org/project/cruxes/

Only proceed to the following content once you have installed the dependencies correctly.

Catalogue

For each section, there will be detailed example code for both CLI usage and in-code usage.

  1. Warping Video for Scene Matching Details
# Example usage:
cruxes warp \
--ref_img "examples/videos/warp-dynamic-ref.jpg" \
--src_video_path "examples/videos/warp-dynamic-input.mp4"
# [--type ...]
  1. Drawing Trajectories for Body Movements [1] Details
cruxes body-trajectory \
--video_path "examples/videos/body-trajectory-input.mp4"
# [other options]
  1. Compare Body Trajectories across Different Climbing Footages Details

More to Come

  • 3D Pose Extraction and Displaying
  • Drawing Trajectories for Body Movements across Multiple Footages
  • Heatmap for Limb Movement [1]
  • Climbing Hold Auto-segmentation
  • Gaussian-splatting 3D Reconstructing a Climb

1️⃣ Warping Video for Scene Matching

Sometimes, to analyze our sequences for a climb, we typically have multiple sessions. During those sessions, we might have the camera placed at different locations, thus pointing from different angles towards the climb we are projecting. This tool helps you transform videos so that they match a reference image that corresponds to the whole picture of your climb. Reasons for doing this are:

  1. It is better for using tools that involve 2D/3D pose estimation
  2. It is easier to see how your body moves with respect to similar angles. Note that, right now, it is impossible to seamlessly match a video to the scene of a base image if their camera angles and positions differ by a large amount; some area might be off from base scene.

To warp a video to match a reference scene, we extract the features between two frames, and then a homography matrix is extracted for the image transformation. By default, we use a per-frame homography matrix, but that also means we have to compute $H$ for each frame of the input video if the input video is moving. If the camera of your input video is not moving, we can reduce the processing time by only comparing the first frame of the video and the base scene. This reduces the computation time for the matcher we are using, so only image transformation is involved for the entire warping process. We call the first scenario dynamic and the second scenario fixed, as you can set with the type option.

# CLI usage
# Warp a video with moving camera (per-frame homography matrix for the transformation)
cruxes warp \
--ref_img "examples/videos/warp-dynamic-ref.jpg" \
--src_video_path "examples/videos/warp-dynamic-input.mp4"
# by default the type of warping is `dynamic`
# In-code usage
from cruxes import Cruxes
cruxes = Cruxes()
cruxes.warp_video(
    "warp-dynamic-ref.jpg", 
    "warp-dynamic-input.mp4", 
)
🎬 Example Resulting Video Your browser does not support the video tag.
# CLI usage
# Warp a video with fixed camera (first-frame homography matrix for the transformation)
cruxes warp \
--ref_img "examples/videos/warp-fixed-ref.jpg" \
--src_video_path "examples/videos/warp-fixed-input.mp4" \
--type "fixed"
# In-code usage
from cruxes import Cruxes
cruxes = Cruxes()
cruxes.warp_video(
    "warp-fixed-ref.jpg", 
    "warp-fixed-input.mp4", 
    warp_type="fixed"
)
🎬 Example Resulting Video Your browser does not support the video tag.

If you can't see the example resulting video, go to the example/videos/ folder.


2️⃣ Drawing Trajectories for Body Movements

It is recommended to apply this script to a video with fixed camera position, i.e., camera is not being moved.

There is a couple of settings you can adjust inside the script for extract_pose_and_draw_trajectory():

Argument Description
track_point Points of interest on the estimated pose you want to track. A velocity vector arrow will be drawn to indicate how fast each point is moving with respect to its 3D position
overlay_trajectory Whether to overlay a half-transparent mask on top of the original video. Note that if this is set to True, the velocity vector arrow that corresponds to each track point will be removed.
draw_pose Whether to draw pose skeleton or not
kalman_settings Whether to apply Kalman filter to smooth out the trajectory (not the pose itself)
trajectory_png_path Whether to generate a .png file for the trajectory with black background

Then, run the command as follows:

# CLI usage
cruxes body-trajectory \
--video_path "examples/videos/body-trajectory-input.mp4" \
--overlay_trajectory \
--draw_pose \
--kalman_settings 1e0
# In-code usage
from cruxes import Cruxes
cruxes = Cruxes()
cruxes.body_trajectory(
    "body-trajectory-input.mp4",
    track_point=[
        # Currently available points to track
        "hip_mid",
        "upper_body_center",
        "head",
        "left_hand",
        "right_hand",
        "left_foot",
        "right_foot",
    ],
    overlay_trajectory=False,
    draw_pose=True,
    kalman_settings=[  # Kalman filter settings: [use_kalman : bool, kalman_gain : float]
        True,  # Set this to false if you don't want to apply Kalman filter
        1e0,  # >=1e0 for higher noise, <=1e-1 for lower noise
    ],
    trajectory_png_path=None,
)

The generated video will then be located inside of the output folder.

🎬 Example Resulting Video Your browser does not support the video tag.

If you can't see the example resulting video, go to the example/videos/ folder.


3️⃣ Compare Body Trajectories across Different Climbing Footages

To be added.


To-do

  • Add automated test cases
  • Add specification to notice for adding new tool kits in the future
  • Add a server backend to allow API request for specific functionality.
  • Migrate to PyPI for easier installation and use.
  • Add CLI options to run (cruxes instead of python ...)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cruxes-0.0.15.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cruxes-0.0.15-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

Details for the file cruxes-0.0.15.tar.gz.

File metadata

  • Download URL: cruxes-0.0.15.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.7

File hashes

Hashes for cruxes-0.0.15.tar.gz
Algorithm Hash digest
SHA256 a8fc0caf842faa3b45a5ab62b79e3c59fa7e54fffea000029975fb9b65587d3c
MD5 beec4284b634a39fa1b404bcd9df489b
BLAKE2b-256 e6f9d8fbc5c5d73a722eef54411cf44c12b88a927f6e67d851277af017ff43d6

See more details on using hashes here.

File details

Details for the file cruxes-0.0.15-py3-none-any.whl.

File metadata

  • Download URL: cruxes-0.0.15-py3-none-any.whl
  • Upload date:
  • Size: 22.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.7

File hashes

Hashes for cruxes-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 198f88c2162ada4ece4ccc078ecd0e65a56354b39b1dd386af64d509ac2c2cc7
MD5 3dd6ccea2b19249bd6bdf86c18f598aa
BLAKE2b-256 3069fa63206b16c6657735dd6901d48e1577b3550f43f26442350c61dfebe5be

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page