Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_maximum [2025/09/18 18:18] – [Command Parameters] wikisysop
+++ visual3d:documentation:pipeline:metric_commands:metric_maximum [2025/09/24 17:34] (current) – [Examples] wikisysop
@@ Line 30: / Line 30: @@
 The Parameters for the function are as follows:
-|**RESULT_METRIC_FOLDER**                                                                             |Specify folder for the metric|
+|**RESULT_METRIC_FOLDER**                                                                               |Name of the folder holding results|
 |**RESULT_METRIC_NAME**                                                                               |Name of the resulting metric|
 |**APPLY_AS_SUFFIX_TO_SIGNAL_NAME**                                                                   |Specify the metric name to be the ORIGINAL signal plus a SUFFIX|
@@ Line 76: / Line 76: @@
 </code>
+===Complex Example: Comparing and Graphing Signal Maximums===
+Using the **Metric Maximum** command we can compute the maximum value of a signal during a specific sequence of events for a motion trial. Here we will compute and compare the maximum GRF for the left and right sides of a subject's gait trial and use this data to evaluate the consistency of the subject's strides. This pipeline will compute the maximum ground reaction force during each stride for the left and right sides, as well as the mean GRF and std deviation for each side.
+First we will define the key events using **Automatic Gait Events**:
+<code>
+Automatic_Gait_Events
+! /FRAME_WINDOW=8
+! /USE_TPR=TRUE
+! /TPR_EVENT_INSTANCE=1
+;
+</code>
+Next we will use **Metric Maximum** to compute key GRF metrics:
+<code>
+Metric_Maximum
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=R_GRF_MAX
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=LINK_MODEL_BASED
+! /SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=RGRF
+/COMPONENT_SEQUENCE=ALL
+/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
+! /CREATE_GLOBAL_MAXIMUM=FALSE
+! /CREATE_TRIAL_MAXIMUM=FALSE
+;
+</code>
+<code>
+Metric_Maximum
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=L_GRF_MAX
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=LINK_MODEL_BASED
+! /SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=LGRF
+/COMPONENT_SEQUENCE=ALL
+/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
+! /CREATE_GLOBAL_MAXIMUM=FALSE
+! /CREATE_TRIAL_MAXIMUM=FALSE
+;
+</code>
+The computed GRF_max data can now be found within the **METRIC: PROCESSED** folder. Use this data to compare the mean max GRF for the left and right sides as well as the max GRF for each side.
+Left side:
+{{:visual3d:documentation:pipeline:metric_commands:l_grf.png?400|}}{{:visual3d:documentation:pipeline:metric_commands:l_grf_mean.png?400|}}
+Right side:
+{{:visual3d:documentation:pipeline:metric_commands:r_grf.png?400|}}{{:visual3d:documentation:pipeline:metric_commands:r_grf_mean.png?400|}}