Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_signal_values_in_sequence [2024/06/26 20:27] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_signal_values_in_sequence [2025/09/18 20:21] (current) – [Command Parameters] wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Signal_Values_in_Sequence ======
+====== Metric Signal Values in Sequence ======
-**Get the values of a signal at a number of frames within an event sequence.**\\
+====Overview====
-\\
+The metric command **Signal Values in Sequence** can be used to compute the value of a signal at several events within a sequence, like at foot on and foot off within a gait sequence. It can be found in the **Pipeline Workshop** under **Metric**.
-**Frames type:**\\
-- Point Frames\\
-- Data Frames\\
-- Interpolate\\
-\\
+====Pipeline Command====
+The syntax for the function is as follows:
 <code>
 Metric_Signal_Values_In_Sequence
-/RESULT_METRIC_NAME=
 ! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=
 /EXPRESSION=
 ! /PERCENT_LIST=
 ! /TIME_OFFSET_LIST=
 ! /FRAME_OFFSET_LIST=
+! /EVENT_LIST=
 ! /USE_FRAMES_TYPE=1
 ! /SEQUENCE_INSTANCE=0
@@ Line 23: / Line 21: @@
 ! /EXCLUDE_EVENTS=
 ! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /APPEND_TO_EXISTING_VALUES=FALSE
 ! /RETAIN_NO_DATA_VALUES=TRUE
 ;
 </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**|
+|**EXPRESSION**|****|
+|**PERCENT_LIST**|**A percentage offset relative to each event in the defined sequence**|
+|**TIME_OFFSET_LIST**|**A time offset relative to each event in the defined sequence**|
+|**FRAME_OFFSET_LIST**|**A frame offset relative to each event in the defined sequence**|
+|**EVENT_LIST**|****|
+|**USE_FRAMES_TYPE**|****|
+|**SEQUENCE_INSTANCE**|****|
+|**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**|
+|**RETAIN_NO_DATA_VALUES**|**(True or False) If the result is no_data, retain the value.**|
+====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.
+{{:visual3d:documentation:pipeline:metric_commands:metric_signal_values_dlg.png?400|}}
-----
+The dialog box allows you to assign values to the command parameters outlined above.
 ==== Example ====
@@ Line 42: / Line 60: @@
-|<code>\\ Metric_Signal_Values_In_Sequence\\   /RESULT_METRIC_NAME=LEFT_KNEE_ANGLE_25percent\\ ! /RESULT_METRIC_FOLDER=PROCESSED\\   /EXPRESSION=LINK_MODEL_BASED::ORIGINAL::LEFT_KNEE_ANGLE\\   /PERCENT_LIST=25\\ ! /TIME_OFFSET_LIST=\\   /USE_FRAMES_TYPE=2 \\ ! /SEQUENCE_INSTANCE=0 \\   /EVENT_SEQUENCE=LHS+LHS\\ ! /EXCLUDE_EVENTS=\\ ! /GENERATE_MEAN_AND_STDDEV=TRUE \\ ! /APPEND_TO_EXISTING_VALUES=FALSE \\ ! /RETAIN_NO_DATA_VALUES=TRUE\\ ; \\ </code>\\ \\ ****  |  {{MetricSignalValuesinSequence.jpg}}|
+|<code>\\ Metric_Signal_Values_In_Sequence\\   /RESULT_METRIC_NAME=LEFT_KNEE_ANGLE_25percent\\ ! /RESULT_METRIC_FOLDER=PROCESSED\\   /EXPRESSION=LINK_MODEL_BASED::ORIGINAL::LEFT_KNEE_ANGLE\\   /PERCENT_LIST=25\\ ! /TIME_OFFSET_LIST=\\   /USE_FRAMES_TYPE=2 \\ ! /SEQUENCE_INSTANCE=0 \\   /EVENT_SEQUENCE=LHS+LHS\\ ! /EXCLUDE_EVENTS=\\ ! /GENERATE_MEAN_AND_STDDEV=TRUE \\ ! /APPEND_TO_EXISTING_VALUES=FALSE \\ ! /RETAIN_NO_DATA_VALUES=TRUE\\ ; \\ </code>\\ \\ ****  |  {{:MetricSignalValuesinSequence.jpg}}|