Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_minimum [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_minimum [2025/09/18 18:55] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{compute the minimum value of a signal and store the value as a metric
+====== Metric Minimum ======
-in the following example, compute the minimum value of the signal handspeed
+====Overview====
-|**metric_minimum**                                                                                     |                                                                         |                                                                                                                                                                                                                                                              |
+The **Metric Minimum** command computes the Minimum Value of a Signal and stores the value as a metric. It can be found within the **Pipeline Workshop** under **Metric**.
-|**/result_metric_name=**                                                                               |_mean                                                                    |the type of signal created                                                                                                                                                                                                                                    |
-|**/apply_as_suffix_to_signal_name=**                                                                   |true                                                                     |specify the metric name to be the original signal plus a suffix                                                                                                                                                                                               |
+=====Pipeline Command=====
-|**/result_metric_folder=**                                                                             |processed                                                                |                                                                                                                                                                                                                                                              |
-|**/signal_types=**                                                                                     |derived                                                                  |                                                                                                                                                                                                                                                              |
+The syntax for the function is as follows:
-|**/signal_names=**                                                                                     |handspeed                                                                |specify the signal to be used                                                                                                                                                                                                                                 |
-|**/signal_folder=**                                                                                    |processed                                                                |                                                                                                                                                                                                                                                              |
+<code>
-|**/signal_components=**                                                                                |all_components                                                           |specify the signal components to be used (e.g. x, y, z or 0, 1, 2 etc)                                                                                                                                                                                        |
+Metric_Minimum
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event_sequence]]=**  |frame1 + go                                                              |specify the sequence of events. any number of events can be entered (separated by +). this specific sequence of events must be true for a metric to be computed. the metric is computed from the first event in the sequence to the last event in the sequence|
+! /RESULT_METRIC_FOLDER=PROCESSED
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#exclude_events|exclude_events]]=**  |speed_change                                                             |if this event occurs before the first and last event, do not compute a metric                                                                                                                                                                                 |
+/RESULT_METRIC_NAME=
-|**/[[visual3d:documentation:pipeline:metric_commands:sequence_percent_start|sequence_percent_start]]=**|within the event sequence specify the beginning of the range as a percent|                                                                                                                                                                                                                                                              |
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
-|**/[[visual3d:documentation:pipeline:metric_commands:sequence_percent_start|sequence_percent_end]]=**  |within the event sequence specify the end of the range as a percent      |                                                                                                                                                                                                                                                              |
+/SIGNAL_TYPES=
-|**/generate_mean_and_stddev=**                                                                         |true                                                                     |generate the mean and standard deviation of this metric across ranges and files                                                                                                                                                                               |
+! /SIGNAL_FOLDER=ORIGINAL
-|**/append_to_existing_values==**                                                                       |false                                                                    |do not add these metric values to an existing metric                                                                                                                                                                                                          |
+! /SIGNAL_NAMES=
-|**! /create_global_minimum=**                                                                          |false                                                                    |create a metric in the global workspace containing the minimum of the minimums                                                                                                                                                                                |
+! /COMPONENT_SEQUENCE=
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+! /CREATE_GLOBAL_MINIMUM=FALSE
+! /CREATE_TRIAL_MINIMUM=FALSE
+;
+</code>
+====Command Parameters====
+The Parameters for the function is as follows:
+|**Metric_Minimum**                                                                                              |                                                                                             |
+|/RESULT_METRIC_NAME=                                                                                         |The name of the metric signal created                                                        |
+|!/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE                                                                       |Add a suffix to the signal name                                                              |
+|!/RESULT_METRIC_FOLDER=PROCESSED                                                                             |Name of results folder                                                                       |
+|/SIGNAL_TYPES=TARGET                                                                                         |                                                                                             |
+|/SIGNAL_NAMES=                                                                                               |Signal                                                                                       |
+|/SIGNAL_FOLDER=ORIGINAL                                                                                      |                                                                                             |
+|/COMPONENT_SEQUENCE                                                                         |Which component of the signal will be used for statistical analysis of the sequence.                          |
+|/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=            |Specify the sequence of Events. Any number of Events can be entered (separated by +).        |
+|                                                                                                             |This specific sequence of events must be true for a metric to be computed.                   |
+|                                                                                                             |The metric is computed from the first event in the sequence to the last event in the sequence|
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**        |If this event occurs between the first and last event, do not computed a metric              |
+|! /[[Visual3D:Documentation:Pipeline:Signal_Commands:GENERATE_MEAN_AND_STDDEV|Generate_Mean_and_Stddev]]=TRUE| Generate the mean and standard deviation of this metric across ranges and files             |
+|/Generate_Mean_and_Stddev_Across_Subjects                                                                    | Generate the mean and standard deviation of this metric across all subjects                 |
+|! /APPEND_TO_EXISTING_VALUES=FALSE                                                                           |Metrics can replace an existing signal or be appended to it.                                 |
+|! /CREATE_GLOBAL_MINIMUM=FALSE                                                                               |Create minimum value across all trials                                                       |
+|! /CREATE_TRIAL_MINIMUM=FALSE                                                                                |Create minimum value for this trial                                                          |
+====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.
+{{:MetricMinimumDlg5.jpg}}
+The dialog box allows you to assign values to the command parameters outlined above.
+====Example====
+In the following example, compute the Minimum Value of the signal HANDSPEED
+|**Metric_Minimum**                                                                                     |                                                                         |                                                                                                                                                                                                                                                              |
+|**/RESULT_METRIC_NAME=**                                                                               |_MEAN                                                                    |The type of signal created                                                                                                                                                                                                                                    |
+|**/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=**                                                                   |True                                                                     |Specify the metric name to be the ORIGINAL signal plus a SUFFIX                                                                                                                                                                                               |
+|**/RESULT_METRIC_FOLDER=**                                                                             |PROCESSED                                                                |                                                                                                                                                                                                                                                              |
+|**/SIGNAL_TYPES=**                                                                                     |DERIVED                                                                  |                                                                                                                                                                                                                                                              |
+|**/SIGNAL_NAMES=**                                                                                     |HANDSPEED                                                                |Specify the Signal to be used                                                                                                                                                                                                                                 |
+|**/SIGNAL_FOLDER=**                                                                                    |PROCESSED                                                                |                                                                                                                                                                                                                                                              |
+|**/SIGNAL_COMPONENTS=**                                                                                |ALL_COMPONENTS                                                           |Specify the Signal components to be used (e.g. X, Y, Z or 0, 1, 2 etc)                                                                                                                                                                                        |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=**  |FRAME1 + GO                                                              |Specify the sequence of Events. Any number of Events can be entered (separated by +). This specific sequence of events must be true for a metric to be computed. The metric is computed from the first event in the sequence to the last event in the sequence|
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**  |SPEED_CHANGE                                                             |If this event occurs before the first and last event, do not compute a metric                                                                                                                                                                                 |
+|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]=**|Within the event sequence specify the beginning of the range as a percent|                                                                                                                                                                                                                                                              |
+|**/[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]=**  |Within the event sequence specify the end of the range as a percent      |                                                                                                                                                                                                                                                              |
+|**/GENERATE_MEAN_AND_STDDEV=**                                                                         |TRUE                                                                     |Generate the mean and standard deviation of this metric across ranges and files                                                                                                                                                                               |
+|**/APPEND_TO_EXISTING_VALUES==**                                                                       |FALSE                                                                    |Do not Add these metric values to an existing metric                                                                                                                                                                                                          |
+|**! /CREATE_GLOBAL_MINIMUM=**                                                                          |FALSE                                                                    |Create a metric in the GLOBAL Workspace containing the minimum of the minimums                                                                                                                                                                                |
 |**;**                                                                                                  |                                                                         |                                                                                                                                                                                                                                                              |
-metricminimumdlg5.jpg
-}}