The pre-configured pyCGM2 pipeline

nexusAdvancedPipeline

Overview

The pre-configured pipeline provided during installation is designed to seamlessly integrate with Vicon Nexus and your dedicated pyCGM2 virtual environment. This setup ensures that you can quickly start working with the CGM2.3 model and leverage a suite of gait analysis tools without additional configuration.

For detailed steps on how to import and activate the pipeline, refer to the installation instructions.

Features

The pipeline brings together essential pyCGM2 operations, allowing you to:

  • Apply the CGM2.3 model to your motion capture data.
  • Automate common gait analysis tasks such as:
    • Filling gaps in marker trajectories.
    • Identifying foot contact events.
    • Plotting and exporting results.
  • Streamline your workflow by providing a unified interface for both standard and advanced processing methods.

Advanced Vcon nexus users can copy-paste the content of the operation properties (see image above) to their own pipeline.

Details

In the properties section of the pipeline (see image above), you will find several key configuration elements:

  • Python script file:
    This field should point to the rullThemAllCommands.py script, which is the main entry point for pyCGM2 operations. You can also call this script directly using pyCGM2.exe.

  • Script arguments:
    Here, you specify the input arguments required by rullThemAllCommands.py. These arguments control which operation is performed and how it is configured. For a full list and explanation of available arguments, see the argument reference.

  • Environment activation:
    This step calls a batch file (e.g., activate_dev310.bat) to activate your Python virtual environment before running the script. Make sure the environment name matches the one you created during installation (e.g., dev310).

Each operation in the pipeline is clearly named to reflect its function.

Typical usage examples:

  • To calibrate a static file with the CGM2.3 model:
    Enable the checkboxes for the following operations and run the pipeline:

    • pyCGM2-Calibration Operation
    • Export C3D
  • To fit a gait trial with the CGM2.3 model:
    Enable the checkboxes for:

    • pyCGM2-Gaps-Gloersen Operation to fill gaps
    • pyCGM2-Fitting Operation to apply the CGM2.3 fitting method
    • Export C3D
  • To run the deep-learning intellevent algorithm: Enable the checkboxes for:

    • pyCGM2-Intell-Events Operation
    • Export C3D
  • To plot time-normalized kinematics: Enable the checkboxes for:

    • pyCGM2-Intell-Events Operation or pyCGM2-Events-Zeni to indetify foot contact
    • pyCGM2-Plots-Kinematics Operation to render gait plot

This modular approach allows you to customize and automate your workflow efficiently, ensuring reproducibility and ease of use for both standard and advanced motion capture analyses.

to find out more about the script argument, consult the argument reference page