Metric Minimum

Overview

The Metric Minimum command computes the Minimum 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_Minimum
! /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
! /CREATE_GLOBAL_MINIMUM=FALSE
! /CREATE_TRIAL_MINIMUM=FALSE
;

Command Parameters

The Parameters for the function is as follows:

Metric_Minimum
/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	Name of results folder
/SIGNAL_TYPES=TARGET
/SIGNAL_NAMES=	Signal
/SIGNAL_FOLDER=ORIGINAL
/COMPONENT_SEQUENCE	Which component of the signal will be used for statistical analysis of the 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
/EXCLUDE_EVENTS=	If this event occurs between the first and last event, do not computed a metric
! /Generate_Mean_and_Stddev=TRUE	Generate the mean and standard deviation of this metric across ranges and files
/Generate_Mean_and_Stddev_Across_Subjects	Generate the mean and standard deviation of this metric across all subjects
! /APPEND_TO_EXISTING_VALUES=FALSE	Metrics can replace an existing signal or be appended to it.
! /CREATE_GLOBAL_MINIMUM=FALSE	Create minimum value across all trials
! /CREATE_TRIAL_MINIMUM=FALSE	Create minimum value for this trial

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 Minimum Value of the signal HANDSPEED

Metric_Minimum
/RESULT_METRIC_NAME=	_MEAN	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)
/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
/EXCLUDE_EVENTS=	SPEED_CHANGE	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
/GENERATE_MEAN_AND_STDDEV=	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
! /CREATE_GLOBAL_MINIMUM=	FALSE	Create a metric in the GLOBAL Workspace containing the minimum of the minimums
;

HAS-Motion Software Documentation

Table of Contents