HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric Mean
visual3d:documentation:pipeline:metric_commands:metric_mean

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:metric_commands:metric_mean [2024/11/22 18:48] – wikisysopvisual3d:documentation:pipeline:metric_commands:metric_mean [2025/09/18 19:09] (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.+====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**. 
 + 
 +=====Pipeline Command=====
 The syntax for the function is as follows: The syntax for the function is as follows:
  
Line 18: Line 20:
 /EXCLUDE_EVENTS= /EXCLUDE_EVENTS=
 ! /GENERATE_MEAN_AND_STDDEV=TRUE ! /GENERATE_MEAN_AND_STDDEV=TRUE
 +! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
 ! /APPEND_TO_EXISTING_VALUES=FALSE ! /APPEND_TO_EXISTING_VALUES=FALSE
 ; ;
- 
 </code> </code>
  
-===== Parameters===== +=====Command Parameters===== 
-The Parameters for the function is as follows:+The Parameters for the function are as follows:
  
 |**Metric_Mean**                                                                                              |                                                                                             | |**Metric_Mean**                                                                                              |                                                                                             |
 |/RESULT_METRIC_NAME=                                                                                         |The name of the metric signal created                                                        | |/RESULT_METRIC_NAME=                                                                                         |The name of the metric signal created                                                        |
 |!/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE                                                                       |Add a suffix to the signal name                                                              | |!/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_TYPES=TARGET                                                                                         |                                                                                             |
 |/SIGNAL_NAMES=                                                                                               |Signal                                                                                       | |/SIGNAL_NAMES=                                                                                               |Signal                                                                                       |
Line 43: Line 45:
 |! /APPEND_TO_EXISTING_VALUES=FALSE                                                                           |Metrics can replace an existing signal or be appended to it.                                 | |! /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 ==== ==== Example: Include and Exclude Ranges ====
Line 81: Line 90:
 {{:Metric_Mean2.jpg}} {{: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: The metric_mean command can be modified as follows:
visual3d/documentation/pipeline/metric_commands/metric_mean.1732301333.txt.gz · Last modified: 2024/11/22 18:48 by wikisysop