Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_mean [2024/07/17 15:23] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_mean [2025/09/18 19:09] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Metric Mean ======
-This command computes the Mean Value of a Signal and stores the value as a metric.
+====Overview====
-==== Command Syntax ====
+The **Metric Mean** command computes the Mean Value of a Signal and stores the value as a metric. It can be found within the **Pipeline Workshop** under **Metric**.
-The Command Syntax if as follows:
+=====Pipeline Command=====
+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
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
+</code>
+=====Command Parameters=====
+The Parameters for the function are as follows:
 |**Metric_Mean**                                                                                              |                                                                                             |
 |/RESULT_METRIC_NAME=                                                                                         |The name of the metric signal created                                                        |
 |!/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE                                                                       |Add a suffix to the signal name                                                              |
-|!/RESULT_METRIC_FOLDER=PROCESSED                                                                             |                                                                                             |
+|!/RESULT_METRIC_FOLDER=PROCESSED                                                                             |Name of results folder                                                                       |
 |/SIGNAL_TYPES=TARGET                                                                                         |                                                                                             |
 |/SIGNAL_NAMES=                                                                                               |Signal                                                                                       |
@@ Line 24: / Line 45: @@
 |! /APPEND_TO_EXISTING_VALUES=FALSE                                                                           |Metrics can replace an existing signal or be appended to it.                                 |
-**;**
+====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_Mean1.jpg}}
+The dialog box allows you to assign values to the command parameters outlined above.
 ==== Example: Include and Exclude Ranges ====
@@ Line 59: / Line 86: @@
     * **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}}
-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:
@@ Line 79: / Line 108: @@
 Each trial will have a mean and then a mean of those means. If you select ALL_FILES as the active file and view the metric, you will see the means of the individual trial ranges and the mean of the means within that trial. The GLOBAL will show the overall mean (mean of all the means).
-==== Example: Metric Mean of Metric signals at Initial Contact ====
+===== Example: Metric Mean of Metric signals at Initial Contact =====
 This script will take the mean of Left at Right Knee angles at Initial contact (LON and RON)