HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric Signal Values in Sequence
visual3d:documentation:pipeline:metric_commands:metric_signal_values_in_sequence

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:metric_commands:metric_signal_values_in_sequence [2024/06/19 14:01] – created sgrangervisual3d:documentation:pipeline:metric_commands:metric_signal_values_in_sequence [2025/09/24 18:22] (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:**\\ +====Overview==== 
-1 - Point Frames\\ +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**.
-2 - Data Frames\\ +
-3 - Interpolate\\ +
-\\+
  
 +====Pipeline Command====
 +The syntax for the function is as follows:
  
 <code> <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=
 +! /EVENT_LIST=
 ! /USE_FRAMES_TYPE=1 ! /USE_FRAMES_TYPE=1
 ! /SEQUENCE_INSTANCE=0 ! /SEQUENCE_INSTANCE=0
Line 21: Line 21:
 ! /EXCLUDE_EVENTS= ! /EXCLUDE_EVENTS=
 ! /GENERATE_MEAN_AND_STDDEV=TRUE ! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /APPEND_TO_EXISTING_VALUES=FALSE 
 ! /RETAIN_NO_DATA_VALUES=TRUE ! /RETAIN_NO_DATA_VALUES=TRUE
 ; ;
 </code> </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**|**Specify which instance of the sequence to compute 0 = All**|
 +|**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. 
 + 
 +{{: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:**\\ **To get the metric value of the left knee angle at 25 percent of the gait cycle:**\\
Line 38: Line 58:
 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}}|+====Example: Comparing Joint Angles in Stance==== 
 +The behaviour of lower body joints during stances (while the foot is on the ground) provides valuable insight into gait mechanics as it represents the portion of the stride in which external forces are acting on the limb. Here we will use a series of commands, including **Automatic Gait Events** and **Metric Signal Values in Sequence** to compute the ankle, knee and hip moments for the left and right sides in stance. 
  
 +Start by defining key gait events using Automatic Gait Events:
  
 +<code>
 +Automatic_Gait_Events
 +! /FRAME_WINDOW=8
 +! /USE_TPR=TRUE
 +! /TPR_EVENT_INSTANCE=1
 +;
 +</code>
  
 +Next we will find the value of the moment in the left and right knee, hip, and ankle joints like so:
 +
 +<code>
 +
 +</code>
visual3d/documentation/pipeline/metric_commands/metric_signal_values_in_sequence.1718805685.txt.gz · Last modified: 2024/06/19 14:01 by sgranger