Table of Contents
Metric Sum
Overview
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.
Pipeline Command
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 ;
Command Parameters
The following table shows the command parameters seen above and their descriptions:
| Metric_Sum | |
| /Signal_Types= | The type of signal to be processed |
| /Signal_Names= | The name of the signal to be processed |
| /Signal_Folder | The folder of the signal to be processed |
| /Signal_Components= | The component of the signal to be processed |
| /Event_Sequence= | The Start and End labels |
| /Exclude_Events= | Exclude ranges containing this event |
| /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 |
| /Result_Metric_Name= | The name of the resulting signal |
| /Result_Metric_Folder= | The folder of the resulting signal. |
| /Apply_As_Suffix_To_Signal_Name= | Apply a suffix to the Signal_Name |
| /Generate_Mean_And_STDDEV= | Generate the mean and standard deviation both within each active file and across all active files |
| /Append_To_Existing_Values= | Append the results to an existing signal. |
| ; |
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.
Metric Sum Examples
- 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.
- 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.
- 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.