Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_signal_values_in_sequence [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_signal_values_in_sequence [2025/09/18 20:21] (current) – [Command Parameters] wikisysop
@@ Line 1: / Line 1: @@
-{{**get the values of a signal at a number of frames within an event sequence.**\\
+====== Metric Signal Values in Sequence ======
-\\
-**frames type:**\\
-- point frames\\
-- data frames\\
-- interpolate\\
-\\
+====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**.
+====Pipeline Command====
+The syntax for the function is as follows:
 <code>
-metric_signal_values_in_sequence
+Metric_Signal_Values_In_Sequence
-/result_metric_name=
+! /RESULT_METRIC_FOLDER=PROCESSED
-! /result_metric_folder=processed
+/RESULT_METRIC_NAME=
-/expression=
+/EXPRESSION=
-! /percent_list=
+! /PERCENT_LIST=
-! /time_offset_list=
+! /TIME_OFFSET_LIST=
-! /frame_offset_list=
+! /FRAME_OFFSET_LIST=
-! /use_frames_type=1
+! /EVENT_LIST=
-! /sequence_instance=0
+! /USE_FRAMES_TYPE=1
-! /event_sequence=
+! /SEQUENCE_INSTANCE=0
-! /exclude_events=
+! /EVENT_SEQUENCE=
-! /generate_mean_and_stddev=true
+! /EXCLUDE_EVENTS=
-! /append_to_existing_values=false
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /retain_no_data_values=true
+! /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====
-===== example =====
+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.
-**to get the metric value of the left knee angle at 25 percent of the gait cycle:**\\
+{{: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 ====
+**To get the metric value of the left knee angle at 25 percent of the gait cycle:**\\
 \\
-note: the metric_signal_values_in_sequence command may be edited through the text editor (left) or the gui (right).\\
+NOTE: The Metric_Signal_Values_In_Sequence command may be edited through the text editor (left) or the GUI (right).\\
 \\
-|<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}}|
-}}