Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_integrate [2024/07/12 14:04] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_integrate [2025/10/03 13:07] (current) – [Example: Calculating Joint Work Using Integration] wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Integrate ======
+====== Metric Integrate ======
-===== Introduction =====
+=====Overview=====
-Integrate a signal between events using the trapezoidal rule.
+The command **Metric Integrate** is used to integrate a signal between events using the trapezoidal rule.
 http://en.wikipedia.org/wiki/Trapezoidal_rule
@@ Line 10: / Line 10: @@
 where T= time between frames
-===== Command =====
-Metric_Integrate = Sum of the integral for all frames in the range.\\
+This command can be useful when it is necessary to compute a value, like displacement or work, for which integration is needed.
-\\
+=====Pipeline Command=====
-|<code>\\ Metric_Integrate\\ /RESULT_METRIC_NAME=\\ /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE\\ ! /RESULT_METRIC_FOLDER=PROCESSED\\ /SIGNAL_TYPES=\\ ! /SIGNAL_NAMES=\\ /SIGNAL_FOLDER=\\ ! /SIGNAL_COMPONENTS=ALL_COMPONENTS\\ /EVENT_SEQUENCE=\\ /EXCLUDE_EVENTS= \\ /GENERATE_MEAN_AND_STDDEV=FALSE\\ ! /APPEND_TO_EXISTING_VALUES=FALSE\\ ;\\ </code>  |  {{Metric_Integrate_Dlg.jpg}}|
+The command can be found in the **Pipeline Workshop** under **Metric** as so:
-===== Example =====
+<code>
+Metric_Integrate
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /COMPONENT_SEQUENCE=
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**|
+|**RESULT_METRIC_NAME**|**The name of the result signal**|
+|**APPLY_AS_SUFFIX_TO_SIGNAL_NAME**|**Specify the metric name to be the ORIGINAL signal plus a SUFFIX**|
+|**SIGNAL_TYPES**|**Specify the signal type**|
+|**SIGNAL_FOLDER**|**Specify the origin folder**|
+|**SIGNAL_NAMES**|**Specify the Signal to be used**|
+|**COMPONENT_SEQUENCE**|**Specify the Signal components to be used (e.g. X + Y + Z or 0 + 1 + 2 etc)**|
+|**EVENT_SEQUENCE**|**A list of events (separated by "+" signs). For example, LHS+RTO**|
+|**EXCLUDE_EVENTS**|**If this event occurs before the first and last event, do not computed a metric**|
+|**GENERATE_MEAN_AND_STDDEV**|**Generate the mean and standard deviation of this metric**|
+|**GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS**|**Generate the mean and standard deviation of this metric across ranges and files**|
+|**APPEND_TO_EXISTING_VALUES**|**Add these metric values to an existing metric**|
+====Dialog=====
+The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below
+ {{:Metric_Integrate_Dlg.jpg}}
+The dialog box allows you to assign values to the command parameters outlined above.
+==== Example: Calculating Joint Work Using Integration ====
+Determining the energy contributions of different joints during locomotion can be integral (no pun intended) to understanding the gait cycle and comparing one trial to another. Some subjects may rely more heavily on ankle propulsion, while others may see more energy production from their knees and hips as a result of factors like age or imbalances.
+Here we use **Automatic Gait Events** and **Metric Integrate** to compare the work done by a subject's right and left knees while running on a treadmill.
+First, define important gait events using **Automatic Gait Events**.
+<code>
+Automatic_Gait_Events
+! /FRAME_WINDOW=8
+! /USE_TPR=TRUE
+! /TPR_EVENT_INSTANCE=1
+;
+</code>
+Next we will compute the work done by the left and right knees by integrating knee power with respect to time.
+<code>
+Metric_Integrate
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=R_Knee_Work
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=LINK_MODEL_BASED
+! /SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=RKneePower
+/COMPONENT_SEQUENCE=X
+/EVENT_SEQUENCE=RHS+RTO
+/EXCLUDE_EVENTS=
+/SEQUENCE_PERCENT_START=
+/SEQUENCE_PERCENT_END=
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
+</code>
+<code>
+Metric_Integrate
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=L_Knee_Work
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=LINK_MODEL_BASED
+! /SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=LKneePower
+/COMPONENT_SEQUENCE=X
+/EVENT_SEQUENCE=LHS+LTO
+/EXCLUDE_EVENTS=
+/SEQUENCE_PERCENT_START=
+/SEQUENCE_PERCENT_END=
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
+</code>
+new metrics have now been computed, the work, mean work, and standards deviation of work done for the left and right knees. Comparing the work done in each stride and mean work done for the left and right sides will help to identify any asymmetry between sides.
+The results should look something like this:
+{{:visual3d:documentation:pipeline:metric_commands:l_knee_work.png?400|}}{{:visual3d:documentation:pipeline:metric_commands:r_knee_work.png?400|}}{{:visual3d:documentation:pipeline:metric_commands:r_knee_mean.png?400|}}
+====Complex Examples====
   * [[Visual3D:Documentation:Pipeline:Signal_Commands:Impulse|Impulse]]