Table of Contents
Metric Median
The Metric Median command computes the median 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:
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 ! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE ! /APPEND_TO_EXISTING_VALUES=FALSE
Command Parameters
The Parameters for the function are 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 |
/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 |
/EXCLUDE_EVENTS= | If this event occurs before the first and last event, do not compute a metric |
/SEQUENCE_PERCENT_START= | Within the event sequence specify the beginning of the range as a percent |
/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 |
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.
The dialog box allows you to assign values to the command parameters outlined above.
Example
In the following example, compute the Median Value of the signal HANDSPEED:
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 ;
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).