Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_mean [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_mean [2024/11/22 19:00] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{{{{{this command computes the mean value of a signal and stores the value as a metric.
+====== Metric Mean ======
-===== command syntax =====
+This command computes the Mean Value of a Signal and stores the value as a metric.
-the command syntax if as follows:
+===== Command Syntax =====
+The syntax for the function is as follows:
-|**metric_mean**                                                                                              |                                                                                             |
+<code>
-|/result_metric_name=                                                                                         |the name of the metric signal created                                                        |
+Metric_Mean
-|!/apply_as_suffix_to_signal_name=false                                                                       |add a suffix to the signal name                                                              |
+! /RESULT_METRIC_FOLDER=PROCESSED
-|!/result_metric_folder=processed                                                                             |                                                                                             |
+/RESULT_METRIC_NAME=
-|/signal_types=target                                                                                         |                                                                                             |
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
-|/signal_names=                                                                                               |signal                                                                                       |
+/SIGNAL_TYPES=
-|/signal_folder=original                                                                                      |                                                                                             |
+! /SIGNAL_FOLDER=ORIGINAL
-|/signal_components=all_components                                                                            |signal components                                                                            |
+! /SIGNAL_NAMES=
-|/[[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event_sequence]]=            |specify the sequence of events. any number of events can be entered (separated by +).        |
+! /COMPONENT_SEQUENCE=
-|                                                                                                             |this specific sequence of events must be true for a metric to be computed.                   |
+/EVENT_SEQUENCE=
-|                                                                                                             |the metric is computed from the first event in the sequence to the last event in the sequence|
+/EXCLUDE_EVENTS=
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#exclude_events|exclude_events]]=**        |if this event occurs between the first and last event, do not computed a metric              |
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-|**/[[visual3d:documentation:pipeline:metric_commands:sequence_percent_start|sequence_percent_start]]=**      |within the event sequence specify the beginning of the range as a percent                    |
+! /APPEND_TO_EXISTING_VALUES=FALSE
-|**/[[visual3d:documentation:pipeline:metric_commands:sequence_percent_start|sequence_percent_end]]=**        |within the event sequence specify the end of the range as a percent                          |
+;
-|! /[[visual3d:documentation:pipeline:signal_commands:generate_mean_and_stddev|generate_mean_and_stddev]]=true|generate the mean and standard deviation of this metric across ranges and files              |
-|! /append_to_existing_values=false                                                                           |metrics can replace an existing signal or be appended to it.                                 |
-**;**
+</code>
-===== example: include and exclude ranges =====
+===== Parameters=====
+The Parameters for the function is as follows:
-in the following example, compute the mean value of the signal **rknee_angle** from **rhs** to **rhs**. the dialog of the command is:
+|**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                                                                             |                                                                                             |
+|/SIGNAL_TYPES=TARGET                                                                                         |                                                                                             |
+|/SIGNAL_NAMES=                                                                                               |Signal                                                                                       |
+|/SIGNAL_FOLDER=ORIGINAL                                                                                      |                                                                                             |
+|/SIGNAL_COMPONENTS=ALL_COMPONENTS                                                                            |Signal Components                                                                            |
+|/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=            |Specify the sequence of Events. Any number of Events can be entered (separated by +).        |
+|                                                                                                             |This specific sequence of events must be true for a metric to be computed.                   |
+|                                                                                                             |The metric is computed from the first event in the sequence to the last event in the sequence|
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**        |If this event occurs between the first and last event, do not computed a metric              |
+|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]=**      |Within the event sequence specify the beginning of the range as a percent                    |
+|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]=**        |Within the event sequence specify the end of the range as a percent                          |
+|! /[[Visual3D:Documentation:Pipeline:Signal_Commands:GENERATE_MEAN_AND_STDDEV|Generate_Mean_and_Stddev]]=TRUE|Generate the mean and standard deviation of this metric across ranges and files              |
+|! /APPEND_TO_EXISTING_VALUES=FALSE                                                                           |Metrics can replace an existing signal or be appended to it.                                 |
-metric_mean1.jpg
-the associated pipeline command text is:
+==== 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}}
+The associated pipeline command text is:
 <code>
-metric_mean
+Metric_Mean
-/result_metric_name=_mean
+/RESULT_METRIC_NAME=_MEAN
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=rknee_angle
+/SIGNAL_NAMES=RKNEE_ANGLE
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-/event_sequence=rhs+rhs
+/EVENT_SEQUENCE=RHS+RHS
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
 </code>
-executing the command will result in:
+Executing the command will result in:
-  * two metric signals in the **metric::processed folder** in each file,
+  * Two metric signals in the **METRIC::PROCESSED FOLDER** in each file,
-    * **rknee_angle_mean** - the mean value for each range in the file
+    * **RKNEE_ANGLE_MEAN** - the mean value for each RANGE in the file
-    * **rknee_angle_mean_mean** - the mean value for all ranges
+    * **RKNEE_ANGLE_MEAN_MEAN** - the mean value for all ranges
-  * two metric signals in the **global_workspace**
+  * Two metric signals in the **GLOBAL_WORKSPACE**
-    * **rknee_angle_mean_mean** - the mean value for all ranges for all files that were active
+    * **RKNEE_ANGLE_MEAN_MEAN** - the mean value for all ranges for all files that were active
-    * **rknee_angle_mean_stddev** - the standard deviation of the mean values for all ranges.
+    * **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:
-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**.
+{{:Metric_Mean2.jpg}}
-metric_mean3.jpg
+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**.
-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.
+{{:Metric_Mean3.jpg}}
-the metric_mean command can be modified as follows:
+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.
-metric_mean4.jpg
+The metric_mean command can be modified as follows:
-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_Mean4.jpg}}
-metric_mean5.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:
-**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).
+{{:Metric_Mean5.jpg}}
-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).
+**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).
-===== example: metric mean of metric signals at initial contact =====
+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).
-this script will take the mean of left at right knee angles at initial contact (lon and ron)
+===== 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)
 <code>
-! get the initial contact value of lknee_angle at lon
+! Get the initial contact value of LKNEE_ANGLE at LON
-metric_signal_value_at_event
+Metric_Signal_Value_At_Event
-/result_metric_name=knee_angle_ic
+/RESULT_METRIC_NAME=Knee_Angle_IC
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=lknee_angle
+/SIGNAL_NAMES=LKNEE_ANGLE
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-/event_name=lon
+/EVENT_NAME=LON
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
-! /generate_vector_length_metric=false
+! /GENERATE_VECTOR_LENGTH_METRIC=FALSE
-! /retain_no_data_values=false
+! /RETAIN_NO_DATA_VALUES=FALSE
 ;
-! get the initial contact value of rknee_angle at ron and concatenate this with the previous metric
+! Get the initial contact value of RKNEE_ANGLE at RON and concatenate this with the previous metric
-metric_signal_value_at_event
+Metric_Signal_Value_At_Event
-/result_metric_name=knee_angle_ic
+/RESULT_METRIC_NAME=Knee_Angle_IC
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=rknee_angle
+/SIGNAL_NAMES=RKNEE_ANGLE
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-/event_name=ron
+/EVENT_NAME=RON
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-/append_to_existing_values=true
+/APPEND_TO_EXISTING_VALUES=TRUE
-! /generate_vector_length_metric=false
+! /GENERATE_VECTOR_LENGTH_METRIC=FALSE
-! /retain_no_data_values=false
+! /RETAIN_NO_DATA_VALUES=FALSE
 ;
-! compute the mean and standard deviation of these values.
+! Compute the mean and standard deviation of these values.
-metric_mean
+Metric_Mean
-/result_metric_name=_mean
+/RESULT_METRIC_NAME=_MEAN
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=metric
+/SIGNAL_TYPES=METRIC
-/signal_names=knee_angle_ic
+/SIGNAL_NAMES=Knee_Angle_IC
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-/event_sequence=
+/EVENT_SEQUENCE=
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
 </code>
-}}}}}}}}}}