Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_median [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_median [2024/11/26 19:58] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{||
+====== Metric Median ======
-compute the median value of a signal and store the value as a metric
+This command computes the Median Value of a Signal and store the value as a metric
-in the following example, compute the median value of the signal handspeed
+=====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>
-metricmediandlg.png
+=====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                                                                         |
-**/generate_mean_and_stddev=**
+{{:MetricMedianDlg.png}}
-|**metric_median**                                                                                      |                                                                               |                                                                                                                                                                                                                                                              |
-|**/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                                                                                                                                                                                               |
-|**/result_metric_folder=**                                                                             |processed                                                                      |                                                                                                                                                                                                                                                              |
-|**/signal_types=**                                                                                     |derived                                                                        |                                                                                                                                                                                                                                                              |
-|**/signal_names=**                                                                                     |handspeed                                                                      |specify the signal to be used                                                                                                                                                                                                                                 |
-|**/signal_folder=**                                                                                    |processed                                                                      |                                                                                                                                                                                                                                                              |
-|**/signal_components=**                                                                                |all_components                                                                 |specify the signal components to be used (e.g. x, y, z or 0, 1, 2 etc)                                                                                                                                                                                        |
-|**/[[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|
-|**/[[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                                                                                                                                                                                 |
-|**/[[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            |                                                                                                                                                                                                                                                              |
-|true                                                                                                   |generate the mean and standard deviation of this metric across ranges and files|                                                                                                                                                                                                                                                              |
-|**/append_to_existing_values==**                                                                       |false                                                                          |do not add these metric values to an existing metric                                                                                                                                                                                                          |
-|**;**                                                                                                  |                                                                               |                                                                                                                                                                                                                                                              |
-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=====
+In the following example, compute the Median Value of the signal HANDSPEED:
+<code>
+Metric_Median
+/RESULT_METRIC_NAME=_MEDIAN
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=True
+/RESULT_METRIC_FOLDER=PROCESSED
+/SIGNAL_TYPES=DERIVED
+/SIGNAL_NAMES=HANDSPEED
+/SIGNAL_FOLDER=PROCESSED
+/SIGNAL_COMPONENTS=ALL_COMPONENTS
+/EVENT_SEQUENCE= FRAME1 + GO
+/EXCLUDE_EVENTS=MAX_SPEED
+/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).
+If you want each trial to have a median, and then create a median of those medians, you need to run a second command for metric median on the result of the first commands _median. (ie; One trial has 4 ranges, second trial has 1 range. The command will create a median in each trial containing an overall median for the trial, the global median would be the median of the medians).
-if you want each trial to have a median, and then create a median of those medians, you need to run a second command for metric median on the result of the first commands _median. (ie; one trial has 4 ranges, second trial has 1 range. the command will create a median in each trial containing an overall median for the trial, the global median would be the median of the medians).
-}}