visual3d:documentation:pipeline:metric_commands:metric_root_mean_squared
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| visual3d:documentation:pipeline:metric_commands:metric_root_mean_squared [2024/06/19 12:51] – sgranger | visual3d:documentation:pipeline:metric_commands:metric_root_mean_squared [2025/09/18 19:17] (current) – wikisysop | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | {{|| | + | ====== Metric Root Mean Squared ====== |
| - | compute a root mean squared value of a signal as a metric. | + | ====Overview==== |
| - | given data xi for i=1, | + | 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**. |
| - | mean squared error= mse = sum(xi^2)/n | + | |
| - | root mean squared error= rms= sqrt(mse) ; | + | Given data Xi for i=1, |
| + | Mean Squared Error= MSE = sum(Xi^2)/n | ||
| + | Root Mean Squared Error= RMS= Sqrt(MSE) ; | ||
| \\ | \\ | ||
| - | for example, compute the root mean squared value of the knee joint power from **start** to **end** | ||
| - | metricrootmeansquared.png | + | =====Pipeline Command===== |
| + | The syntax for the function is as follows: | ||
| + | |||
| + | < | ||
| + | Metric_Root_Mean_Squared | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | / | ||
| + | / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ; | ||
| + | </ | ||
| + | |||
| + | =====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 " | ||
| + | |**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. | ||
| + | |||
| + | {{: | ||
| + | |||
| + | 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** | + | |**Metric_Root_Mean_Squared** |
| - | |**/signal_types=** |link_model_based | + | |**/Signal_Types=** |LINK_MODEL_BASED |
| - | |**/signal_names=** |right ankle power | | + | |**/Signal_Names=** |Right Ankle Power | |
| - | |**/signal_folder** |original | + | |**/Signal_Folder** |ORIGINAL |
| - | |**/signal_components=** |x | | + | |**/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#Event_Sequence|Event_Sequence]]=** |Start+End | |
| - | |**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#exclude_events|exclude_events]]=** | | | + | |**/[[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 | + | |**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]=**|Within |
| - | |**/[[visual3d:documentation:pipeline:metric_commands:sequence_percent_start|sequence_percent_end]]=** |within | + | |**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]=** |Within |
| - | |**/metric_name=** |right angle power rms | | + | |**/Metric_Name=** |Right Ankle Power RMS | |
| - | |**/apply_as_suffix_to_signal_name=** |false | | + | |**/Apply_As_Suffix_To_Signal_Name=** |FALSE | |
| - | |**/generate_mean_and_stddev=** |false | | + | |**/Generate_Mean_And_STDDEV=** |FALSE | |
| - | |**/append_to_existing_values=** |false | | + | |**/Append_To_Existing_Values=** |FALSE | |
| - | |**/append_to_existing_values=** |false | | + | |**/APPEND_TO_EXISTING_VALUES=** |FALSE | |
| |**; | |**; | ||
| - | }} | ||
visual3d/documentation/pipeline/metric_commands/metric_root_mean_squared.1718801486.txt.gz · Last modified: 2024/06/19 12:51 by sgranger