Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_minimum [2025/09/18 18:55] – wikisysop
+++ visual3d:documentation:pipeline:metric_commands:metric_minimum [2025/10/02 18:18] (current) – [Example] wikisysop
@@ Line 57: / Line 57: @@
 The dialog box allows you to assign values to the command parameters outlined above.
-====Example====
+====Example 1: Minimum Handspeed====
+In the following example, compute the Minimum Value of the derived signal **HANDSPEED** between the events **FRAME1** and **GO**, with any range containing the Event **SPEED_CHANGE** being ignored.
-In the following example, compute the Minimum Value of the signal HANDSPEED
+<code>
+Metric_Minimum
+/RESULT_METRIC_NAME=_MEAN
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
+/RESULT_METRIC_FOLDER=PROCESSED
+/SIGNAL_TYPES=DERIVED
+/SIGNAL_NAMES=HANDSPEED
+/SIGNAL_FOLDER=PROCESSED
+/SIGNAL_COMPONENTS=ALL_COMPONENTS
+/EVENT_SEQUENCE=FRAME1 + GO
+/EXCLUDE_EVENTS=SPEED_CHANGE
+/GENERATE_MEAN_AND_STDDEV=TRUE
+/APPEND_TO_EXISTING_VALUES=FALSE
+! /CREATE_GLOBAL_MAXIMUM=FALSE
+;
+</code>
-|**Metric_Minimum**                                                                                     |                                                                         |                                                                                                                                                                                                                                                              |
-|**/RESULT_METRIC_NAME=**                                                                               |_MEAN                                                                    |The type of signal created                                                                                                                                                                                                                                    |
-|**/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=**                                                                   |True                                                                     |Specify the metric name to be the ORIGINAL signal plus a SUFFIX                                                                                                                                                                                               |
-|**/RESULT_METRIC_FOLDER=**                                                                             |PROCESSED                                                                |                                                                                                                                                                                                                                                              |
-|**/SIGNAL_TYPES=**                                                                                     |DERIVED                                                                  |                                                                                                                                                                                                                                                              |
-|**/SIGNAL_NAMES=**                                                                                     |HANDSPEED                                                                |Specify the Signal to be used                                                                                                                                                                                                                                 |
-|**/SIGNAL_FOLDER=**                                                                                    |PROCESSED                                                                |                                                                                                                                                                                                                                                              |
-|**/SIGNAL_COMPONENTS=**                                                                                |ALL_COMPONENTS                                                           |Specify the Signal components to be used (e.g. X, Y, Z or 0, 1, 2 etc)                                                                                                                                                                                        |
-|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=**  |FRAME1 + GO                                                              |Specify the sequence of Events. Any number of Events can be entered (separated by +). This specific sequence of events must be true for a metric to be computed. The metric is computed from the first event in the sequence to the last event in the sequence|
-|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**  |SPEED_CHANGE                                                             |If this event occurs before the first and last event, do not compute a metric                                                                                                                                                                                 |
-|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]=**|Within the event sequence specify the beginning of the range as a percent|                                                                                                                                                                                                                                                              |
-|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]=**  |Within the event sequence specify the end of the range as a percent      |                                                                                                                                                                                                                                                              |
-|**/GENERATE_MEAN_AND_STDDEV=**                                                                         |TRUE                                                                     |Generate the mean and standard deviation of this metric across ranges and files                                                                                                                                                                               |
-|**/APPEND_TO_EXISTING_VALUES==**                                                                       |FALSE                                                                    |Do not Add these metric values to an existing metric                                                                                                                                                                                                          |
-|**! /CREATE_GLOBAL_MINIMUM=**                                                                          |FALSE                                                                    |Create a metric in the GLOBAL Workspace containing the minimum of the minimums                                                                                                                                                                                |
-|**;**                                                                                                  |                                                                         |                                                                                                                                                                                                                                                              |
+====Example 2: Minimum GRF of Trail Foot in Baseball Swing====
+Here the **Metric Minimum** command is used to find minimum vertical ground reaction force value at the trail foot in a baseball swing.
+The command is as follows:
+<code>
+Metric_Minimum
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=Minimum_Trail_GRF
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=FORCE
+/SIGNAL_FOLDER=ORIGINAL
+ /SIGNAL_NAMES=FP4
+/COMPONENT_SEQUENCE=Z
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+! /CREATE_GLOBAL_MINIMUM=FALSE
+! /CREATE_TRIAL_MINIMUM=FALSE
+;
+</code>
+The resulting value for each swing can be found in the **METRIC:PROCESSED** folder and should look similar to below.
+{{:visual3d:documentation:pipeline:metric_commands:trail_grf1.png?600|}}