The Metric_Sum command will sum the signal components over a range from a Start event to End event. It can be found in the Pipeline Workshop under Metric.

The command syntax is as follows:

Metric_Sum
! /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
;

The following table shows the command parameters seen above and their descriptions:

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.

1. An example of the command Metric_Sum is found here. This script uses metric_sum command to find a signal value at the analog frame rate. For details go to the page.
2. An example can be found on Statistics Example 4#Linear_Regression_Explicit Meta-Command where the meta-command uses the Metric_Sum command to calculate a linear regression.
3. Another example can be found on Statistics Example 5#Linear Regression with Events Meta-Command where the meta-command uses the Metric_Sum command to calculate a linear regression.