Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_mean [2024/06/19 14:01] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_mean [2024/11/22 19:00] (current) – wikisysop
@@ Line 1: / Line 1: @@
+====== Metric Mean ======
 This command computes the Mean Value of a Signal and stores the value as a metric.
 ===== Command Syntax =====
+The syntax for the function is as follows:
+<code>
+Metric_Mean
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /COMPONENT_SEQUENCE=
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
+</code>
-The Command Syntax if as follows:
+===== Parameters=====
+The Parameters for the function is as follows:
 |**Metric_Mean**                                                                                              |                                                                                             |
@@ Line 22: / Line 43: @@
 |! /APPEND_TO_EXISTING_VALUES=FALSE                                                                           |Metrics can replace an existing signal or be appended to it.                                 |
-**;**
-===== Example: Include and Exclude Ranges =====
+==== Example: Include and Exclude Ranges ====
 In the following example, compute the Mean Value of the signal **RKNEE_ANGLE** from **RHS** to **RHS**. The dialog of the command is:
-{{Metric_Mean1.jpg}}
+{{:Metric_Mean1.jpg}}
 The associated pipeline command text is:
@@ Line 57: / Line 77: @@
     * **RKNEE_ANGLE_MEAN_STDDEV** - the standard deviation of the mean values for all ranges.
-An example of results is shown below: {{Metric_Mean2.jpg}}
+An example of results is shown below:
+{{:Metric_Mean2.jpg}}
-If, for example, we did not want to include the file 'C:\Demo Files\CaseMVC\mvc002.c3d' in this list. To accomplish this we can add an **Event_Label** called **BAD** to the file between **RHS** and **RHS**.
+If, for example, we did not want to include the first gait cycle in the file file 'OG_RA_run01.c3d' in this list we can add an **Event_Label** called **BAD** to the file between **RHS** and **RHS**.
-{{Metric_Mean3.jpg}}
+{{:Metric_Mean3.jpg}}
-In the image above, the two yellow lines indicate the **RHS** event. Add an Event Label named **BAD** manually by double clicking on the signal line.
+In the image above, the two blue lines indicate the **RHS** event. Add an Event Label named **BAD** manually by double clicking on the signal line.
 The metric_mean command can be modified as follows:
-{{Metric_Mean4.jpg}}
+{{:Metric_Mean4.jpg}}
 which indicates that a range of data containing the label **BAD** should not be included. The result of executing the pipeline command is now:
-{{Metric_Mean5.jpg}}
+{{:Metric_Mean5.jpg}}
 **NOTE:** When you run a metric command, and tell it to create a global mean, it uses all the individual ranges to compute the overall mean (ie. one trial has 4 ranges, second trial has 1 range, the global mean is generated from the 5 values).