====== Metric Root Mean Squared ======

====Overview====

The metric command **Root Mean Squared** can be used to compute a Root Mean Squared value of a signal as a metric. This can be helpful when determining the magnitude or intensity of a signal, like joint power. It can be found in the **Pipeline Workshop** under **Metric**. 

Given data Xi for i=1,2....n
Mean Squared Error= MSE = sum(Xi^2)/n
Root Mean Squared Error= RMS= Sqrt(MSE) ;
\\

=====Pipeline Command=====
The syntax for the function is as follows:

<code>
Metric_Root_Mean_Squared
! /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
;
</code>

=====Command Parameters=====

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

|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**|
|**RESULT_METRIC_NAME**|**The name of the result signal**|
|**APPLY_AS_SUFFIX_TO_SIGNAL_NAME**|**Suffix to be applied to signals**|
|**SIGNAL_TYPES**|**Type of signal being processed**|
|**SIGNAL_FOLDER**|**Original location of signals**|
|**SIGNAL_NAMES**|**Specify names of signals**|
|**COMPONENT_SEQUENCE**|**Which component of the signal will be used for statistical analysis of the sequence.**|
|**EVENT_SEQUENCE**|** A list of events (separated by "+" signs). For example, LHS+RTO**|
|**EXCLUDE_EVENTS**|**This Event Sequence must not be during the sequence requested. For example, LTO_RHS**|
|**GENERATE_MEAN_AND_STDDEV**|**(True or False)Generate the mean and standard deviation for all of the metrics created**|
|**GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS**|**(True or False)Generate the mean and standard deviation across all subjects in trial**|
|**APPEND_TO_EXISTING_VALUES**|**(True or False)Append this list of metrics to an existing metric of the same result name**|

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

{{:MetricRootMeanSquared.png}}

The dialog box allows you to assign values to the command parameters outlined above.

====Example====

For example, compute the root mean squared value of the Ankle Joint Power from **Start** to **End**

|**Metric_Root_Mean_Squared**                                                                           |                                                                         |
|**/Signal_Types=**                                                                                     |LINK_MODEL_BASED                                                         |
|**/Signal_Names=**                                                                                     |Right Ankle Power                                                        |
|**/Signal_Folder**                                                                                     |ORIGINAL                                                                 |
|**/Signal_Components=**                                                                                |X                                                                        |
|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|Event_Sequence]]=**  |Start+End                                                                |
|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|Exclude_Events]]=**  |                                                                         |
|**/[[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      |
|**/Metric_Name=**                                                                                      |Right Ankle Power RMS                                                    |
|**/Apply_As_Suffix_To_Signal_Name=**                                                                   |FALSE                                                                    |
|**/Generate_Mean_And_STDDEV=**                                                                         |FALSE                                                                    |
|**/Append_To_Existing_Values=**                                                                        |FALSE                                                                    |
|**/APPEND_TO_EXISTING_VALUES=**                                                                        |FALSE                                                                    |
|**;**                                                                                                  |                                                                         |