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 [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{**get the values of a signal at a number of frames within an event sequence.**\\
+====== Metric Signal Values in Sequence ======
+**Get the values of a signal at a number of frames within an event sequence.**\\
 \\
-**frames type:**\\
+**Frames type:**\\
-- point frames\\
+- Point Frames\\
-- data frames\\
+- Data Frames\\
-- interpolate\\
+- Interpolate\\
 \\
 <code>
-metric_signal_values_in_sequence
+Metric_Signal_Values_In_Sequence
-/result_metric_name=
+/RESULT_METRIC_NAME=
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/expression=
+/EXPRESSION=
-! /percent_list=
+! /PERCENT_LIST=
-! /time_offset_list=
+! /TIME_OFFSET_LIST=
-! /frame_offset_list=
+! /FRAME_OFFSET_LIST=
-! /use_frames_type=1
+! /USE_FRAMES_TYPE=1
-! /sequence_instance=0
+! /SEQUENCE_INSTANCE=0
-! /event_sequence=
+! /EVENT_SEQUENCE=
-! /exclude_events=
+! /EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
-! /retain_no_data_values=true
+! /RETAIN_NO_DATA_VALUES=TRUE
 ;
 </code>
@@ Line 32: / Line 34: @@
 ----
-===== example =====
+==== Example ====
-**to get the metric value of the left knee angle at 25 percent of the gait cycle:**\\
+**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}}|
-}}