Differences

This shows you the differences between two versions of the page.

--- visual3d:tutorials:pipeline:generic_pipeline_to_create_cmz [2024/06/19 12:55] – sgranger
+++ visual3d:tutorials:pipeline:generic_pipeline_to_create_cmz [2025/02/12 16:56] (current) – [Export & Save] sgranger
@@ Line 1: / Line 1: @@
-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.
+====== Generic Pipeline to Create CMZ ======
-it's always recommended to learn the manual steps prior to writing a pipeline command - learning the interface will help you build your pipeline.
+The Visual3D **Command Pipeline** can accomplish nearly every step used in the application's user interface. The pipeline is essentially a set of commands/functions that allow you to streamline your data processing and reproducible for other subjects.
-[[https://www.has-motion.com/download/examples/pipelines/building_cmz.zip|download sample script]]
+It's always recommended to learn the manual steps PRIOR to writing a pipeline command - learning the interface will help you build your pipeline. A full command pipeline tutorial is available as part of the Visual3D typical processing session: [[visual3d:tutorials:pipeline:command_pipeline| Command Pipeline tutorial]].
-when writing a pipeline to build a cmz file, your script should follow the general procedure outlined below.
+Download the [[https://www.has-motion.com/download/examples/Pipelines/Building_CMZ.zip|Create CMZ ZIP File]] which contains a sample pipeline script used to make CMZs.
-====== load static trial ======
+When writing a pipeline to build a CMZ file, your script should follow the general procedure outlined below. Although not in order, the commands used in this sample pipeline are listed.
-  - [[visual3d:documentation:pipeline:model_commands:create_hybrid_model|create_hybrid_model]]: load static c3d file
+===== Load Static Trial =====
-  - [[visual3d:documentation:pipeline:model_commands:apply_model_template|apply_model_template]]: apply model template (mdh file)
+|**Command**|**Description**|
-    - tutorial to build a model template can be found [[visual3d:tutorials:modeling:building_a_6_dof_model_|here]].
+|[[Visual3D:Documentation:Pipeline:Model_Commands:Create_Hybrid_Model|Create_Hybrid_Model]]|Load static C3D file|
-  - set necessary model metrics (most metrics should be calculated based on markers, but height and weight always need to be entered manually):
+|[[Visual3D:Documentation:Pipeline:Model_Commands:Apply_Model_Template|Apply_Model_Template]]|Apply model template (MDH File). \\ - Tutorial to build a model template can be found here: [[Visual3D:Tutorials:Modeling:Building_a_6_DOF_Model_|Building a 6 DOF Model]].|
-    - [[visual3d:documentation:pipeline:model_commands:set_subject_height|set_subject_height]]
+|[[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Height|Set_Subject_Height]] \\ [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Weight|Set_Subject_Weight]]|Set necessary model metrics (most metrics should be calculated based on markers, but height and weight always need to be entered manually).|
-    - [[visual3d:documentation:pipeline:model_commands:set_subject_weight|set_subject_weight]]
-====== load dynamic trials ======
-  - [[visual3d:documentation:pipeline:file_commands:file_open|file_open]]: load dynamic c3d files
+===== Load Dynamic Trials =====
-  - [[visual3d:documentation:pipeline:model_commands:assign_model_file|assign_model_file]]: associated static trial with appropriate dynamic trials
+|**Command**|**Description**|
-    - note: if a marker falls off during data collection, you should re-take a static trial and associate the appropriate dynamic trials
+|[[Visual3D:Documentation:Pipeline:File_Commands:File_Open|File_Open]]|Load dynamic C3D Files.|
+|[[Visual3D:Documentation:Pipeline:Model_Commands:Assign_Model_File|Assign_Model_File]]|Associated static trial with appropriate dynamic trials. \\ - 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 ======
+===== Process Target and Analog Signals =====
+|**Command**|**Description**|
+|[[Visual3D:Documentation:Pipeline:File_Commands:Select_Active_File|Select_Active_File]]|Set active file to ALL_FILES.|
+|[[Visual3D:Documentation:Pipeline:Other_Commands:Set_Use_Processed_Targets|Set_Use_Processed_Targets]]: Set to TRUE \\ [[Visual3D:Documentation:Pipeline:Other_Commands:Set_Use_Processed_Analog|Set_Use_Processed_Analog]]: Set to TRUE| [[Visual3D:Documentation:Visual3D_Signal_Types:Used_Process|Set Use Processed]]: The PROCESSED folder should contain your interpolated or filtered data. If you tell Visual3D to use the PROCESSED folders, Visual3D will use the processed signals for kinetic/kinematic calculations.|
+|[[Visual3D:Documentation:Pipeline:Force_Commands:Set_Force_Platform_Threshold|Set_Force_Platform_Threshold]]| Common minimum values are: \\ - Overground plates: 20N \\ - Treadmill: 50N|
+|[[Visual3D:Documentation:Pipeline:Signal_Commands:Interpolate|Interpolate]] \\ [[Visual3D:Documentation:Pipeline:Signal_Commands:Lowpass_Filter|Lowpass_Filter]]| Gap fill and Filter Target Data, Low Pass Filter can be used to filter Analog data|
+|[[Visual3D:Documentation:Pipeline:Force_Commands:FP_Auto_Baseline|FP_Auto_Baseline]] \\ [[Visual3D:Documentation:Pipeline:File_Commands:Recalc|Recalc]]| If using treadmill data, ONLY use FP_Auto_Baseline.|
-  - [[visual3d:documentation:pipeline:file_commands:select_active_file|select_active_file]]: set active file to all_files
+===== Gait Events =====
-  - [[visual3d:documentation:visual3d_signal_types:used_process|set use processed:]]
-    - [[visual3d:documentation:pipeline:other_commands:set_use_processed_targets|set_use_processed_targets]]: set to true
-    - [[visual3d:documentation:pipeline:other_commands:set_use_processed_analog|set_use_processed_analog]]: set to true
-  - [[visual3d:documentation:pipeline:force_commands:set_force_platform_threshold|set_force_platform_threshold]]: common minimum values are:
-    - overground plates: 20 n
-    - treadmill: 50 n
-  - gap fill & filter target data:
-    - [[visual3d:documentation:pipeline:signal_commands:interpolate|interpolate]]
-    - [[visual3d:documentation:pipeline:signal_commands:lowpass_filter|lowpass_filter]]
-  - filter analog data:
-    - [[visual3d:documentation:pipeline:signal_commands:lowpass_filter|lowpass_filter]]
-  - if using treadmill data only use [[visual3d:documentation:pipeline:force_commands:fp_auto_baseline|fp_auto_baseline]]
-  - [[visual3d:documentation:pipeline:file_commands:recalc|recalc]]
-====== gait events ======
+==== Gait Events with Force Platforms ====
-===== gait events with force platforms =====
+The following commands are involved in **checking for clean force assignments**. For example, refer to the [[Visual3D:Documentation:Definitions:Clean_Foot_Strike|Clean Foot Strike]] documentation. A "clean" foot strike indicates that measurements from the force platform are able to be used for analysis, and will not cause incorrect events to be created or produce "bad" kinetic calculations (GRF, Joint Moments, etc.).
-  - [[visual3d:documentation:definitions:clean_foot_strike|check for clean force assignments]]
+|**Command**|**Description**|
-    - [[visual3d:documentation:pipeline:report_commands:interactive_graph_signals|interactive_graph_signals]]:
+|[[Visual3D:Documentation:Pipeline:Report_Commands:Interactive_Graph_Signals|Interactive_Graph_Signals]]|Plot vertical component of **KINETIC_KINEMATIC::LFT::FORCE_1** and **KINETIC_KINEMATIC::RFT::FORCE_1 signals.**|
-      - plot vertical component of kinetic_kinematic::lft::force_1
+|[[Visual3D:Documentation:Pipeline:Other_Commands:Open_Force_Dialogs|Open_Force_Dialogs]]| Open force assignment dialog.|
-    - [[visual3d:documentation:pipeline:report_commands:interactive_graph_signals|interactive_graph_signals]]:
+|[[Visual3D:Documentation:Pipeline:Other_Commands:Switch_Between_Tabs|Switch_Between_Tabs]]|Switch to Signals and Events tab.|
-      - plot vertical component of kinetic_kinematic::rft::force_1
+|[[Visual3D:Documentation:Pipeline:Pipeline_Commands:Pipeline_Breakpoint|Pipeline_Breakpoint]]|Pause pipeline to manually check force assignments: \\ a. Remove any force assignment that is not __clean.__ \\ b. Remove any partial force assignments (this includes force assignments at the start/end of the trial.)|
-    - [[visual3d:documentation:pipeline:other_commands:open_force_dialogs|open_force_dialogs]]: open force assignment dialog
+|[[Visual3D:Documentation:Pipeline:File_Commands:Select_Active_File|Select_Active_File]]| Set active file to ALL_FILES.|
-    - [[visual3d:documentation:pipeline:other_commands:switch_between_tabs|switch_between_tabs]]: switch to signals and events tag
+|[[Visual3D:Documentation:Pipeline:Event_Commands:Automatic_Gait_Events|Automatic_Gait_Events]]|Create gait events.|
-    - [[visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint|pipeline_breakpoint]]: pause pipeline to manually check force assignments
-      - remove any force assignment that is not [[visual3d:documentation:definitions:clean_foot_strike|clean]]
-      - remove any partial force assignments (this includes force assignments at the start/end of the trial)
-  - [[visual3d:documentation:pipeline:file_commands:select_active_file|select_active_file]]: set active file to all_files
-  - [[visual3d:documentation:pipeline:event_commands:automatic_gait_events|automatic_gait_events]]: create gait events
-===== gait events without force platforms =====
+==== Gait Events WITHOUT Force Platforms ====
+When force data is not available, there are several methods for computing gait events using kinematic data, an overview of this process can be seen in [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Gait_Events_using_Kinematic_Data|Example - Kinematic Gait Events.]]
-  - [[visual3d:documentation:pipeline:event_commands:example_-_gait_events_using_kinematic_data|kinematic gait events]]
-====== report and data review ======
+===== Report and Data Review =====
+|**Command**|**Description**|
+|[[Visual3D:Documentation:Pipeline:Report_Commands:Open_Report_Template|Open_Report_Template]]|Load report template (RGT File).|
+|[[Visual3D:Documentation:Pipeline:Other_Commands:Switch_Between_Tabs|Switch_Between_Tabs]] \\ [[Visual3D:Documentation:Pipeline:Pipeline_Commands:Pipeline_Breakpoint|Pipeline_Breakpoint]]|Stop pipeline to review data prior to export.|
-  - [[visual3d:documentation:pipeline:report_commands:open_report_template|open_report_template]]: load report template (rgt file)
+**NOTE**:
-  - stop pipeline to review data prior to export:
+  * 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.
-    - [[visual3d:documentation:pipeline:other_commands:switch_between_tabs|switch_between_tabs]]
+  * Instructions to create a report template can be found [[Visual3D:Tutorials:Reports:Creating_a_Report|here.]]
-    - [[visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint|pipeline_breakpoint]]
+  * The report template contains any signals defined using the [[Visual3D:Documentation:Visual3D_Signal_Types:LINK_MODEL_BASED_Data_Type#Link_Model_Based_Items|Compute Model Based Function.]]
-notes:
+===== Signal Definitions and Processing =====
+|**Command**|**Description**|
+|[[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Commands_Overview|Calculate Additional Signals]]| Signal math commands, allow you to create custom mathematical expressions.|
+|[[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Commands_Overview|Calculate Metrics]]| Calculate Metrics, discrete quantitative values of signals such as maximum value, median value, value at a specified frame.|
-  * 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.
+===== Export & Save =====
-  * instructions to create a report template can be found [[visual3d:tutorials:reports:creating_a_report|here]]
+|**Command**|**Description**|
-  * the report template contains any signals defined using the [[visual3d:documentation:visual3d_signal_types:link_model_based_data_type#link_model_based_items|compute model based function]]
+|[[Visual3D:Documentation:Pipeline:File_Commands:Export_Data_To_ASCII_File|Export data to a text file]]|Converts data from the Data Tree into ASCII (plain text) data.|
+|[[Visual3D:Documentation:Pipeline:File_Commands:File_Save|Save CMZ]]|Saves Workspace file as CMZ.|
-====== signal definitions and processing ======
-  - [[visual3d:documentation:pipeline:signal_commands:overview|calculate additional signals]]
-  - [[visual3d:documentation:pipeline:metric_commands:metric_commands_overview|calculate metrics]]
-====== export ======
-  - [[visual3d:documentation:pipeline:file_commands:export_data_to_ascii_file|export data to a text file]]
-====== save ======
-  - [[visual3d:documentation:pipeline:file_commands:file_save|save cmz]]