Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_maximum [2024/07/16 16:59] – removed sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_maximum [2024/11/26 19:46] (current) – wikisysop
@@ Line 1: / Line 1: @@
+====== Metric Maximum ======
+This command computes the Maximum Value of a Signal and stores the value as a metric.
+===== Command Syntax =====
+The syntax for the function is as follows:
+<code>
+Metric_Maximum
+/RESULT_METRIC_NAME=
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
+!/RESULT_METRIC_FOLDER=PROCESSED
+/SIGNAL_TYPES=
+/SIGNAL_NAMES=
+/SIGNAL_FOLDER=
+/SIGNAL_COMPONENTS=
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+!/GENERATE_MEAN_AND_STDDEV=TRUE
+!/APPEND_TO_EXISTING_VALUES=FALSE
+! /CREATE_GLOBAL_MAXIMUM=FALSE
+;
+</code>
+===== Parameters=====
+The Parameters for the function is as follows:
+|**Metric_Maximum**                                                                                     |                                                                                                                                                                                                                                                              ||
+|**/RESULT_METRIC_FOLDER=**                                                                             |Specify folder for the metric                                                                                                                                                                                                                                 ||
+|**/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                                                                                                                                                                                ||
+{{:Metric_Maximum.jpg}}
+==== Examples ====
+In the following example, compute the Maximum Value of the derived signal **HANDSPEED** between the events **FRAME1** and **GO**, with any range containing the Event **SPEED_CHANGE** being ignored.
+<code>
+Metric_Maximum
+/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>