====== Metric Median ======

This command computes 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>

=====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}}

=====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).