Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_median [2024/07/17 15:11] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_median [2024/11/26 19:58] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Median ======
+====== Metric Median ======
-||
+This command computes the Median Value of a Signal and store the value as a metric
-Compute the Median Value of a Signal and store the value as a metric
+=====Command Syntax=====
+The syntax for the function is as follows:
+<code>
+Metric_Median
+! /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>
-In the following example, compute the Median Value of the signal HANDSPEED
+=====Parameters=====
+The Parameters for the function is as follows:
+|**Metric_Median**                                                                                      |                                                                               |
+|**/RESULT_METRIC_NAME=**                                                                               |Specify result name                                                                   |
+|**/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=**                                                                   |Add a suffix to the signal name                                                                           |
+|**/RESULT_METRIC_FOLDER=**                                                                             |Specify a result folder                                                |
+|**/SIGNAL_TYPES=**                                                                                    | Specify signal type                                                                        |
+|**/SIGNAL_NAMES=**                                                                                     |Specify signal name                                                                      |
+|**/SIGNAL_FOLDER=**                                                                                    |Specify signal folder                                                                      |
+|**/SIGNAL_COMPONENTS=**                                                                                |Specify signal component                                                                 |
+|**/[[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 before the first and last event, do not compute 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            |
+|**/APPEND_TO_EXISTING_VALUES==**                                                                       |Append to existing values of the result signal                                                                         |
+|**/GENERATE_MEAN_AND_STDDEV=**                                                                         |Generate mean and stddev                                                                         |
 {{:MetricMedianDlg.png}}
-**/GENERATE_MEAN_AND_STDDEV=**
+=====Example=====
-|**Metric_Median**                                                                                      |                                                                               |                                                                                                                                                                                                                                                              |
+In the following example, compute the Median Value of the signal HANDSPEED:
-|**/RESULT_METRIC_NAME=**                                                                               |_MEDIAN                                                                        |The type of signal created                                                                                                                                                                                                                                    |
-|**/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=**                                                                   |True                                                                           |Specify the metric name to be the ORIGINAL signal plus a SUFFIX                                                                                                                                                                                               |
+<code>
-|**/RESULT_METRIC_FOLDER=**                                                                             |PROCESSED                                                                      |                                                                                                                                                                                                                                                              |
+Metric_Median
-|**/SIGNAL_TYPES=**                                                                                     |DERIVED                                                                        |                                                                                                                                                                                                                                                              |
+/RESULT_METRIC_NAME=_MEDIAN
-|**/SIGNAL_NAMES=**                                                                                     |HANDSPEED                                                                      |Specify the Signal to be used                                                                                                                                                                                                                                 |
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=True
-|**/SIGNAL_FOLDER=**                                                                                    |PROCESSED                                                                      |                                                                                                                                                                                                                                                              |
+/RESULT_METRIC_FOLDER=PROCESSED
-|**/SIGNAL_COMPONENTS=**                                                                                |ALL_COMPONENTS                                                                 |Specify the Signal components to be used (e.g. X, Y, Z or 0, 1, 2 etc)                                                                                                                                                                                        |
+/SIGNAL_TYPES=DERIVED
-|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=**  |FRAME1 + GO                                                                    |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|
+/SIGNAL_NAMES=HANDSPEED
-|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**  |MAX_SPEED                                                                      |If this event occurs before the first and last event, do not compute a metric                                                                                                                                                                                 |
+/SIGNAL_FOLDER=PROCESSED
-|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]=**|Within the event sequence specify the beginning of the range as a percent      |                                                                                                                                                                                                                                                              |
+/SIGNAL_COMPONENTS=ALL_COMPONENTS
-|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]=**  |Within the event sequence specify the end of the range as a percent            |                                                                                                                                                                                                                                                              |
+/EVENT_SEQUENCE= FRAME1 + GO
-|TRUE                                                                                                   |Generate the mean and standard deviation of this metric across ranges and files|                                                                                                                                                                                                                                                              |
+/EXCLUDE_EVENTS=MAX_SPEED
-|**/APPEND_TO_EXISTING_VALUES==**                                                                       |FALSE                                                                          |Do not Add these metric values to an existing metric                                                                                                                                                                                                          |
+/SEQUENCE_PERCENT_START=
-|**;**                                                                                                  |                                                                               |                                                                                                                                                                                                                                                              |
+/SEQUENCE_PERCENT_END]]=
+/GENERATE_MEAN_AND_STDDEV=TRUE
+/APPEND_TO_EXISTING_VALUES==FALSE
+;
+</code>
 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).