visual3d:documentation:pipeline:metric_commands:metric_stddev
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_stddev [2024/06/19 12:51] – sgranger | visual3d:documentation:pipeline:metric_commands:metric_stddev [2025/09/18 20:15] (current) – wikisysop | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | {{|| | + | ====== Metric StdDev ====== |
- | compute the standard deviation of a signal and store the value as a metric | + | ====Overview==== |
- | in the following example, | + | This metric signal is used to compute the Standard Deviation |
- | metricstddevdlg.png | + | ====Pipeline Command==== |
+ | The command syntax is as follows: | ||
- | |**metric_stddev** | | + | < |
- | |**/result_metric_name=** |_sd |the name of the metric signal created | + | Metric_StdDev |
- | |**/apply_as_suffix_to_signal_name=** |true |specify | + | ! / |
- | |**/result_metric_folder=** |processed | + | / |
- | |**/signal_types=** |derived | + | ! / |
- | |**/signal_names=** |handspeed | + | / |
- | |**/signal_folder=** |processed | + | ! / |
- | |**/signal_components=** |all_components | + | ! / |
- | |**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event_sequence]]=** |frame1 | + | ! / |
- | |**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#exclude_events|exclude_events]]=** |max_speed | + | / |
- | |**/[[visual3d:documentation:pipeline:metric_commands:sequence_percent_start|sequence_percent_start]]=**|within | + | / |
- | |**/[[visual3d:documentation:pipeline:metric_commands:sequence_percent_start|sequence_percent_end]]=** |within | + | ! / |
- | |**/generate_mean_and_stddev=** |true |generate | + | ! / |
- | |**/append_to_existing_values==** |false |do not add these metric values to an existing metric | + | ! / |
+ | ; | ||
+ | </ | ||
+ | |||
+ | ====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**| | ||
+ | |**APPLY_AS_SUFFIX_TO_SIGNAL_NAME**|**Apply suffix to processed signals**| | ||
+ | |**SIGNAL_TYPES**|**Types of signals to be processed**| | ||
+ | |**SIGNAL_NAMES**|**Names of signals to be processed**| | ||
+ | |**COMPONENT_SEQUENCE**|**Which component of the signal will be used for statistical analysis of the sequence.**| | ||
+ | |**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_STDDEVE**|**(True or False)Generate the mean and standard deviation for all of the metrics created**| | ||
+ | |**GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS**|**(True or False)Generate the mean and standard deviation for all of the metrics created across all trials**| | ||
+ | |**APPEND_TO_EXISTING_VALUES**|**(True or False)Append this list of metrics to an existing metric of the same result name**| | ||
+ | |||
+ | ====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. | ||
+ | |||
+ | ==== Example ==== | ||
+ | |||
+ | |||
+ | In the following example, compute the Standard Deviation of the signal HANDSPEED | ||
+ | |||
+ | |||
+ | |**Metric_StdDev** | | ||
+ | |**/RESULT_METRIC_NAME=** |_SD |The name of the metric signal created | ||
+ | |**/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=** |True |Specify | ||
+ | |**/RESULT_METRIC_FOLDER=** |PROCESSED | ||
+ | |**/SIGNAL_TYPES=** |DERIVED | ||
+ | |**/SIGNAL_NAMES=** |HANDSPEED | ||
+ | |**/SIGNAL_FOLDER=** |PROCESSED | ||
+ | |**/SIGNAL_COMPONENTS=** |ALL_COMPONENTS | ||
+ | |**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=** |FRAME1 | ||
+ | |**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=** |MAX_SPEED | ||
+ | |**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]=**|Within | ||
+ | |**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]=** |Within | ||
+ | |**/GENERATE_MEAN_AND_STDDEV=** |TRUE |Generate | ||
+ | |**/APPEND_TO_EXISTING_VALUES==** |FALSE |Do not Add these metric values to an existing metric | ||
|**; | |**; | ||
- | }} | + |
visual3d/documentation/pipeline/metric_commands/metric_stddev.1718801488.txt.gz · Last modified: 2024/06/19 12:51 by sgranger