Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:metric_commands:metric_sum [2024/06/17 18:20] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_sum [2025/10/02 19:47] (current) – [Metric Sum Examples] wikisysop
@@ Line 1: / Line 1: @@
+====== 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 **Metric_Sum** command will sum the signal components over a range from a Start event to End event.
+The command syntax is as follows:
-The command details are:
+<code>
+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
+;
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
 |**Metric_Sum**                                                                                         |                                                                                                 |
@@ Line 23: / Line 46: @@
 |**;**                                                                                                  |                                                                                                 |
-\\
+====Dialog====
-The **Metric_Sum** command dialog is below:
-[[Metric_Sum.jpg]]
+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.
-===== Metric Sum Examples =====
+{{:Metric_Sum.jpg}}
-  - An example of the command **Metric_Sum** is found [[Visual3D:Documentation:Pipeline:Expressions:Overview#Example:_Value_of_signal_at_an_analog_frame|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 [[Visual3D:Documentation:Statistics:Compute_Linear_Regression#Linear_Regression_Explicit_Meta-Command|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 [[Visual3D:Documentation:Statistics:Meta_Command_for_Linear_Regression#Linear_Regression_with_Events_Meta-Command|Statistics Example 5#Linear Regression with Events Meta-Command]] where the meta-command uses the **Metric_Sum** command to calculate a linear regression.
+The dialog box allows you to assign values to the command parameters outlined above.
+==== Metric Sum Examples ====
+In the example below the **Metric Sum** command is used to find the total work done by the right ankle by summing positive and negative work done between events.
+<code>
+! Compute positive and negative work for each range of positive power.
+!**********************************************************************
+! Calculate right ankle positive work by time integration of right ankle power from
+! PowerPos event to PowerNeg event
+Metric_Integrate
+/Signal_Types=LINK_MODEL_BASED
+/Signal_Names=Right Ankle Power
+/Signal_Folder=ORIGINAL
+/Signal_Components=X
+/Event_Sequence=PowerPos+PowerNeg
+/Exclude_Events=
+/Metric_Name=Right Ankle Positive Work
+/Apply_As_Suffix_To_Signal_Name=FALSE
+/Generate_Mean_And_STDDEV=FALSE
+/Append_To_Existing_Values=FALSE
+;
+! Calculate right ankle negative work by time integration of right ankle power
+! from PowerNeg event to PowerPos event
+Metric_Integrate
+/Signal_Types=LINK_MODEL_BASED
+/Signal_Names=Right Ankle Power
+/Signal_Folder=ORIGINAL
+/Signal_Components=X
+/Event_Sequence=PowerNeg+PowerPos
+/Exclude_Events=
+/Metric_Name=Right Ankle Negative Work
+/Apply_As_Suffix_To_Signal_Name=FALSE
+/Generate_Mean_And_STDDEV=FALSE
+/Append_To_Existing_Values=FALSE
+;
+!************************************************************************
+! Compute the total positive and total negative work by summing the work.
+!************************************************************************
+!Compute total positive work for the right ankle
+Metric_Sum
+/Signal_Types=METRIC
+/Signal_Names=Right Ankle Positive Work
+/Signal_Folder=PROCESSED
+/Signal_Components=X
+/Event_Sequence=
+/Exclude_Events=
+/Metric_Name=Right Ankle Total Positive Work
+/Apply_As_Suffix_To_Signal_Name=FALSE
+/Generate_Mean_And_STDDEV=FALSE
+/Append_To_Existing_Values=FALSE
+;
+!Compute total negative work for the right ankle
+Metric_Sum
+/Signal_Types=METRIC
+/Signal_Names=Right Ankle Negative Work
+/Signal_Folder=PROCESSED
+/Signal_Components=X
+/Event_Sequence=
+/Exclude_Events=
+/Metric_Name=Right Ankle Total Negative Work
+/Apply_As_Suffix_To_Signal_Name=FALSE
+/Generate_Mean_And_STDDEV=FALSE
+/Append_To_Existing_Values=FALSE
+;
+</code>
+The result should look similar to this:
+{{:visual3d:documentation:pipeline:metric_commands:rankle_work.png?600|}}
+  - An example of the command **Metric_Sum** is found [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview#Example:_Value_of_signal_at_an_analog_frame|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 [[Visual3D:Documentation:Statistics:Compute_Linear_Regression#Linear_Regression_Explicit_Meta-Command|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 [[Visual3D:Documentation:Statistics:Meta_Command_for_Linear_Regression#Linear_Regression_with_Events_Meta-Command|Statistics Example 5#Linear Regression with Events Meta-Command]] where the meta-command uses the **Metric_Sum** command to calculate a linear regression.