Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_compute_temporal_distance [2025/09/23 18:12] – [Examples] wikisysop
+++ visual3d:documentation:pipeline:metric_commands:metric_compute_temporal_distance [2025/10/03 19:44] (current) – [Command Parameters] wikisysop
@@ Line 80: / Line 80: @@
 |**CALCULATE_PER_ALL_CMO_GLOBALS**|**Calculate global average**|
 |**CREATE_ALL_INSTANCES**|**value for each sequence (multiple values per trial)**|
-|**CREATE_EMPTY_VALUES**|****|
+|**CREATE_EMPTY_VALUES**|**True or False: Create values containing no data**|
 |**RIGHT/LEFT_FOOT_LOCATION**|**Signal/marker defining foot location**|
 |**HEIGHT**|**Signal type and name defining height**|
 |**---_EVENT**|**Event signal names for foot on/off**|
-|**STRICT_EVENT_SEQUENCE_VALIDATION**|**---**|
+|**STRICT_EVENT_SEQUENCE_VALIDATION**|**True or False: create temporal distance measures for events that occur within a gait cycle. For example Swing Time which occurs between RTO and RHS will only be calculated if the event sequence is RHS+RTO+RHS.**|
 |**R/LSTRIDE_EXCLUDE**|**Excluding right or left side of stride**|
 |**INCLUDE/EXCLUDE_EVENTS**|**Including or excluding certain events in command**|
@@ Line 97: / Line 97: @@
 ^ Dialog ^ Description ^
-|{{:EditTemporalDistancev5_FILES2.png}}  |- The default command will create average temporal distance values for the ACTIVE files and results can be found in the GLOBAL workspace\\ - **Calculate For Each File:** Calculate average values across entire trial\\- **Calculate For All Cmo Globals:** Calculate global average \\ - **Create All Instances:** value for each sequence (multiple values per trial)\\ \\ **NOTE:** To use the Calculate For Each File option, Calculate for Each Trial must be selected as well.  |
+|{{:EditTemporalDistancev5_FILES2.png}}  |- The default command will create average temporal distance values for the ACTIVE files and results can be found in the GLOBAL workspace\\ - **Calculate For Each File:** Calculate average values across entire trial\\ - **Calculate For All Cmo Globals:** Calculate global average \\ - **Create All Instances:** value for each sequence (multiple values per trial)\\ \\ **NOTE:** To use the Calculate For Each File option, Calculate for Each Trial must be selected as well.  |
 |{{:EditTemporalDistancev5_Signal.jpg}}  |- If the user would like to define temporal distance metrics using a signal other than the default signal (such as the proximal end of the foot), the user can select a different signal (such as the heel target).\\ \\ - The height is used to calculate [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait#Statures.2FSecond|statures/second]]  |
-|{{:EditTemporalDistancev5_PROPERTIES.png}}  |- The event labels may be changed to any events desired.\\ \\ - Selecting **Strict Event Label Sequence** will create temporal distance measures for events that occur within a gait cycle. For example Swing Time which occurs between RTO and RHS will only be calculated if the event sequence is RHS+RTO+RHS.\\- **[SIDE} String Exclude** will exclude event sequences with that event.\\ \\ - Explanations of the calculations of the temporal distance items can be found [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait|here]].  |
+|{{:EditTemporalDistancev5_PROPERTIES.png}}  |- The event labels may be changed to any events desired.\\ \\ - Selecting **Strict Event Label Sequence** will create temporal distance measures for events that occur within a gait cycle. For example Swing Time which occurs between RTO and RHS will only be calculated if the event sequence is RHS+RTO+RHS.\\ - **String Exclude** will exclude event sequences with that event.\\ \\ - Explanations of the calculations of the temporal distance items can be found [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait|here]].  |
 |{{:EditTemporalDistancev5_RANGE.jpg}}  |- **Event Instance:** 0 indicates all instances, 1 indicates the first event sequence\\ \\ - **Exclude Sequence:** Creating an event BAD would exclude the trial during which the event occurred  |
 |{{:EditTemporalDistancev5_TREADMILL.jpg}}  |- The treadmill unit vector refers to the Anterior Direction of walking\\ - Speed, (left/right/average) stride and step length, and statures/second are dependent on belt speed.\\- The result folder may have any name and will be a subfolder of the METRIC folder.  |
@@ Line 167: / Line 167: @@
 {{:visual3d:documentation:pipeline:metric_commands:flight_time.png?500|}}
-===Complex example===
+===Complex example: Comparing Left and Right Stride Length for treadmill trial===
-Combine with other commands and show step-by-step process for frequent use case
+Here we will look at a gait cycle trial using data for users running on a treadmill and compare their mean stride length for the left and right sides.
+Similarly to above, we will start by using **Automatic Gait Events** to define the gait cycle.
+Next, we will use **Metric_Compute_Temporal_Distance** to compute the length of each stride for both sides, and adjust the command parameters to account for the speed of the single belt treadmill used to record the data. In this case the treadmill was moving at 1.25 m/s and the subject walking in the y-direction (0,1,0).
+<code>
+Metric_Compute_Temporal_Distance
+! /GLOBAL_RESULT_METRIC_FOLDER=TEMPORAL_DISTANCE
+/CALCULATE_PER_FILE=TRUE
+! /CALCULATE_PER_ALL_CMO_GLOBALS=FALSE
+! /CREATE_ALL_INSTANCES=FALSE
+! /CREATE_EMPTY_VALUES=TRUE
+! /RIGHT_FOOT_LOCATION=KINETIC_KINEMATIC::RFT::ProxEndPos
+! /LEFT_FOOT_LOCATION=KINETIC_KINEMATIC::LFT::ProxEndPos
+! /HEIGHT=METRIC::PROCESSED::HEIGHT
+/RHS_EVENT=RHS
+/LHS_EVENT=LHS
+/RTO_EVENT=RTO
+/LTO_EVENT=LTO
+/STRICT_EVENT_SEQUENCE_VALIDATION=TRUE
+! /RSTRIDE_EXCLUDE=
+! /LSTRIDE_EXCLUDE=
+! /INCLUDE_EVENTS=
+! /EXCLUDE_EVENTS=
+/EVENT_INSTANCE=ALL
+/COMPUTE_SPEED=FALSE
+/COMPUTE_STATURES_PER_SECOND=FALSE
+! /COMPUTE_STRIDE_WIDTH=TRUE
+! /COMPUTE_STRIDE_LENGTH=TRUE
+/COMPUTE_CYCLE_TIME=FALSE
+/COMPUTE_STEP_LENGTH=FALSE
+/COMPUTE_STEP_TIME=FALSE
+/COMPUTE_STANCE_TIME=FALSE
+/COMPUTE_SWING_TIME=FALSE
+/COMPUTE_STEPS_PER_MINUTE=FALSE
+/COMPUTE_STRIDES_PER_MINUTE=FALSE
+/COMPUTE_DOUBLE_LIMB_SUPPORT_TIME=FALSE
+/COMPUTE_RIGHT_INITIAL_DOUBLE_LIMB_SUPPORT_TIME=FALSE
+/COMPUTE_RIGHT_TERMINAL_DOUBLE_LIMB_SUPPORT_TIME=FALSE
+! /COMPUTE_FLIGHT_TIME=FALSE
+/TREADMILL_SPEED=1.25
+/LEFT_TREADMILL_SPEED=1.25
+/TREADMILL_DIRECTION=UNIT_VECTOR(0,1,0)
+;
+</code>
+The computed stride data can now be found in the **Metric** folder under **Temporal_Distance**.
+To compare the left and right stride lengths we will create a horizontal chart in the **Reports** tab.
+Start by adding a new page to your report, and adding **Temporal and Distance Metrics** as an item.
+{{:visual3d:documentation:pipeline:metric_commands:temporalitem.png?400|}}
+Fill out the dialog box as so:
+{{:visual3d:documentation:pipeline:metric_commands:temporaldialog.png?500|}}
+Click done. You should now see a bar chart comparing the left and right step length for your trial.
+{{:visual3d:documentation:pipeline:metric_commands:tempgraph_.png?550|}}
 ===== Multisubject Support =====