Tutorial Generic Pipeline to Create CMZ

From Software Product Documentation
Jump to navigation Jump to search
Language:  English  • français • italiano • português • español 

Almost every step that can be accomplished using the user interface can also be accomplished using a pipeline command - the pipeline is essentially a set of commands/functions that allow you to streamline your data processing and reproducible for other subjects.

It's always recommended to learn the manual steps PRIOR to writing a pipeline command - learning the interface will help you build your pipeline.

Download sample script

When writing a pipeline to build a CMZ file, your script should follow the general procedure outlined below.

Load Static Trial

  1. Create_Hybrid_Model: Load static C3D file
  2. Apply_Model_Template: Apply model template (MDH file)
    1. Tutorial to build a model template can be found here.
  3. Set necessary model metrics (most metrics should be calculated based on markers, but height and weight always need to be entered manually):
    1. Set_Subject_Height
    2. Set_Subject_Weight

Load Dynamic Trials

  1. File_Open: Load dynamic C3D files
  2. Assign_Model_File: Associated static trial with appropriate dynamic trials
    1. Note: If a marker falls off during data collection, you should re-take a static trial and associate the appropriate dynamic trials

Process Target and Analog Signals

  1. Select_Active_File: Set active file to ALL_FILES
  2. Set Use Processed:
    1. Set_Use_Processed_Targets: Set to TRUE
    2. Set_Use_Processed_Analog: Set to TRUE
  3. Set_Force_Platform_Threshold: Common minimum values are:
    1. Overground plates: 20 N
    2. Treadmill: 50 N
  4. Gap fill & Filter Target Data:
    1. Interpolate
    2. Lowpass_Filter
  5. Filter Analog data:
    1. Lowpass_Filter
  6. If using treadmill data ONLY use FP_Auto_Baseline
  7. Recalc

Gait Events

Gait Events with Force Platforms

  1. Check for clean force assignments
    1. Interactive_Graph_Signals:
      1. Plot vertical component of KINETIC_KINEMATIC::LFT::FORCE_1
    2. Interactive_Graph_Signals:
      1. Plot vertical component of KINETIC_KINEMATIC::RFT::FORCE_1
    3. Open_Force_Dialogs: Open force assignment dialog
    4. Switch_Between_Tabs: Switch to Signals and Events tag
    5. Pipeline_Breakpoint: Pause pipeline to manually check force assignments
      1. Remove any force assignment that is not clean
      2. Remove any partial force assignments (this includes force assignments at the start/end of the trial)
  2. Select_Active_File: Set active file to ALL_FILES
  3. Automatic_Gait_Events: Create gait events

Gait Events WITHOUT Force Platforms

  1. Kinematic Gait Events

Report and Data Review

  1. Open_Report_Template: Load report template (RGT file)
  2. Stop pipeline to review data prior to export:
    1. Switch_Between_Tabs
    2. Pipeline_Breakpoint

Notes:

  • Many users are skipping report templates - but it's highly recommended to even create a simple report template to review data prior to export. No data collection is perfect, and reviewing the data prior to exporting ensures the data is a quality assurance step.
  • Instructions to create a report template can be found here
  • The report template contains any signals defined using the Compute Model Based Function

Signal Definitions and Processing

  1. Calculate Additional Signals
  2. Calculate Metrics

Export

  1. Export data to a text file

Save

  1. Save CMZ
Retrieved from ""