visual3d:documentation:pipeline:metric_commands:metric_compute_gait_signal_stats
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| visual3d:documentation:pipeline:metric_commands:metric_compute_gait_signal_stats [2024/07/12 14:04] – created sgranger | visual3d:documentation:pipeline:metric_commands:metric_compute_gait_signal_stats [2025/09/23 17:46] (current) – [Notes and Examples] wikisysop | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| - | These discrete gain metrics are part of the common cohort of [[[https:// | + | ====Overview==== |
| - | 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 |
| - | ===== Signal_Stats ===== | + | This command is used to create user defined statistics for a set of signals. It can be found in the Pipeline Workshop within the Metric folder. The following stats are computed for the signals selected for each side of the body selected. |
| Signal value at Heel Strike | Signal value at Heel Strike | ||
| Line 44: | Line 44: | ||
| Swing (Count)= number of swing phases used | Swing (Count)= number of swing phases used | ||
| Cycle (Count)= number of cycles used. | Cycle (Count)= number of cycles used. | ||
| - | ===== Command_Dialog ===== | ||
| - | {{GaitSignalStatsDlg.jpg}} | + | ====Pipeline Command==== |
| - | + | ||
| - | ===== Pipeline_Command ===== | + | |
| The pipeline command is as follows: | The pipeline command is as follows: | ||
| - | **Metric_Compute_Gait_Signal_Stats** | + | < |
| + | Metric_Compute_Gait_Signal_Stats | ||
| / | / | ||
| + | ! / | ||
| ! / | ! / | ||
| - | ! / | ||
| ! / | ! / | ||
| ! / | ! / | ||
| - | ! / | + | / |
| - | ! / | + | / |
| ! / | ! / | ||
| ! / | ! / | ||
| Line 70: | Line 68: | ||
| ! / | ! / | ||
| ! / | ! / | ||
| - | **;** | + | ; |
| - | ===== Resulting_Signals | + | </ |
| + | |||
| + | ====Command Parameters==== | ||
| + | |||
| + | The following table shows the command parameters and descriptions: | ||
| + | |||
| + | |**SIGNAL_TYPES** |**Specify signal types**| | ||
| + | |**SIGNAL_FOLDER**|**Specify signal folder**| | ||
| + | |**SIGNAL_NAMES**|**Specify signal names**| | ||
| + | |**SIGNAL_COMPONENTS**|**Each component of the signal will generate a metric signal containing the coefficients for that component of the signal.**| | ||
| + | |**COMPONENT_SEQUENCE**|**Which component of the signal will be used for statistical analysis of the sequence.**| | ||
| + | |**COMPUTE_LEFT/ | ||
| + | |**RESULT_FOLDER**|**Assigning folder to hold results.**| | ||
| + | |**---_EVENT**|**Assigning names to events.**| | ||
| + | |**LEFT/ | ||
| + | |**RESULT_NAME_SUFFIX**|**Specify suffix applied to results**| | ||
| + | |**APPEND_COMPONENT_TO_RESULT_NAME**|**whether or not to change component name**| | ||
| + | |**MERGE_COMPONENTS**|**Whether or not to merge components**| | ||
| + | |||
| + | ==== 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. | ||
| + | |||
| + | {{: | ||
| + | |||
| + | The dialog box allows you to assign values to the command parameters outlined above. | ||
| + | |||
| + | ====Notes and Examples==== | ||
| + | |||
| + | === 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 ==== | + | ===Example 1=== |
| This group of commands results in a metric signal being created in the SIGNAL_STATS folder that is the same name as / | This group of commands results in a metric signal being created in the SIGNAL_STATS folder that is the same name as / | ||
| - | /RESULT_FOLDER=SIGNAL_STATS | + | < |
| - | /APPEND_COMPONENT_TO_RESULT_NAME=FALSE | + | Metric_Compute_Gait_Signal_Stats |
| - | /RESULT_NAME_SUFFIX= | + | / |
| + | /SIGNAL_FOLDER=ORIGINAL | ||
| + | ! /SIGNAL_NAMES= | ||
| + | ! /SIGNAL_COMPONENTS= | ||
| / | / | ||
| - | / | + | / |
| - | \\ | + | / |
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ; | ||
| + | </ | ||
| - | ==== Example2 ==== | + | ===Example 2=== |
| 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 / | 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 / | ||
| + | < | ||
| + | Metric_Compute_Gait_Signal_Stats | ||
| + | / | ||
| + | / | ||
| + | ! / | ||
| + | ! / | ||
| + | / | ||
| + | / | ||
| + | / | ||
| / | / | ||
| - | /APPEND_COMPONENT_TO_RESULT_NAME=TRUE | + | ! /RHS_EVENT=RHS |
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| / | / | ||
| - | /COMPONENT_SEQUENCE=X | + | /APPEND_COMPONENT_TO_RESULT_NAME=TRUE |
| / | / | ||
| - | \\ | + | ; |
| + | </ | ||
| + | ===Example 3=== | ||
| - | ==== Example3 ==== | + | Computing stats from force plate data for left ankle angle using **Automatic Gait Events**: This group of commands results in a metric signal being created in the SIGNAL_STATS folder for all components of the left ankle angle during a trial. The command appends the string " |
| - | This group of commands results | + | Gait events describe key moments |
| - | / | + | Start by loading any trial with force plate data for a gait cycle. First, we will use **Automatic Gait Events** to label the key events in the cycle. |
| - | / | + | |
| - | / | + | |
| - | / | + | |
| - | / | + | |
| - | \\ | + | |
| + | < | ||
| + | Automatic_Gait_Events | ||
| + | ! / | ||
| + | ! / | ||
| + | ! / | ||
| + | ; | ||
| + | </ | ||
| - | ==== Example4 ==== | + | Next we will use **Metric Compute Gait Signal Stats** to calculate key statistics for the **left ankle angle** using the events we just defined. |
| - | This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string " | + | < |
| - | + | Metric_Compute_Gait_Signal_Stats | |
| - | /RESULT_FOLDER=SIGNAL_STATS | + | / |
| - | /APPEND_COMPONENT_TO_RESULT_NAME=TRUE | + | ! /SIGNAL_FOLDER=ORIGINAL |
| - | /RESULT_NAME_SUFFIX=_Stats | + | /SIGNAL_NAMES=LAnkleAngle |
| + | ! /SIGNAL_COMPONENTS= | ||
| / | / | ||
| - | /MERGE_COMPONENTS=FALSE | + | /COMPUTE_LEFT_SIDE=TRUE |
| - | ==== Example5 ==== | + | / |
| - | + | ! / | |
| - | This group of commands results in a metric signal being created in the SIGNAL_STATS folder that appends the string " | + | ! /RHS_EVENT=RHS |
| - | + | ! /LHS_EVENT=LHS | |
| - | /RESULT_FOLDER=SIGNAL_STATS | + | ! /RTO_EVENT=RTO |
| - | /APPEND_COMPONENT_TO_RESULT_NAME=FALSE | + | ! /LTO_EVENT=LTO |
| - | / | + | ! /LEFT_SIDE_RESULT_NAME_PREFIX=L_ |
| - | /COMPONENT_SEQUENCE=ALL | + | ! /RIGHT_SIDE_RESULT_NAME_PREFIX=R_ |
| - | / | + | ! / |
| + | /APPEND_COMPONENT_TO_RESULT_NAME=TRUE | ||
| + | ! / | ||
| + | ; | ||
| + | </ | ||
| + | The resulting folders and data should look something like this: | ||
| + | {{: | ||
visual3d/documentation/pipeline/metric_commands/metric_compute_gait_signal_stats.1720793079.txt.gz · Last modified: 2024/07/12 14:04 by sgranger