Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_maximum [2024/06/19 14:01] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_maximum [2024/11/26 19:46] (current) – wikisysop
@@ Line 1: / Line 1: @@
-This command computes the Maximum Value of a Signal and stores the value as a metric. The command parameters are as follows:
+====== 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**                                                                                     |                                                                                                                                                                                                                                                              ||
@@ Line 18: / Line 41: @@
 |**! /CREATE_GLOBAL_MAXIMUM=**                                                                          |Create a metric in the GLOBAL Workspace containing the maximum of the maximums                                                                                                                                                                                ||
-{{Metric_Maximum.jpg}}
+{{:Metric_Maximum.jpg}}
-===== Examples =====
+==== 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.