Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_mean [2024/07/03 17:41] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_mean [2024/11/22 19:00] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Mean ======
+====== Metric Mean ======
 This command computes the Mean Value of a Signal and stores the value as a metric.
-==== Command Syntax ====
+===== Command Syntax =====
+The syntax for the function is as follows:
-The Command Syntax if 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>
+===== Parameters=====
+The Parameters for the function is as follows:
 |**Metric_Mean**                                                                                              |                                                                                             |
@@ Line 24: / Line 43: @@
 |! /APPEND_TO_EXISTING_VALUES=FALSE                                                                           |Metrics can replace an existing signal or be appended to it.                                 |
-**;**
 ==== Example: Include and Exclude Ranges ====
@@ Line 30: / Line 48: @@
 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 59: / 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).
@@ Line 79: / Line 99: @@
 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)