Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_compute_gait_signal_stats [2025/09/17 19:59] – wikisysop
+++ visual3d:documentation:pipeline:metric_commands:metric_compute_gait_signal_stats [2025/09/23 17:46] (current) – [Notes and Examples] wikisysop
@@ Line 49: / Line 49: @@
 The pipeline command is as follows:
+<code>
 Metric_Compute_Gait_Signal_Stats
 /SIGNAL_TYPES=
@@ Line 68: / Line 69: @@
 ! /MERGE_COMPONENTS=FALSE
 ;
+</code>
 ====Command Parameters====
@@ Line 80: / Line 82: @@
 |**COMPUTE_LEFT/RIGHT_SIDE**|**Which side events will be computed for.**|
 |**RESULT_FOLDER**|**Assigning folder to hold results.**|
-|**ABC_EVENT**|**Assigning names to events.**|
+|**---_EVENT**|**Assigning names to events.**|
 |**LEFT/RIGHT_SIDE_RESULT_NAME_PREFIX**|**Assigning names to left and right sides**|
 |**RESULT_NAME_SUFFIX**|**Specify suffix applied to results**|
@@ Line 100: / Line 102: @@
 Several of the command parameters affect the signal that is created.
-=== Example1 ===
+===Example 1===
 This group of commands results in a metric signal being created in the SIGNAL_STATS folder that is the same name as /Signal_Names parameter and it contains values related to the X-Component of the signal.
-/RESULT_FOLDER=SIGNAL_STATS
+<code>
-/APPEND_COMPONENT_TO_RESULT_NAME=FALSE
+Metric_Compute_Gait_Signal_Stats
-/RESULT_NAME_SUFFIX=
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /SIGNAL_COMPONENTS=
 /COMPONENT_SEQUENCE=X
-/MERGE_COMPONENTS=FALSE
+/COMPUTE_LEFT_SIDE=TRUE
-\\
+/COMPUTE_RIGHT_SIDE=
+! /RESULT_FOLDER=SIGNAL_STATS
+! /RHS_EVENT=RHS
+! /LHS_EVENT=LHS
+! /RTO_EVENT=RTO
+! /LTO_EVENT=LTO
+! /LEFT_SIDE_RESULT_NAME_PREFIX=L_
+! /RIGHT_SIDE_RESULT_NAME_PREFIX=R_
+! /RESULT_NAME_SUFFIX=_Stats
+! /APPEND_COMPONENT_TO_RESULT_NAME=FALSE
+! /MERGE_COMPONENTS=FALSE
+;
+</code>
+===Example 2===
-=== Example2 ===
 This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string _Stats to the name in the /Signal_Names parameter and it contains values related to the X-Component of the signal.
+<code>
+Metric_Compute_Gait_Signal_Stats
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /SIGNAL_COMPONENTS=
+/COMPONENT_SEQUENCE=X
+/COMPUTE_LEFT_SIDE=TRUE
+/COMPUTE_RIGHT_SIDE=
 /RESULT_FOLDER=SIGNAL_STATS
-/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
+! /RHS_EVENT=RHS
+! /LHS_EVENT=LHS
+! /RTO_EVENT=RTO
+! /LTO_EVENT=LTO
+! /LEFT_SIDE_RESULT_NAME_PREFIX=L_
+! /RIGHT_SIDE_RESULT_NAME_PREFIX=R_
 /RESULT_NAME_SUFFIX=_Stats
-/COMPONENT_SEQUENCE=X
+/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
 /MERGE_COMPONENTS=FALSE
-\\
+;
+</code>
+===Example 3===
-=== Example3 ===
+Computing stats from force plate data for left ankle angle using **Automatic Gait Events**: This group of commands results in a metric signal being created in the SIGNAL_STATS folder for all components of the left ankle angle during a trial. The command appends the string "X_Stats" to the name in the /Signal_Names parameter containing values related to the X-Component of the signal; "Y_Stats" to the name in the /Signal_Names parameter containing values related to the Y-Component of the signals.;"Z_Stats" to the name in the /Signal_Names parameter containing values related to the Z-Component of the signals.
-This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string "_Stats_X" to the name in the /Signal_Names parameter and it contains values related to the X-Component of the signal.
+Gait events describe key moments in the walking or running cycle - such as heel-strikes and toe-offs. If [[Visual3D:Documentation:Kinematics_and_Kinetics:External_Forces:Force_Assignment|Force Platform assignments]] exist for a motion trial, the **Automatic_Gait_Events** command __automatically__ detects these gait events and places an **event label** at the frames where the subject steps ON and OFF the surface of the platform.
-/RESULT_FOLDER=SIGNAL_STATS
+Start by loading any trial with force plate data for a gait cycle. First, we will use **Automatic Gait Events** to label the key events in the cycle.
-/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
-/RESULT_NAME_SUFFIX=_Stats
-/COMPONENT_SEQUENCE=X
-/MERGE_COMPONENTS=FALSE
-\\
+<code>
+Automatic_Gait_Events
+! /FRAME_WINDOW=8
+! /USE_TPR=TRUE
+! /TPR_EVENT_INSTANCE=1
+;
+</code>
-=== Example4 ===
+Next we will use **Metric Compute Gait Signal Stats** to calculate key statistics for the **left ankle angle** using the events we just defined.
-This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string "_Stats_X" to the name in the /Signal_Names parameter containing values related to the X-Component of the signal; "_Stats_Y" to the name in the /Signal_Names parameter containing values related to the Y-Component of the signals.;"_Stats_Z" to the name in the /Signal_Names parameter containing values related to the Z-Component of the signals..
+<code>
+Metric_Compute_Gait_Signal_Stats
-/RESULT_FOLDER=SIGNAL_STATS
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
+! /SIGNAL_FOLDER=ORIGINAL
-/RESULT_NAME_SUFFIX=_Stats
+/SIGNAL_NAMES=LAnkleAngle
+! /SIGNAL_COMPONENTS=
 /COMPONENT_SEQUENCE=ALL
-/MERGE_COMPONENTS=FALSE
+/COMPUTE_LEFT_SIDE=TRUE
-=== Example5 ===
+/COMPUTE_RIGHT_SIDE=FALSE
+! /RESULT_FOLDER=SIGNAL_STATS
-This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string "_Stats" to the name in the /Signal_Names parameter containing values related to the X-Component of the signal; The resulting signal contains 3 frames of data. The first row is related to the X-Component, the second row is related to the Y-Component and the third row is related to the Z-Component.
+! /RHS_EVENT=RHS
+! /LHS_EVENT=LHS
-/RESULT_FOLDER=SIGNAL_STATS
+! /RTO_EVENT=RTO
-/APPEND_COMPONENT_TO_RESULT_NAME=FALSE
+! /LTO_EVENT=LTO
-/RESULT_NAME_SUFFIX=_Stats
+! /LEFT_SIDE_RESULT_NAME_PREFIX=L_
-/COMPONENT_SEQUENCE=ALL
+! /RIGHT_SIDE_RESULT_NAME_PREFIX=R_
-/MERGE_COMPONENTS=TRUE
+! /RESULT_NAME_SUFFIX=_Stats
+/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
+! /MERGE_COMPONENTS=FALSE
+;
+</code>
+The resulting folders and data should look something like this:
+{{:visual3d:documentation:pipeline:metric_commands:lankledata.png?600|}}