Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_maximum [2024/11/26 19:43] – wikisysop
+++ visual3d:documentation:pipeline:metric_commands:metric_maximum [2025/09/18 18:19] (current) – [Command Parameters] wikisysop
@@ Line 1: / Line 1: @@
 ====== Metric Maximum ======
-This command computes the Maximum Value of a Signal and stores the value as a metric. The command parameters are as follows:
+=====Overview====
+The **Metric Maximum** command computes the Maximum Value of a Signal and stores the value as a metric. This can be useful during event definition and when looking at movements like jumps where values like maximum height are relevant. The command can be found in the **Pipeline Workshop** under **Metric**.
-|**Metric_Maximum**                                                                                     |                                                                                                                                                                                                                                                              ||
+=====Pipeline Command=====
-|**/RESULT_METRIC_FOLDER=**                                                                             |Specify folder for the metric                                                                                                                                                                                                                                 ||
+The command syntax, found in the Pipeline Workshop is as so:
-|**/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                                                                                                                                                                                               ||
+<code>
-|**/SIGNAL_TYPES=**                                                                                     |Specify the signal type                                                                                                                                                                                                                                       ||
+Metric_Maximum
-|**/SIGNAL_FOLDER=**                                                                                    |Specify the signal folder                                                                                                                                                                                                                                     ||
+! /RESULT_METRIC_FOLDER=PROCESSED
-|**/SIGNAL_NAMES=**                                                                                     |Specify the Signal to be used                                                                                                                                                                                                                                 ||
+/RESULT_METRIC_NAME=
-|**/SIGNAL_COMPONENTS=**                                                                                |Specify the Signal components to be used (e.g. X, Y, Z or 0, 1, 2 etc)                                                                                                                                                                                        ||
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
-|**/[[Visual3D:Documentation:Pipeline:General_Information:COMPONENT_SEQUENCE|COMPONENT_SEQUENCE]]=**    |Specify the Signal components to be used (e.g. X + Y + Z or 0 + 1 + 2 etc)                                                                                                                                                                                    ||
+/SIGNAL_TYPES=
-|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=**  |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||
+! /SIGNAL_FOLDER=ORIGINAL
-|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**  |If this event occurs before the first and last event, do not computed a metric                                                                                                                                                                                ||
+! /SIGNAL_NAMES=
-|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]=**|Within the event sequence specify the beginning of the range as a percent                                                                                                                                                                                     ||
+! /COMPONENT_SEQUENCE=
-|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]=**  |Within the event sequence specify the end of the range as a percent                                                                                                                                                                                           ||
+/EVENT_SEQUENCE=
-|**/GENERATE_MEAN_AND_STDDEV=**                                                                         |Generate the mean and standard deviation of this metric across ranges and files                                                                                                                                                                               ||
+/EXCLUDE_EVENTS=
-|**/APPEND_TO_EXISTING_VALUES==**                                                                       |Do not Add these metric values to an existing metric                                                                                                                                                                                                          ||
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-|**! /CREATE_GLOBAL_MAXIMUM=**                                                                          |Create a metric in the GLOBAL Workspace containing the maximum of the maximums                                                                                                                                                                                ||
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
-|;                                                                                                      |
+! /APPEND_TO_EXISTING_VALUES=FALSE
-||
+! /CREATE_GLOBAL_MAXIMUM=FALSE
+! /CREATE_TRIAL_MAXIMUM=FALSE
+;
+</code>
+=====Command Parameters=====
+The Parameters for the function are as follows:
+|**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|
+|**SIGNAL_TYPES**                                                                                     |Specify the signal type|
+|**SIGNAL_FOLDER**                                                                                    |Specify the signal folder|
+|**SIGNAL_NAMES**                                                                                     |Specify the Signal to be used|
+|**SIGNAL_COMPONENTS**                                                                                |Specify the Signal components to be used (e.g. X, Y, Z or 0, 1, 2 etc)|
+|**[[Visual3D:Documentation:Pipeline:General_Information:COMPONENT_SEQUENCE|COMPONENT_SEQUENCE]]**    |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]]**  |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]]**  |If this event occurs before the first and last event, do not computed 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**|Generate the mean and standard deviation of this metric across ranges and files|
+|**APPEND_TO_EXISTING_VALUES**|Do not Add these metric values to an existing metric|
+|**CREATE_GLOBAL_MAXIMUM**|Create a metric in the GLOBAL Workspace containing the maximum of the maximums|
+====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_Maximum.jpg}}
+The dialog box allows you to assign values to the command parameters outlined above.
 ==== Examples ====