Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_compute_gait_signal_stats [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_compute_gait_signal_stats [2025/01/11 13:31] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{these discrete gain metrics are part of the common cohort of [[[https://www.sciencedirect.com/science/article/abs/pii/0167945796000061|gait parameters]]].
+====== Metric Compute Gait Signal Stats ======
-create user defined statistics for a set of signals. the following stats are computed for the signals selected for each side of the body selected.
+These discrete gain metrics are part of the common cohort of [[https://www.sciencedirect.com/science/article/abs/pii/0167945796000061 | Gait Parameters]].
-====== signal_stats ======
+Create user defined statistics for a set of signals. The following stats are computed for the signals selected for each side of the body selected.
-signal value at heel strike
+===== Signal_Stats =====
-hs avg - average value at heel strike
+Signal value at Heel Strike
-hs sd - standard deviation of the value of the signal at heel strike
-signal value at toe off
-to avg - average value at heel strike
+HS Avg - Average value at Heel Strike
-to sd - standard deviation of the value of the signal at heel strike
+HS SD - Standard Deviation of the value of the signal at Heel Strike
-values during stance phase
+Signal value at Toe Off
-avg stance =
+TO Avg - Average value at Heel Strike
-sd stance
+TO SD - Standard Deviation of the value of the signal at Heel Strike
-min stance
+Values during Stance Phase
-min stance sd
-time at min stance (avg)
-time at min stance (sd)
-max stance
-max stance sd
-time at max stance (avg)
-time at max stance (sd)
-values during swing phase
-avg swing
+Avg Stance =
-sd swing
+SD Stance
-min swing
+Min Stance
-min swingsd
+Min Stance SD
-time at min swing(avg)
+Time at Min Stance (Avg)
-time at min swing(sd)
+Time at Min Stance (SD)
-max swing
+Max Stance
-max swingsd
+Max Stance SD
-time at max swing(avg)
+Time at Max Stance (Avg)
-time at max swing(sd)
+Time at Max Stance (SD)
-occurences of stance, swing, and cycle
+Values during Swing Phase
-stance (count) = number of stance phases used
+Avg Swing
-swing (count)= number of swing phases used
+SD Swing
-cycle (count)= number of cycles used.
+Min Swing
-====== command_dialog ======
+Min SwingSD
+Time at Min Swing(Avg)
+Time at Min Swing(SD)
+Max Swing
+Max SwingSD
+Time at Max Swing(Avg)
+Time at Max Swing(SD)
+Occurences of stance, swing, and cycle
-gaitsignalstatsdlg.jpg
+Stance (Count) = number of stance phases used
+Swing (Count)= number of swing phases used
+Cycle (Count)= number of cycles used.
+===== Command_Dialog =====
-====== pipeline_command ======
+{{:GaitSignalStatsDlg.jpg}}
-the pipeline command is as follows:
+===== Pipeline_Command =====
-**metric_compute_gait_signal_stats**
+The pipeline command is as follows:
-/signal_types=
-! /signal_names=
+**Metric_Compute_Gait_Signal_Stats**
-! /signal_folder=original
+/SIGNAL_TYPES=
-! /signal_components=
+! /SIGNAL_NAMES=
-! /component_sequence=
+! /SIGNAL_FOLDER=ORIGINAL
-! /compute_left_side=
+! /SIGNAL_COMPONENTS=
-! /compute_right_side=
+! /COMPONENT_SEQUENCE=
-! /result_folder=signal_stats
+! /COMPUTE_LEFT_SIDE=
-! /rhs_event=rhs
+! /COMPUTE_RIGHT_SIDE=
-! /lhs_event=lhs
+! /RESULT_FOLDER=SIGNAL_STATS
-! /rto_event=rto
+! /RHS_EVENT=RHS
-! /lto_event=lto
+! /LHS_EVENT=LHS
-! /left_side_result_name_prefix=l_
+! /RTO_EVENT=RTO
-! /right_side_result_name_prefix=r_
+! /LTO_EVENT=LTO
-! /result_name_suffix=_stats
+! /LEFT_SIDE_RESULT_NAME_PREFIX=L_
-! /append_component_to_result_name=false
+! /RIGHT_SIDE_RESULT_NAME_PREFIX=R_
-! /merge_components=false
+! /RESULT_NAME_SUFFIX=_Stats
+! /APPEND_COMPONENT_TO_RESULT_NAME=FALSE
+! /MERGE_COMPONENTS=FALSE
 **;**
-====== resulting_signals ======
+===== Resulting_Signals =====
-several of the command parameters affect the signal that is created.
+Several of the command parameters affect the signal that is created.
-===== example1 =====
+==== Example1 ====
-this group of commands results in a metric signal being created in the signal_stats folder that is the same name as /signal_names parameter and it contains values related to the x-component of the signal.
+This group of commands results in a metric signal being created in the SIGNAL_STATS folder that is the same name as /Signal_Names parameter and it contains values related to the X-Component of the signal.
-/result_folder=signal_stats
+/RESULT_FOLDER=SIGNAL_STATS
-/append_component_to_result_name=false
+/APPEND_COMPONENT_TO_RESULT_NAME=FALSE
-/result_name_suffix=
+/RESULT_NAME_SUFFIX=
-/component_sequence=x
+/COMPONENT_SEQUENCE=X
-/merge_components=false
+/MERGE_COMPONENTS=FALSE
 \\
-===== example2 =====
+==== Example2 ====
-this group of commands results in a metric signal being created in the signal_stats folder that appends the string _stats to the name in the /signal_names parameter and it contains values related to the x-component of the signal.
+This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string _Stats to the name in the /Signal_Names parameter and it contains values related to the X-Component of the signal.
-/result_folder=signal_stats
+/RESULT_FOLDER=SIGNAL_STATS
-/append_component_to_result_name=true
+/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
-/result_name_suffix=_stats
+/RESULT_NAME_SUFFIX=_Stats
-/component_sequence=x
+/COMPONENT_SEQUENCE=X
-/merge_components=false
+/MERGE_COMPONENTS=FALSE
 \\
-===== example3 =====
+==== Example3 ====
-this group of commands results in a metric signal being created in the signal_stats folder that appends the string "_stats_x" to the name in the /signal_names parameter and it contains values related to the x-component of the signal.
+This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string "_Stats_X" to the name in the /Signal_Names parameter and it contains values related to the X-Component of the signal.
-/result_folder=signal_stats
+/RESULT_FOLDER=SIGNAL_STATS
-/append_component_to_result_name=true
+/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
-/result_name_suffix=_stats
+/RESULT_NAME_SUFFIX=_Stats
-/component_sequence=x
+/COMPONENT_SEQUENCE=X
-/merge_components=false
+/MERGE_COMPONENTS=FALSE
 \\
-===== example4 =====
+==== Example4 ====
+This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string "_Stats_X" to the name in the /Signal_Names parameter containing values related to the X-Component of the signal; "_Stats_Y" to the name in the /Signal_Names parameter containing values related to the Y-Component of the signals.;"_Stats_Z" to the name in the /Signal_Names parameter containing values related to the Z-Component of the signals..
-this group of commands results in a metric signal being created in the signal_stats folder that appends the string "_stats_x" to the name in the /signal_names parameter containing values related to the x-component of the signal; "_stats_y" to the name in the /signal_names parameter containing values related to the y-component of the signals.;"_stats_z" to the name in the /signal_names parameter containing values related to the z-component of the signals..
+/RESULT_FOLDER=SIGNAL_STATS
+/APPEND_COMPONENT_TO_RESULT_NAME=TRUE
+/RESULT_NAME_SUFFIX=_Stats
+/COMPONENT_SEQUENCE=ALL
+/MERGE_COMPONENTS=FALSE
+==== Example5 ====
-/result_folder=signal_stats
+This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string "_Stats" to the name in the /Signal_Names parameter containing values related to the X-Component of the signal; The resulting signal contains 3 frames of data. The first row is related to the X-Component, the second row is related to the Y-Component and the third row is related to the Z-Component.
-/append_component_to_result_name=true
-/result_name_suffix=_stats
-/component_sequence=all
-/merge_components=false
-===== example5 =====
-this group of commands results in a metric signal being created in the signal_stats folder that appends the string "_stats" to the name in the /signal_names parameter containing values related to the x-component of the signal; the resulting signal contains 3 frames of data. the first row is related to the x-component, the second row is related to the y-component and the third row is related to the z-component.
+/RESULT_FOLDER=SIGNAL_STATS
+/APPEND_COMPONENT_TO_RESULT_NAME=FALSE
+/RESULT_NAME_SUFFIX=_Stats
+/COMPONENT_SEQUENCE=ALL
+/MERGE_COMPONENTS=TRUE
-/result_folder=signal_stats
-/append_component_to_result_name=false
-/result_name_suffix=_stats
-/component_sequence=all
-/merge_components=true
-}}