User Tools

Site Tools


visual3d:documentation:pipeline:metric_commands:metric_root_mean_squared

This is an old revision of the document!


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.

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

The command can be found in the Pipeline Workshop under Metric.

Pipeline Command

The syntax for the function is as follows:

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
;

Command Parameters

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

RESULT_METRIC_FOLDERThe name of the result signal folder
RESULT_METRIC_NAMEThe name of the result signal
APPLY_AS_SUFFIX_TO_SIGNAL_NAMESuffix to be applied to signals
SIGNAL_TYPESType of signal being processed
SIGNAL_FOLDEROriginal location of signals
SIGNAL_NAMESSpecify names of signals
COMPONENT_SEQUENCEWhich 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_EVENTSThis 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.

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

Example: Joint Power RMS

For example, compute the root mean squared value of the Ankle Joint Power from RHS to RTO

Metric_Root_Mean_Squared
 /RESULT_METRIC_FOLDER=PROCESSED
/RESULT_METRIC_NAME=RAnkle_RMS
! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
/SIGNAL_TYPES=LINK_MODEL_BASED
/SIGNAL_FOLDER=ORIGINAL
/SIGNAL_NAMES=RAnklePower
/COMPONENT_SEQUENCE=X
/EVENT_SEQUENCE=RHS+RTO
/EXCLUDE_EVENTS=
! /GENERATE_MEAN_AND_STDDEV=TRUE
! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
! /APPEND_TO_EXISTING_VALUES=FALSE
;

Results:

visual3d/documentation/pipeline/metric_commands/metric_root_mean_squared.1759517576.txt.gz · Last modified: 2025/10/03 18:52 by wikisysop